1// Code generated by smithy-go-codegen DO NOT EDIT. 2 3package s3control 4 5import ( 6 "context" 7 "fmt" 8 awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware" 9 "github.com/aws/aws-sdk-go-v2/aws/signer/v4" 10 s3controlcust "github.com/aws/aws-sdk-go-v2/service/s3control/internal/customizations" 11 "github.com/aws/aws-sdk-go-v2/service/s3control/types" 12 smithy "github.com/aws/smithy-go" 13 "github.com/aws/smithy-go/middleware" 14 smithyhttp "github.com/aws/smithy-go/transport/http" 15 "strings" 16) 17 18// Returns a list of all Outposts buckets in an Outpost that are owned by the 19// authenticated sender of the request. For more information, see Using Amazon S3 20// on Outposts 21// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the 22// Amazon Simple Storage Service User Guide. For an example of the request syntax 23// for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix 24// and x-amz-outpost-id in your request, see the Examples 25// (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListRegionalBuckets.html#API_control_ListRegionalBuckets_Examples) 26// section. 27func (c *Client) ListRegionalBuckets(ctx context.Context, params *ListRegionalBucketsInput, optFns ...func(*Options)) (*ListRegionalBucketsOutput, error) { 28 if params == nil { 29 params = &ListRegionalBucketsInput{} 30 } 31 32 result, metadata, err := c.invokeOperation(ctx, "ListRegionalBuckets", params, optFns, addOperationListRegionalBucketsMiddlewares) 33 if err != nil { 34 return nil, err 35 } 36 37 out := result.(*ListRegionalBucketsOutput) 38 out.ResultMetadata = metadata 39 return out, nil 40} 41 42type ListRegionalBucketsInput struct { 43 44 // The AWS account ID of the Outposts bucket. 45 // 46 // This member is required. 47 AccountId *string 48 49 // 50 MaxResults int32 51 52 // 53 NextToken *string 54 55 // The ID of the AWS Outposts. This is required by Amazon S3 on Outposts buckets. 56 OutpostId *string 57} 58 59type ListRegionalBucketsOutput struct { 60 61 // NextToken is sent when isTruncated is true, which means there are more buckets 62 // that can be listed. The next list requests to Amazon S3 can be continued with 63 // this NextToken. NextToken is obfuscated and is not a real key. 64 NextToken *string 65 66 // 67 RegionalBucketList []types.RegionalBucket 68 69 // Metadata pertaining to the operation's result. 70 ResultMetadata middleware.Metadata 71} 72 73func addOperationListRegionalBucketsMiddlewares(stack *middleware.Stack, options Options) (err error) { 74 err = stack.Serialize.Add(&awsRestxml_serializeOpListRegionalBuckets{}, middleware.After) 75 if err != nil { 76 return err 77 } 78 err = stack.Deserialize.Add(&awsRestxml_deserializeOpListRegionalBuckets{}, middleware.After) 79 if err != nil { 80 return err 81 } 82 if err = addSetLoggerMiddleware(stack, options); err != nil { 83 return err 84 } 85 if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil { 86 return err 87 } 88 if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil { 89 return err 90 } 91 if err = addResolveEndpointMiddleware(stack, options); err != nil { 92 return err 93 } 94 if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil { 95 return err 96 } 97 if err = addRetryMiddlewares(stack, options); err != nil { 98 return err 99 } 100 if err = addHTTPSignerV4Middleware(stack, options); err != nil { 101 return err 102 } 103 if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil { 104 return err 105 } 106 if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil { 107 return err 108 } 109 if err = addClientUserAgent(stack); err != nil { 110 return err 111 } 112 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil { 113 return err 114 } 115 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil { 116 return err 117 } 118 if err = addEndpointPrefix_opListRegionalBucketsMiddleware(stack); err != nil { 119 return err 120 } 121 if err = addOpListRegionalBucketsValidationMiddleware(stack); err != nil { 122 return err 123 } 124 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListRegionalBuckets(options.Region), middleware.Before); err != nil { 125 return err 126 } 127 if err = addMetadataRetrieverMiddleware(stack); err != nil { 128 return err 129 } 130 if err = addListRegionalBucketsUpdateEndpoint(stack, options); err != nil { 131 return err 132 } 133 if err = addResponseErrorMiddleware(stack); err != nil { 134 return err 135 } 136 if err = v4.AddContentSHA256HeaderMiddleware(stack); err != nil { 137 return err 138 } 139 if err = addRequestResponseLogging(stack, options); err != nil { 140 return err 141 } 142 return nil 143} 144 145type endpointPrefix_opListRegionalBucketsMiddleware struct { 146} 147 148func (*endpointPrefix_opListRegionalBucketsMiddleware) ID() string { 149 return "EndpointHostPrefix" 150} 151 152func (m *endpointPrefix_opListRegionalBucketsMiddleware) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( 153 out middleware.SerializeOutput, metadata middleware.Metadata, err error, 154) { 155 if smithyhttp.GetHostnameImmutable(ctx) || smithyhttp.IsEndpointHostPrefixDisabled(ctx) { 156 return next.HandleSerialize(ctx, in) 157 } 158 159 req, ok := in.Request.(*smithyhttp.Request) 160 if !ok { 161 return out, metadata, fmt.Errorf("unknown transport type %T", in.Request) 162 } 163 164 input, ok := in.Parameters.(*ListRegionalBucketsInput) 165 if !ok { 166 return out, metadata, fmt.Errorf("unknown input type %T", in.Parameters) 167 } 168 169 var prefix strings.Builder 170 if input.AccountId == nil { 171 return out, metadata, &smithy.SerializationError{Err: fmt.Errorf("AccountId forms part of the endpoint host and so may not be nil")} 172 } else if !smithyhttp.ValidHostLabel(*input.AccountId) { 173 return out, metadata, &smithy.SerializationError{Err: fmt.Errorf("AccountId forms part of the endpoint host and so must match \"[a-zA-Z0-9-]{1,63}\", but was \"%s\"", *input.AccountId)} 174 } else { 175 prefix.WriteString(*input.AccountId) 176 } 177 prefix.WriteString(".") 178 req.URL.Host = prefix.String() + req.URL.Host 179 180 return next.HandleSerialize(ctx, in) 181} 182func addEndpointPrefix_opListRegionalBucketsMiddleware(stack *middleware.Stack) error { 183 return stack.Serialize.Insert(&endpointPrefix_opListRegionalBucketsMiddleware{}, `OperationSerializer`, middleware.After) 184} 185 186// ListRegionalBucketsAPIClient is a client that implements the ListRegionalBuckets 187// operation. 188type ListRegionalBucketsAPIClient interface { 189 ListRegionalBuckets(context.Context, *ListRegionalBucketsInput, ...func(*Options)) (*ListRegionalBucketsOutput, error) 190} 191 192var _ ListRegionalBucketsAPIClient = (*Client)(nil) 193 194// ListRegionalBucketsPaginatorOptions is the paginator options for 195// ListRegionalBuckets 196type ListRegionalBucketsPaginatorOptions struct { 197 // 198 Limit int32 199 200 // Set to true if pagination should stop if the service returns a pagination token 201 // that matches the most recent token provided to the service. 202 StopOnDuplicateToken bool 203} 204 205// ListRegionalBucketsPaginator is a paginator for ListRegionalBuckets 206type ListRegionalBucketsPaginator struct { 207 options ListRegionalBucketsPaginatorOptions 208 client ListRegionalBucketsAPIClient 209 params *ListRegionalBucketsInput 210 nextToken *string 211 firstPage bool 212} 213 214// NewListRegionalBucketsPaginator returns a new ListRegionalBucketsPaginator 215func NewListRegionalBucketsPaginator(client ListRegionalBucketsAPIClient, params *ListRegionalBucketsInput, optFns ...func(*ListRegionalBucketsPaginatorOptions)) *ListRegionalBucketsPaginator { 216 if params == nil { 217 params = &ListRegionalBucketsInput{} 218 } 219 220 options := ListRegionalBucketsPaginatorOptions{} 221 if params.MaxResults != 0 { 222 options.Limit = params.MaxResults 223 } 224 225 for _, fn := range optFns { 226 fn(&options) 227 } 228 229 return &ListRegionalBucketsPaginator{ 230 options: options, 231 client: client, 232 params: params, 233 firstPage: true, 234 } 235} 236 237// HasMorePages returns a boolean indicating whether more pages are available 238func (p *ListRegionalBucketsPaginator) HasMorePages() bool { 239 return p.firstPage || p.nextToken != nil 240} 241 242// NextPage retrieves the next ListRegionalBuckets page. 243func (p *ListRegionalBucketsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRegionalBucketsOutput, error) { 244 if !p.HasMorePages() { 245 return nil, fmt.Errorf("no more pages available") 246 } 247 248 params := *p.params 249 params.NextToken = p.nextToken 250 251 params.MaxResults = p.options.Limit 252 253 result, err := p.client.ListRegionalBuckets(ctx, ¶ms, optFns...) 254 if err != nil { 255 return nil, err 256 } 257 p.firstPage = false 258 259 prevToken := p.nextToken 260 p.nextToken = result.NextToken 261 262 if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken { 263 p.nextToken = nil 264 } 265 266 return result, nil 267} 268 269func newServiceMetadataMiddleware_opListRegionalBuckets(region string) *awsmiddleware.RegisterServiceMetadata { 270 return &awsmiddleware.RegisterServiceMetadata{ 271 Region: region, 272 ServiceID: ServiceID, 273 SigningName: "s3", 274 OperationName: "ListRegionalBuckets", 275 } 276} 277 278func copyListRegionalBucketsInputForUpdateEndpoint(params interface{}) (interface{}, error) { 279 input, ok := params.(*ListRegionalBucketsInput) 280 if !ok { 281 return nil, fmt.Errorf("expect *ListRegionalBucketsInput type, got %T", params) 282 } 283 cpy := *input 284 return &cpy, nil 285} 286 287// getListRegionalBucketsOutpostIDMember returns a pointer to string denoting a 288// provided outpost-id member value and a boolean indicating if the input has a 289// modeled outpost-id, 290func getListRegionalBucketsOutpostIDMember(input interface{}) (*string, bool) { 291 in := input.(*ListRegionalBucketsInput) 292 if in.OutpostId == nil { 293 return nil, false 294 } 295 return in.OutpostId, true 296} 297func backFillListRegionalBucketsAccountID(input interface{}, v string) error { 298 in := input.(*ListRegionalBucketsInput) 299 if in.AccountId != nil { 300 if !strings.EqualFold(*in.AccountId, v) { 301 return fmt.Errorf("error backfilling account id") 302 } 303 return nil 304 } 305 in.AccountId = &v 306 return nil 307} 308func addListRegionalBucketsUpdateEndpoint(stack *middleware.Stack, options Options) error { 309 return s3controlcust.UpdateEndpoint(stack, s3controlcust.UpdateEndpointOptions{ 310 Accessor: s3controlcust.UpdateEndpointParameterAccessor{GetARNInput: nopGetARNAccessor, 311 BackfillAccountID: nopBackfillAccountIDAccessor, 312 GetOutpostIDInput: getListRegionalBucketsOutpostIDMember, 313 UpdateARNField: nopSetARNAccessor, 314 CopyInput: copyListRegionalBucketsInputForUpdateEndpoint, 315 }, 316 EndpointResolver: options.EndpointResolver, 317 EndpointResolverOptions: options.EndpointOptions, 318 UseDualstack: options.UseDualstack, 319 UseARNRegion: options.UseARNRegion, 320 }) 321} 322