api_op_GetBuckets.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 information about one or more Amazon Lightsail buckets. The information
15 // returned includes the synchronization status of the Amazon Simple Storage
16 // Service (Amazon S3) account-level block public access feature for your Lightsail
17 // buckets.
18 //
19 // For more information about buckets, see [Buckets in Amazon Lightsail] in the Amazon Lightsail Developer
20 // Guide.
21 //
22 // [Buckets in Amazon Lightsail]: https://docs.aws.amazon.com/lightsail/latest/userguide/buckets-in-amazon-lightsail
23 func (c *Client) GetBuckets(ctx context.Context, params *GetBucketsInput, optFns ...func(*Options)) (*GetBucketsOutput, error) {
24 if params == nil {
25 params = &GetBucketsInput{}
26 }
27
28 result, metadata, err := c.invokeOperation(ctx, "GetBuckets", params, optFns, c.addOperationGetBucketsMiddlewares)
29 if err != nil {
30 return nil, err
31 }
32
33 out := result.(*GetBucketsOutput)
34 out.ResultMetadata = metadata
35 return out, nil
36 }
37
38 type GetBucketsInput struct {
39
40 // The name of the bucket for which to return information.
41 //
42 // When omitted, the response includes all of your buckets in the Amazon Web
43 // Services Region where the request is made.
44 BucketName *string
45
46 // A Boolean value that indicates whether to include Lightsail instances that were
47 // given access to the bucket using the [SetResourceAccessForBucket]action.
48 //
49 // [SetResourceAccessForBucket]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html
50 IncludeConnectedResources *bool
51
52 // A Boolean value that indicates whether to include Lightsail bucket CORS
53 // configuration in the response. For more information, see [Configuring cross-origin resource sharing (CORS)].
54 //
55 // This parameter is only supported when getting a single bucket with bucketName
56 // specified. The default value for this parameter is False .
57 //
58 // [Configuring cross-origin resource sharing (CORS)]: https://docs.aws.amazon.com/lightsail/latest/userguide/configure-cors.html
59 IncludeCors *bool
60
61 // The token to advance to the next page of results from your request.
62 //
63 // To get a page token, perform an initial GetBuckets request. If your results are
64 // paginated, the response will return a next page token that you can specify as
65 // the page token in a subsequent request.
66 PageToken *string
67
68 noSmithyDocumentSerde
69 }
70
71 type GetBucketsOutput struct {
72
73 // An object that describes the synchronization status of the Amazon S3
74 // account-level block public access feature for your Lightsail buckets.
75 //
76 // For more information about this feature and how it affects Lightsail buckets,
77 // see [Block public access for buckets in Amazon Lightsail].
78 //
79 // [Block public access for buckets in Amazon Lightsail]: https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-block-public-access-for-buckets
80 AccountLevelBpaSync *types.AccountLevelBpaSync
81
82 // An array of objects that describe buckets.
83 Buckets []types.Bucket
84
85 // The token to advance to the next page of results from your request.
86 //
87 // A next page token is not returned if there are no more results to display.
88 //
89 // To get the next page of results, perform another GetBuckets request and specify
90 // the next page token using the pageToken parameter.
91 NextPageToken *string
92
93 // Metadata pertaining to the operation's result.
94 ResultMetadata middleware.Metadata
95
96 noSmithyDocumentSerde
97 }
98
99 func (c *Client) addOperationGetBucketsMiddlewares(stack *middleware.Stack, options Options) (err error) {
100 if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
101 return err
102 }
103 err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetBuckets{}, middleware.After)
104 if err != nil {
105 return err
106 }
107 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetBuckets{}, middleware.After)
108 if err != nil {
109 return err
110 }
111 if err := addProtocolFinalizerMiddlewares(stack, options, "GetBuckets"); err != nil {
112 return fmt.Errorf("add protocol finalizers: %v", err)
113 }
114
115 if err = addlegacyEndpointContextSetter(stack, options); err != nil {
116 return err
117 }
118 if err = addSetLoggerMiddleware(stack, options); err != nil {
119 return err
120 }
121 if err = addClientRequestID(stack); err != nil {
122 return err
123 }
124 if err = addComputeContentLength(stack); err != nil {
125 return err
126 }
127 if err = addResolveEndpointMiddleware(stack, options); err != nil {
128 return err
129 }
130 if err = addComputePayloadSHA256(stack); err != nil {
131 return err
132 }
133 if err = addRetry(stack, options); err != nil {
134 return err
135 }
136 if err = addRawResponseToMetadata(stack); err != nil {
137 return err
138 }
139 if err = addRecordResponseTiming(stack); err != nil {
140 return err
141 }
142 if err = addSpanRetryLoop(stack, options); err != nil {
143 return err
144 }
145 if err = addClientUserAgent(stack, options); err != nil {
146 return err
147 }
148 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
149 return err
150 }
151 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
152 return err
153 }
154 if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
155 return err
156 }
157 if err = addTimeOffsetBuild(stack, c); err != nil {
158 return err
159 }
160 if err = addUserAgentRetryMode(stack, options); err != nil {
161 return err
162 }
163 if err = addCredentialSource(stack, options); err != nil {
164 return err
165 }
166 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetBuckets(options.Region), middleware.Before); err != nil {
167 return err
168 }
169 if err = addRecursionDetection(stack); err != nil {
170 return err
171 }
172 if err = addRequestIDRetrieverMiddleware(stack); err != nil {
173 return err
174 }
175 if err = addResponseErrorMiddleware(stack); err != nil {
176 return err
177 }
178 if err = addRequestResponseLogging(stack, options); err != nil {
179 return err
180 }
181 if err = addDisableHTTPSMiddleware(stack, options); err != nil {
182 return err
183 }
184 if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
185 return err
186 }
187 if err = addInterceptAttempt(stack, options); err != nil {
188 return err
189 }
190 if err = addInterceptors(stack, options); err != nil {
191 return err
192 }
193 return nil
194 }
195
196 func newServiceMetadataMiddleware_opGetBuckets(region string) *awsmiddleware.RegisterServiceMetadata {
197 return &awsmiddleware.RegisterServiceMetadata{
198 Region: region,
199 ServiceID: ServiceID,
200 OperationName: "GetBuckets",
201 }
202 }
203