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 a suggester for a domain. A suggester enables you to display possible
15// matches before users finish typing their queries. When you configure a
16// suggester, you must specify the name of the text field you want to search for
17// possible matches and a unique name for the suggester. For more information, see
18// Getting Search Suggestions
19// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html)
20// in the Amazon CloudSearch Developer Guide.
21func (c *Client) DefineSuggester(ctx context.Context, params *DefineSuggesterInput, optFns ...func(*Options)) (*DefineSuggesterOutput, error) {
22	if params == nil {
23		params = &DefineSuggesterInput{}
24	}
25
26	result, metadata, err := c.invokeOperation(ctx, "DefineSuggester", params, optFns, addOperationDefineSuggesterMiddlewares)
27	if err != nil {
28		return nil, err
29	}
30
31	out := result.(*DefineSuggesterOutput)
32	out.ResultMetadata = metadata
33	return out, nil
34}
35
36// Container for the parameters to the DefineSuggester operation. Specifies the
37// name of the domain you want to update and the suggester configuration.
38type DefineSuggesterInput struct {
39
40	// A string that represents the name of a domain. Domain names are unique across
41	// the domains owned by an account within an AWS region. Domain names start with a
42	// letter or number and can contain the following characters: a-z (lowercase), 0-9,
43	// and - (hyphen).
44	//
45	// This member is required.
46	DomainName *string
47
48	// Configuration information for a search suggester. Each suggester has a unique
49	// name and specifies the text field you want to use for suggestions. The following
50	// options can be configured for a suggester: FuzzyMatching, SortExpression.
51	//
52	// This member is required.
53	Suggester *types.Suggester
54}
55
56// The result of a DefineSuggester request. Contains the status of the
57// newly-configured suggester.
58type DefineSuggesterOutput struct {
59
60	// The value of a Suggester and its current status.
61	//
62	// This member is required.
63	Suggester *types.SuggesterStatus
64
65	// Metadata pertaining to the operation's result.
66	ResultMetadata middleware.Metadata
67}
68
69func addOperationDefineSuggesterMiddlewares(stack *middleware.Stack, options Options) (err error) {
70	err = stack.Serialize.Add(&awsAwsquery_serializeOpDefineSuggester{}, middleware.After)
71	if err != nil {
72		return err
73	}
74	err = stack.Deserialize.Add(&awsAwsquery_deserializeOpDefineSuggester{}, 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 = addOpDefineSuggesterValidationMiddleware(stack); err != nil {
115		return err
116	}
117	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDefineSuggester(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_opDefineSuggester(region string) *awsmiddleware.RegisterServiceMetadata {
133	return &awsmiddleware.RegisterServiceMetadata{
134		Region:        region,
135		ServiceID:     ServiceID,
136		SigningName:   "cloudsearch",
137		OperationName: "DefineSuggester",
138	}
139}
140