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 Expression for the search domain. Used to create new expressions
15// and modify existing ones. If the expression exists, the new configuration
16// replaces the old one. For more information, see Configuring Expressions
17// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html)
18// in the Amazon CloudSearch Developer Guide.
19func (c *Client) DefineExpression(ctx context.Context, params *DefineExpressionInput, optFns ...func(*Options)) (*DefineExpressionOutput, error) {
20	if params == nil {
21		params = &DefineExpressionInput{}
22	}
23
24	result, metadata, err := c.invokeOperation(ctx, "DefineExpression", params, optFns, addOperationDefineExpressionMiddlewares)
25	if err != nil {
26		return nil, err
27	}
28
29	out := result.(*DefineExpressionOutput)
30	out.ResultMetadata = metadata
31	return out, nil
32}
33
34// Container for the parameters to the DefineExpression operation. Specifies the
35// name of the domain you want to update and the expression you want to configure.
36type DefineExpressionInput struct {
37
38	// A string that represents the name of a domain. Domain names are unique across
39	// the domains owned by an account within an AWS region. Domain names start with a
40	// letter or number and can contain the following characters: a-z (lowercase), 0-9,
41	// and - (hyphen).
42	//
43	// This member is required.
44	DomainName *string
45
46	// A named expression that can be evaluated at search time. Can be used to sort the
47	// search results, define other expressions, or return computed information in the
48	// search results.
49	//
50	// This member is required.
51	Expression *types.Expression
52}
53
54// The result of a DefineExpression request. Contains the status of the
55// newly-configured expression.
56type DefineExpressionOutput struct {
57
58	// The value of an Expression and its current status.
59	//
60	// This member is required.
61	Expression *types.ExpressionStatus
62
63	// Metadata pertaining to the operation's result.
64	ResultMetadata middleware.Metadata
65}
66
67func addOperationDefineExpressionMiddlewares(stack *middleware.Stack, options Options) (err error) {
68	err = stack.Serialize.Add(&awsAwsquery_serializeOpDefineExpression{}, middleware.After)
69	if err != nil {
70		return err
71	}
72	err = stack.Deserialize.Add(&awsAwsquery_deserializeOpDefineExpression{}, middleware.After)
73	if err != nil {
74		return err
75	}
76	if err = addSetLoggerMiddleware(stack, options); err != nil {
77		return err
78	}
79	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
80		return err
81	}
82	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
83		return err
84	}
85	if err = addResolveEndpointMiddleware(stack, options); err != nil {
86		return err
87	}
88	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
89		return err
90	}
91	if err = addRetryMiddlewares(stack, options); err != nil {
92		return err
93	}
94	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
95		return err
96	}
97	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
98		return err
99	}
100	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
101		return err
102	}
103	if err = addClientUserAgent(stack); err != nil {
104		return err
105	}
106	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
107		return err
108	}
109	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
110		return err
111	}
112	if err = addOpDefineExpressionValidationMiddleware(stack); err != nil {
113		return err
114	}
115	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDefineExpression(options.Region), middleware.Before); err != nil {
116		return err
117	}
118	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
119		return err
120	}
121	if err = addResponseErrorMiddleware(stack); err != nil {
122		return err
123	}
124	if err = addRequestResponseLogging(stack, options); err != nil {
125		return err
126	}
127	return nil
128}
129
130func newServiceMetadataMiddleware_opDefineExpression(region string) *awsmiddleware.RegisterServiceMetadata {
131	return &awsmiddleware.RegisterServiceMetadata{
132		Region:        region,
133		ServiceID:     ServiceID,
134		SigningName:   "cloudsearch",
135		OperationName: "DefineExpression",
136	}
137}
138