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