api_op_GetRegions.go raw
1 // Code generated by smithy-go-codegen DO NOT EDIT.
2
3 package lightsail
4
5 import (
6 "context"
7 "fmt"
8 awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
9 "github.com/aws/aws-sdk-go-v2/service/lightsail/types"
10 "github.com/aws/smithy-go/middleware"
11 smithyhttp "github.com/aws/smithy-go/transport/http"
12 )
13
14 // Returns a list of all valid regions for Amazon Lightsail. Use the include
15 // availability zones parameter to also return the Availability Zones in a region.
16 func (c *Client) GetRegions(ctx context.Context, params *GetRegionsInput, optFns ...func(*Options)) (*GetRegionsOutput, error) {
17 if params == nil {
18 params = &GetRegionsInput{}
19 }
20
21 result, metadata, err := c.invokeOperation(ctx, "GetRegions", params, optFns, c.addOperationGetRegionsMiddlewares)
22 if err != nil {
23 return nil, err
24 }
25
26 out := result.(*GetRegionsOutput)
27 out.ResultMetadata = metadata
28 return out, nil
29 }
30
31 type GetRegionsInput struct {
32
33 // A Boolean value indicating whether to also include Availability Zones in your
34 // get regions request. Availability Zones are indicated with a letter: us-east-2a .
35 IncludeAvailabilityZones *bool
36
37 // A Boolean value indicating whether to also include Availability Zones for
38 // databases in your get regions request. Availability Zones are indicated with a
39 // letter ( us-east-2a ).
40 IncludeRelationalDatabaseAvailabilityZones *bool
41
42 noSmithyDocumentSerde
43 }
44
45 type GetRegionsOutput struct {
46
47 // An array of key-value pairs containing information about your get regions
48 // request.
49 Regions []types.Region
50
51 // Metadata pertaining to the operation's result.
52 ResultMetadata middleware.Metadata
53
54 noSmithyDocumentSerde
55 }
56
57 func (c *Client) addOperationGetRegionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
58 if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
59 return err
60 }
61 err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetRegions{}, middleware.After)
62 if err != nil {
63 return err
64 }
65 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetRegions{}, middleware.After)
66 if err != nil {
67 return err
68 }
69 if err := addProtocolFinalizerMiddlewares(stack, options, "GetRegions"); err != nil {
70 return fmt.Errorf("add protocol finalizers: %v", err)
71 }
72
73 if err = addlegacyEndpointContextSetter(stack, options); err != nil {
74 return err
75 }
76 if err = addSetLoggerMiddleware(stack, options); err != nil {
77 return err
78 }
79 if err = addClientRequestID(stack); err != nil {
80 return err
81 }
82 if err = addComputeContentLength(stack); err != nil {
83 return err
84 }
85 if err = addResolveEndpointMiddleware(stack, options); err != nil {
86 return err
87 }
88 if err = addComputePayloadSHA256(stack); err != nil {
89 return err
90 }
91 if err = addRetry(stack, options); err != nil {
92 return err
93 }
94 if err = addRawResponseToMetadata(stack); err != nil {
95 return err
96 }
97 if err = addRecordResponseTiming(stack); err != nil {
98 return err
99 }
100 if err = addSpanRetryLoop(stack, options); err != nil {
101 return err
102 }
103 if err = addClientUserAgent(stack, options); 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 = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
113 return err
114 }
115 if err = addTimeOffsetBuild(stack, c); err != nil {
116 return err
117 }
118 if err = addUserAgentRetryMode(stack, options); err != nil {
119 return err
120 }
121 if err = addCredentialSource(stack, options); err != nil {
122 return err
123 }
124 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetRegions(options.Region), middleware.Before); err != nil {
125 return err
126 }
127 if err = addRecursionDetection(stack); err != nil {
128 return err
129 }
130 if err = addRequestIDRetrieverMiddleware(stack); err != nil {
131 return err
132 }
133 if err = addResponseErrorMiddleware(stack); err != nil {
134 return err
135 }
136 if err = addRequestResponseLogging(stack, options); err != nil {
137 return err
138 }
139 if err = addDisableHTTPSMiddleware(stack, options); err != nil {
140 return err
141 }
142 if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
143 return err
144 }
145 if err = addInterceptAttempt(stack, options); err != nil {
146 return err
147 }
148 if err = addInterceptors(stack, options); err != nil {
149 return err
150 }
151 return nil
152 }
153
154 func newServiceMetadataMiddleware_opGetRegions(region string) *awsmiddleware.RegisterServiceMetadata {
155 return &awsmiddleware.RegisterServiceMetadata{
156 Region: region,
157 ServiceID: ServiceID,
158 OperationName: "GetRegions",
159 }
160 }
161