You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
245 lines
8.8 KiB
245 lines
8.8 KiB
// Code generated by smithy-go-codegen DO NOT EDIT.
|
|
|
|
package s3
|
|
|
|
import (
|
|
"context"
|
|
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
|
|
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
|
|
internalChecksum "github.com/aws/aws-sdk-go-v2/service/internal/checksum"
|
|
s3cust "github.com/aws/aws-sdk-go-v2/service/s3/internal/customizations"
|
|
"github.com/aws/aws-sdk-go-v2/service/s3/types"
|
|
"github.com/aws/smithy-go/middleware"
|
|
smithyhttp "github.com/aws/smithy-go/transport/http"
|
|
)
|
|
|
|
// Places an Object Retention configuration on an object. For more information, see
|
|
// Locking Objects
|
|
// (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). Users or
|
|
// accounts require the s3:PutObjectRetention permission in order to place an
|
|
// Object Retention configuration on objects. Bypassing a Governance Retention
|
|
// configuration requires the s3:BypassGovernanceRetention permission. This action
|
|
// is not supported by Amazon S3 on Outposts.
|
|
func (c *Client) PutObjectRetention(ctx context.Context, params *PutObjectRetentionInput, optFns ...func(*Options)) (*PutObjectRetentionOutput, error) {
|
|
if params == nil {
|
|
params = &PutObjectRetentionInput{}
|
|
}
|
|
|
|
result, metadata, err := c.invokeOperation(ctx, "PutObjectRetention", params, optFns, c.addOperationPutObjectRetentionMiddlewares)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
out := result.(*PutObjectRetentionOutput)
|
|
out.ResultMetadata = metadata
|
|
return out, nil
|
|
}
|
|
|
|
type PutObjectRetentionInput struct {
|
|
|
|
// The bucket name that contains the object you want to apply this Object Retention
|
|
// configuration to. When using this action with an access point, you must direct
|
|
// requests to the access point hostname. The access point hostname takes the form
|
|
// AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this
|
|
// action with an access point through the Amazon Web Services SDKs, you provide
|
|
// the access point ARN in place of the bucket name. For more information about
|
|
// access point ARNs, see Using access points
|
|
// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
|
|
// in the Amazon S3 User Guide.
|
|
//
|
|
// This member is required.
|
|
Bucket *string
|
|
|
|
// The key name for the object that you want to apply this Object Retention
|
|
// configuration to.
|
|
//
|
|
// This member is required.
|
|
Key *string
|
|
|
|
// Indicates whether this action should bypass Governance-mode restrictions.
|
|
BypassGovernanceRetention bool
|
|
|
|
// Indicates the algorithm used to create the checksum for the object when using
|
|
// the SDK. This header will not provide any additional functionality if not using
|
|
// the SDK. When sending this header, there must be a corresponding x-amz-checksum
|
|
// or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the
|
|
// HTTP status code 400 Bad Request. For more information, see Checking object
|
|
// integrity
|
|
// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html)
|
|
// in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3
|
|
// ignores any provided ChecksumAlgorithm parameter.
|
|
ChecksumAlgorithm types.ChecksumAlgorithm
|
|
|
|
// The MD5 hash for the request body. For requests made using the Amazon Web
|
|
// Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is
|
|
// calculated automatically.
|
|
ContentMD5 *string
|
|
|
|
// The account ID of the expected bucket owner. If the bucket is owned by a
|
|
// different account, the request fails with the HTTP status code 403 Forbidden
|
|
// (access denied).
|
|
ExpectedBucketOwner *string
|
|
|
|
// Confirms that the requester knows that they will be charged for the request.
|
|
// Bucket owners need not specify this parameter in their requests. For information
|
|
// about downloading objects from Requester Pays buckets, see Downloading Objects
|
|
// in Requester Pays Buckets
|
|
// (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)
|
|
// in the Amazon S3 User Guide.
|
|
RequestPayer types.RequestPayer
|
|
|
|
// The container element for the Object Retention configuration.
|
|
Retention *types.ObjectLockRetention
|
|
|
|
// The version ID for the object that you want to apply this Object Retention
|
|
// configuration to.
|
|
VersionId *string
|
|
|
|
noSmithyDocumentSerde
|
|
}
|
|
|
|
type PutObjectRetentionOutput struct {
|
|
|
|
// If present, indicates that the requester was successfully charged for the
|
|
// request.
|
|
RequestCharged types.RequestCharged
|
|
|
|
// Metadata pertaining to the operation's result.
|
|
ResultMetadata middleware.Metadata
|
|
|
|
noSmithyDocumentSerde
|
|
}
|
|
|
|
func (c *Client) addOperationPutObjectRetentionMiddlewares(stack *middleware.Stack, options Options) (err error) {
|
|
err = stack.Serialize.Add(&awsRestxml_serializeOpPutObjectRetention{}, middleware.After)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
err = stack.Deserialize.Add(&awsRestxml_deserializeOpPutObjectRetention{}, 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); err != nil {
|
|
return err
|
|
}
|
|
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
|
|
return err
|
|
}
|
|
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
|
|
return err
|
|
}
|
|
if err = swapWithCustomHTTPSignerMiddleware(stack, options); err != nil {
|
|
return err
|
|
}
|
|
if err = addOpPutObjectRetentionValidationMiddleware(stack); err != nil {
|
|
return err
|
|
}
|
|
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opPutObjectRetention(options.Region), middleware.Before); err != nil {
|
|
return err
|
|
}
|
|
if err = addMetadataRetrieverMiddleware(stack); err != nil {
|
|
return err
|
|
}
|
|
if err = addPutObjectRetentionInputChecksumMiddlewares(stack, options); err != nil {
|
|
return err
|
|
}
|
|
if err = addPutObjectRetentionUpdateEndpoint(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 = disableAcceptEncodingGzip(stack); err != nil {
|
|
return err
|
|
}
|
|
if err = addRequestResponseLogging(stack, options); err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func newServiceMetadataMiddleware_opPutObjectRetention(region string) *awsmiddleware.RegisterServiceMetadata {
|
|
return &awsmiddleware.RegisterServiceMetadata{
|
|
Region: region,
|
|
ServiceID: ServiceID,
|
|
SigningName: "s3",
|
|
OperationName: "PutObjectRetention",
|
|
}
|
|
}
|
|
|
|
// getPutObjectRetentionRequestAlgorithmMember gets the request checksum algorithm
|
|
// value provided as input.
|
|
func getPutObjectRetentionRequestAlgorithmMember(input interface{}) (string, bool) {
|
|
in := input.(*PutObjectRetentionInput)
|
|
if len(in.ChecksumAlgorithm) == 0 {
|
|
return "", false
|
|
}
|
|
return string(in.ChecksumAlgorithm), true
|
|
}
|
|
|
|
func addPutObjectRetentionInputChecksumMiddlewares(stack *middleware.Stack, options Options) error {
|
|
return internalChecksum.AddInputMiddleware(stack, internalChecksum.InputMiddlewareOptions{
|
|
GetAlgorithm: getPutObjectRetentionRequestAlgorithmMember,
|
|
RequireChecksum: true,
|
|
EnableTrailingChecksum: false,
|
|
EnableComputeSHA256PayloadHash: true,
|
|
EnableDecodedContentLengthHeader: true,
|
|
})
|
|
}
|
|
|
|
// getPutObjectRetentionBucketMember returns a pointer to string denoting a
|
|
// provided bucket member valueand a boolean indicating if the input has a modeled
|
|
// bucket name,
|
|
func getPutObjectRetentionBucketMember(input interface{}) (*string, bool) {
|
|
in := input.(*PutObjectRetentionInput)
|
|
if in.Bucket == nil {
|
|
return nil, false
|
|
}
|
|
return in.Bucket, true
|
|
}
|
|
func addPutObjectRetentionUpdateEndpoint(stack *middleware.Stack, options Options) error {
|
|
return s3cust.UpdateEndpoint(stack, s3cust.UpdateEndpointOptions{
|
|
Accessor: s3cust.UpdateEndpointParameterAccessor{
|
|
GetBucketFromInput: getPutObjectRetentionBucketMember,
|
|
},
|
|
UsePathStyle: options.UsePathStyle,
|
|
UseAccelerate: options.UseAccelerate,
|
|
SupportsAccelerate: true,
|
|
TargetS3ObjectLambda: false,
|
|
EndpointResolver: options.EndpointResolver,
|
|
EndpointResolverOptions: options.EndpointOptions,
|
|
UseARNRegion: options.UseARNRegion,
|
|
DisableMultiRegionAccessPoints: options.DisableMultiRegionAccessPoints,
|
|
})
|
|
}
|