1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package cloudsearch
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/aws-sdk-go-v2/service/cloudsearch/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Configures an IndexField for the search domain. Used to create new fields and
15// modify existing ones. You must specify the name of the domain you are
16// configuring and an index field configuration. The index field configuration
17// specifies a unique name, the index field type, and the options you want to
18// configure for the field. The options you can specify depend on the
19// IndexFieldType. If the field exists, the new configuration replaces the old one.
20// For more information, see Configuring Index Fields
21// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html)
22// in the Amazon CloudSearch Developer Guide.
23func (c *Client) DefineIndexField(ctx context.Context, params *DefineIndexFieldInput, optFns ...func(*Options)) (*DefineIndexFieldOutput, error) {
24	if params == nil {
25		params = &DefineIndexFieldInput{}
26	}
27
28	result, metadata, err := c.invokeOperation(ctx, "DefineIndexField", params, optFns, addOperationDefineIndexFieldMiddlewares)
29	if err != nil {
30		return nil, err
31	}
32
33	out := result.(*DefineIndexFieldOutput)
34	out.ResultMetadata = metadata
35	return out, nil
36}
37
38// Container for the parameters to the DefineIndexField operation. Specifies the
39// name of the domain you want to update and the index field configuration.
40type DefineIndexFieldInput struct {
41
42	// A string that represents the name of a domain. Domain names are unique across
43	// the domains owned by an account within an AWS region. Domain names start with a
44	// letter or number and can contain the following characters: a-z (lowercase), 0-9,
45	// and - (hyphen).
46	//
47	// This member is required.
48	DomainName *string
49
50	// The index field and field options you want to configure.
51	//
52	// This member is required.
53	IndexField *types.IndexField
54}
55
56// The result of a DefineIndexField request. Contains the status of the
57// newly-configured index field.
58type DefineIndexFieldOutput struct {
59
60	// The value of an IndexField and its current status.
61	//
62	// This member is required.
63	IndexField *types.IndexFieldStatus
64
65	// Metadata pertaining to the operation's result.
66	ResultMetadata middleware.Metadata
67}
68
69func addOperationDefineIndexFieldMiddlewares(stack *middleware.Stack, options Options) (err error) {
70	err = stack.Serialize.Add(&awsAwsquery_serializeOpDefineIndexField{}, middleware.After)
71	if err != nil {
72		return err
73	}
74	err = stack.Deserialize.Add(&awsAwsquery_deserializeOpDefineIndexField{}, middleware.After)
75	if err != nil {
76		return err
77	}
78	if err = addSetLoggerMiddleware(stack, options); err != nil {
79		return err
80	}
81	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
82		return err
83	}
84	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
85		return err
86	}
87	if err = addResolveEndpointMiddleware(stack, options); err != nil {
88		return err
89	}
90	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
91		return err
92	}
93	if err = addRetryMiddlewares(stack, options); err != nil {
94		return err
95	}
96	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
97		return err
98	}
99	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
100		return err
101	}
102	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
103		return err
104	}
105	if err = addClientUserAgent(stack); err != nil {
106		return err
107	}
108	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
109		return err
110	}
111	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
112		return err
113	}
114	if err = addOpDefineIndexFieldValidationMiddleware(stack); err != nil {
115		return err
116	}
117	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDefineIndexField(options.Region), middleware.Before); err != nil {
118		return err
119	}
120	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
121		return err
122	}
123	if err = addResponseErrorMiddleware(stack); err != nil {
124		return err
125	}
126	if err = addRequestResponseLogging(stack, options); err != nil {
127		return err
128	}
129	return nil
130}
131
132func newServiceMetadataMiddleware_opDefineIndexField(region string) *awsmiddleware.RegisterServiceMetadata {
133	return &awsmiddleware.RegisterServiceMetadata{
134		Region:        region,
135		ServiceID:     ServiceID,
136		SigningName:   "cloudsearch",
137		OperationName: "DefineIndexField",
138	}
139}
140