1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package route53domains
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/route53domains/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// The GetDomainSuggestions operation returns a list of suggested domain names.
15func (c *Client) GetDomainSuggestions(ctx context.Context, params *GetDomainSuggestionsInput, optFns ...func(*Options)) (*GetDomainSuggestionsOutput, error) {
16	if params == nil {
17		params = &GetDomainSuggestionsInput{}
18	}
19
20	result, metadata, err := c.invokeOperation(ctx, "GetDomainSuggestions", params, optFns, addOperationGetDomainSuggestionsMiddlewares)
21	if err != nil {
22		return nil, err
23	}
24
25	out := result.(*GetDomainSuggestionsOutput)
26	out.ResultMetadata = metadata
27	return out, nil
28}
29
30type GetDomainSuggestionsInput struct {
31
32	// A domain name that you want to use as the basis for a list of possible domain
33	// names. The top-level domain (TLD), such as .com, must be a TLD that Route 53
34	// supports. For a list of supported TLDs, see Domains that You Can Register with
35	// Amazon Route 53
36	// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html)
37	// in the Amazon Route 53 Developer Guide. The domain name can contain only the
38	// following characters:
39	//
40	// * Letters a through z. Domain names are not case
41	// sensitive.
42	//
43	// * Numbers 0 through 9.
44	//
45	// * Hyphen (-). You can't specify a hyphen at
46	// the beginning or end of a label.
47	//
48	// * Period (.) to separate the labels in the
49	// name, such as the . in example.com.
50	//
51	// Internationalized domain names are not
52	// supported for some top-level domains. To determine whether the TLD that you want
53	// to use supports internationalized domain names, see Domains that You Can
54	// Register with Amazon Route 53
55	// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html).
56	//
57	// This member is required.
58	DomainName *string
59
60	// If OnlyAvailable is true, Route 53 returns only domain names that are available.
61	// If OnlyAvailable is false, Route 53 returns domain names without checking
62	// whether they're available to be registered. To determine whether the domain is
63	// available, you can call checkDomainAvailability for each suggestion.
64	//
65	// This member is required.
66	OnlyAvailable *bool
67
68	// The number of suggested domain names that you want Route 53 to return. Specify a
69	// value between 1 and 50.
70	//
71	// This member is required.
72	SuggestionCount int32
73}
74
75type GetDomainSuggestionsOutput struct {
76
77	// A list of possible domain names. If you specified true for OnlyAvailable in the
78	// request, the list contains only domains that are available for registration.
79	SuggestionsList []types.DomainSuggestion
80
81	// Metadata pertaining to the operation's result.
82	ResultMetadata middleware.Metadata
83}
84
85func addOperationGetDomainSuggestionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
86	err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetDomainSuggestions{}, middleware.After)
87	if err != nil {
88		return err
89	}
90	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetDomainSuggestions{}, middleware.After)
91	if err != nil {
92		return err
93	}
94	if err = addSetLoggerMiddleware(stack, options); err != nil {
95		return err
96	}
97	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
98		return err
99	}
100	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
101		return err
102	}
103	if err = addResolveEndpointMiddleware(stack, options); err != nil {
104		return err
105	}
106	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
107		return err
108	}
109	if err = addRetryMiddlewares(stack, options); err != nil {
110		return err
111	}
112	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
113		return err
114	}
115	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
116		return err
117	}
118	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
119		return err
120	}
121	if err = addClientUserAgent(stack); err != nil {
122		return err
123	}
124	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
125		return err
126	}
127	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
128		return err
129	}
130	if err = addOpGetDomainSuggestionsValidationMiddleware(stack); err != nil {
131		return err
132	}
133	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetDomainSuggestions(options.Region), middleware.Before); err != nil {
134		return err
135	}
136	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
137		return err
138	}
139	if err = addResponseErrorMiddleware(stack); err != nil {
140		return err
141	}
142	if err = addRequestResponseLogging(stack, options); err != nil {
143		return err
144	}
145	return nil
146}
147
148func newServiceMetadataMiddleware_opGetDomainSuggestions(region string) *awsmiddleware.RegisterServiceMetadata {
149	return &awsmiddleware.RegisterServiceMetadata{
150		Region:        region,
151		ServiceID:     ServiceID,
152		SigningName:   "route53domains",
153		OperationName: "GetDomainSuggestions",
154	}
155}
156