// Code generated by smithy-go-codegen DO NOT EDIT. package s3control import ( "context" "fmt" awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware" "github.com/aws/aws-sdk-go-v2/aws/signer/v4" s3controlcust "github.com/aws/aws-sdk-go-v2/service/s3control/internal/customizations" "github.com/aws/aws-sdk-go-v2/service/s3control/types" smithy "github.com/aws/smithy-go" "github.com/aws/smithy-go/middleware" smithyhttp "github.com/aws/smithy-go/transport/http" "strings" ) // This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To // get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) // in the Amazon S3 API Reference. Returns the lifecycle configuration information // set on the Outposts bucket. For more information, see Using Amazon S3 on // Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) // and for information about lifecycle configuration, see Object Lifecycle // Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) // in Amazon S3 User Guide. To use this action, you must have permission to perform // the s3-outposts:GetLifecycleConfiguration action. The Outposts bucket owner has // this permission, by default. The bucket owner can grant this permission to // others. For more information about permissions, see Permissions Related to // Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) // and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) // . All Amazon S3 on Outposts REST API requests for this action require an // additional parameter of x-amz-outpost-id to be passed with the request. In // addition, you must use an S3 on Outposts endpoint hostname prefix instead of // s3-control . For an example of the request syntax for Amazon S3 on Outposts that // uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id // derived by using the access point ARN, see the Examples (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html#API_control_GetBucketLifecycleConfiguration_Examples) // section. GetBucketLifecycleConfiguration has the following special error: // - Error code: NoSuchLifecycleConfiguration // - Description: The lifecycle configuration does not exist. // - HTTP Status Code: 404 Not Found // - SOAP Fault Code Prefix: Client // // The following actions are related to GetBucketLifecycleConfiguration : // - PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html) // - DeleteBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html) func (c *Client) GetBucketLifecycleConfiguration(ctx context.Context, params *GetBucketLifecycleConfigurationInput, optFns ...func(*Options)) (*GetBucketLifecycleConfigurationOutput, error) { if params == nil { params = &GetBucketLifecycleConfigurationInput{} } result, metadata, err := c.invokeOperation(ctx, "GetBucketLifecycleConfiguration", params, optFns, c.addOperationGetBucketLifecycleConfigurationMiddlewares) if err != nil { return nil, err } out := result.(*GetBucketLifecycleConfigurationOutput) out.ResultMetadata = metadata return out, nil } type GetBucketLifecycleConfigurationInput struct { // The Amazon Web Services account ID of the Outposts bucket. // // This member is required. AccountId *string // The Amazon Resource Name (ARN) of the bucket. For using this parameter with // Amazon S3 on Outposts with the REST API, you must specify the name and the // x-amz-outpost-id as well. For using this parameter with S3 on Outposts with the // Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed // in the format arn:aws:s3-outposts:::outpost//bucket/ . For example, to access // the bucket reports through Outpost my-outpost owned by account 123456789012 in // Region us-west-2 , use the URL encoding of // arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports . // The value must be URL encoded. // // This member is required. Bucket *string noSmithyDocumentSerde } type GetBucketLifecycleConfigurationOutput struct { // Container for the lifecycle rule of the Outposts bucket. Rules []types.LifecycleRule // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata noSmithyDocumentSerde } func (c *Client) addOperationGetBucketLifecycleConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error) { err = stack.Serialize.Add(&awsRestxml_serializeOpGetBucketLifecycleConfiguration{}, middleware.After) if err != nil { return err } err = stack.Deserialize.Add(&awsRestxml_deserializeOpGetBucketLifecycleConfiguration{}, middleware.After) if err != nil { return err } if err = addSetLoggerMiddleware(stack, options); err != nil { return err } if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil { return err } if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil { return err } if err = addResolveEndpointMiddleware(stack, options); err != nil { return err } if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil { return err } if err = addRetryMiddlewares(stack, options); err != nil { return err } if err = addHTTPSignerV4Middleware(stack, options); err != nil { return err } if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil { return err } if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil { return err } if err = addClientUserAgent(stack, options); err != nil { return err } if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil { return err } if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil { return err } if err = addEndpointPrefix_opGetBucketLifecycleConfigurationMiddleware(stack); err != nil { return err } if err = addOpGetBucketLifecycleConfigurationValidationMiddleware(stack); err != nil { return err } if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetBucketLifecycleConfiguration(options.Region), middleware.Before); err != nil { return err } if err = addMetadataRetrieverMiddleware(stack); err != nil { return err } if err = awsmiddleware.AddRecursionDetection(stack); err != nil { return err } if err = addGetBucketLifecycleConfigurationUpdateEndpoint(stack, options); err != nil { return err } if err = addResponseErrorMiddleware(stack); err != nil { return err } if err = v4.AddContentSHA256HeaderMiddleware(stack); err != nil { return err } if err = addRequestResponseLogging(stack, options); err != nil { return err } return nil } type endpointPrefix_opGetBucketLifecycleConfigurationMiddleware struct { } func (*endpointPrefix_opGetBucketLifecycleConfigurationMiddleware) ID() string { return "EndpointHostPrefix" } func (m *endpointPrefix_opGetBucketLifecycleConfigurationMiddleware) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, ) { if smithyhttp.GetHostnameImmutable(ctx) || smithyhttp.IsEndpointHostPrefixDisabled(ctx) { return next.HandleSerialize(ctx, in) } req, ok := in.Request.(*smithyhttp.Request) if !ok { return out, metadata, fmt.Errorf("unknown transport type %T", in.Request) } input, ok := in.Parameters.(*GetBucketLifecycleConfigurationInput) if !ok { return out, metadata, fmt.Errorf("unknown input type %T", in.Parameters) } var prefix strings.Builder if input.AccountId == nil { return out, metadata, &smithy.SerializationError{Err: fmt.Errorf("AccountId forms part of the endpoint host and so may not be nil")} } else if !smithyhttp.ValidHostLabel(*input.AccountId) { 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)} } else { prefix.WriteString(*input.AccountId) } prefix.WriteString(".") req.URL.Host = prefix.String() + req.URL.Host return next.HandleSerialize(ctx, in) } func addEndpointPrefix_opGetBucketLifecycleConfigurationMiddleware(stack *middleware.Stack) error { return stack.Serialize.Insert(&endpointPrefix_opGetBucketLifecycleConfigurationMiddleware{}, `OperationSerializer`, middleware.After) } func newServiceMetadataMiddleware_opGetBucketLifecycleConfiguration(region string) *awsmiddleware.RegisterServiceMetadata { return &awsmiddleware.RegisterServiceMetadata{ Region: region, ServiceID: ServiceID, SigningName: "s3", OperationName: "GetBucketLifecycleConfiguration", } } func copyGetBucketLifecycleConfigurationInputForUpdateEndpoint(params interface{}) (interface{}, error) { input, ok := params.(*GetBucketLifecycleConfigurationInput) if !ok { return nil, fmt.Errorf("expect *GetBucketLifecycleConfigurationInput type, got %T", params) } cpy := *input return &cpy, nil } func getGetBucketLifecycleConfigurationARNMember(input interface{}) (*string, bool) { in := input.(*GetBucketLifecycleConfigurationInput) if in.Bucket == nil { return nil, false } return in.Bucket, true } func setGetBucketLifecycleConfigurationARNMember(input interface{}, v string) error { in := input.(*GetBucketLifecycleConfigurationInput) in.Bucket = &v return nil } func backFillGetBucketLifecycleConfigurationAccountID(input interface{}, v string) error { in := input.(*GetBucketLifecycleConfigurationInput) if in.AccountId != nil { if !strings.EqualFold(*in.AccountId, v) { return fmt.Errorf("error backfilling account id") } return nil } in.AccountId = &v return nil } func addGetBucketLifecycleConfigurationUpdateEndpoint(stack *middleware.Stack, options Options) error { return s3controlcust.UpdateEndpoint(stack, s3controlcust.UpdateEndpointOptions{ Accessor: s3controlcust.UpdateEndpointParameterAccessor{GetARNInput: getGetBucketLifecycleConfigurationARNMember, BackfillAccountID: backFillGetBucketLifecycleConfigurationAccountID, GetOutpostIDInput: nopGetOutpostIDFromInput, UpdateARNField: setGetBucketLifecycleConfigurationARNMember, CopyInput: copyGetBucketLifecycleConfigurationInputForUpdateEndpoint, }, EndpointResolver: options.EndpointResolver, EndpointResolverOptions: options.EndpointOptions, UseARNRegion: options.UseARNRegion, }) }