/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::S3::PutObjectRetention

NAME

Paws::S3::PutObjectRetention - Arguments for method PutObjectRetention on Paws::S3

DESCRIPTION

This class represents the parameters used for calling the method PutObjectRetention on the Amazon Simple Storage Service service. Use the attributes of this class as arguments to method PutObjectRetention.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutObjectRetention.

SYNOPSIS

my $s3 = Paws->service('S3');
my $PutObjectRetentionOutput = $s3->PutObjectRetention(
  Bucket                    => 'MyBucketName',
  Key                       => 'MyObjectKey',
  BypassGovernanceRetention => 1,                 # OPTIONAL
  ContentMD5                => 'MyContentMD5',    # OPTIONAL
  ExpectedBucketOwner       => 'MyAccountId',     # OPTIONAL
  RequestPayer              => 'requester',       # OPTIONAL
  Retention                 => {
    Mode => 'GOVERNANCE',    # values: GOVERNANCE, COMPLIANCE; OPTIONAL
    RetainUntilDate => '1970-01-01T01:00:00',    # OPTIONAL
  },    # OPTIONAL
  VersionId => 'MyObjectVersionId',    # OPTIONAL
);

# Results:
my $RequestCharged = $PutObjectRetentionOutput->RequestCharged;

# Returns a L<Paws::S3::PutObjectRetentionOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/s3/PutObjectRetention

ATTRIBUTES

REQUIRED Bucket => Str

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 AWS 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.

BypassGovernanceRetention => Bool

Indicates whether this action should bypass Governance-mode restrictions.

ContentMD5 => Str

The MD5 hash for the request body.

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

ExpectedBucketOwner => Str

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

REQUIRED Key => Str

The key name for the object that you want to apply this Object Retention configuration to.

RequestPayer => Str

Valid values are: "requester"

Retention => Paws::S3::ObjectLockRetention

The container element for the Object Retention configuration.

VersionId => Str

The version ID for the object that you want to apply this Object Retention configuration to.

SEE ALSO

This class forms part of Paws, documenting arguments for method PutObjectRetention in Paws::S3

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues