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// Gets the suggesters configured for a domain. A suggester enables you to display
15// possible matches before users finish typing their queries. Can be limited to
16// specific suggesters by name. By default, shows all suggesters and includes any
17// pending changes to the configuration. Set the Deployed option to true to show
18// the active configuration and exclude pending changes. For more information, see
19// Getting Search Suggestions
20// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html)
21// in the Amazon CloudSearch Developer Guide.
22func (c *Client) DescribeSuggesters(ctx context.Context, params *DescribeSuggestersInput, optFns ...func(*Options)) (*DescribeSuggestersOutput, error) {
23	if params == nil {
24		params = &DescribeSuggestersInput{}
25	}
26
27	result, metadata, err := c.invokeOperation(ctx, "DescribeSuggesters", params, optFns, addOperationDescribeSuggestersMiddlewares)
28	if err != nil {
29		return nil, err
30	}
31
32	out := result.(*DescribeSuggestersOutput)
33	out.ResultMetadata = metadata
34	return out, nil
35}
36
37// Container for the parameters to the DescribeSuggester operation. Specifies the
38// name of the domain you want to describe. To restrict the response to particular
39// suggesters, specify the names of the suggesters you want to describe. To show
40// the active configuration and exclude any pending changes, set the Deployed
41// option to true.
42type DescribeSuggestersInput struct {
43
44	// The name of the domain you want to describe.
45	//
46	// This member is required.
47	DomainName *string
48
49	// Whether to display the deployed configuration (true) or include any pending
50	// changes (false). Defaults to false.
51	Deployed *bool
52
53	// The suggesters you want to describe.
54	SuggesterNames []string
55}
56
57// The result of a DescribeSuggesters request.
58type DescribeSuggestersOutput struct {
59
60	// The suggesters configured for the domain specified in the request.
61	//
62	// This member is required.
63	Suggesters []types.SuggesterStatus
64
65	// Metadata pertaining to the operation's result.
66	ResultMetadata middleware.Metadata
67}
68
69func addOperationDescribeSuggestersMiddlewares(stack *middleware.Stack, options Options) (err error) {
70	err = stack.Serialize.Add(&awsAwsquery_serializeOpDescribeSuggesters{}, middleware.After)
71	if err != nil {
72		return err
73	}
74	err = stack.Deserialize.Add(&awsAwsquery_deserializeOpDescribeSuggesters{}, 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 = addOpDescribeSuggestersValidationMiddleware(stack); err != nil {
115		return err
116	}
117	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeSuggesters(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_opDescribeSuggesters(region string) *awsmiddleware.RegisterServiceMetadata {
133	return &awsmiddleware.RegisterServiceMetadata{
134		Region:        region,
135		ServiceID:     ServiceID,
136		SigningName:   "cloudsearch",
137		OperationName: "DescribeSuggesters",
138	}
139}
140