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


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

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


    my $s3 = Paws->service('S3');
    my $PutObjectOutput = $s3->PutObject(
      Bucket             => 'MyBucketName',
      Key                => 'MyObjectKey',
      ACL                => 'private',                 # OPTIONAL
      Body               => 'BlobBody',                # OPTIONAL
      CacheControl       => 'MyCacheControl',          # OPTIONAL
      ContentDisposition => 'MyContentDisposition',    # OPTIONAL
      ContentEncoding    => 'MyContentEncoding',       # OPTIONAL
      ContentLanguage    => 'MyContentLanguage',       # OPTIONAL
      ContentLength      => 1,                         # OPTIONAL
      ContentMD5         => 'MyContentMD5',            # OPTIONAL
      ContentType        => 'MyContentType',           # OPTIONAL
      Expires            => '1970-01-01T01:00:00',     # OPTIONAL
      GrantFullControl   => 'MyGrantFullControl',      # OPTIONAL
      GrantRead          => 'MyGrantRead',             # OPTIONAL
      GrantReadACP       => 'MyGrantReadACP',          # OPTIONAL
      GrantWriteACP      => 'MyGrantWriteACP',         # OPTIONAL
      Metadata => { 'MyMetadataKey' => 'MyMetadataValue', },    # OPTIONAL
      ObjectLockLegalHoldStatus => 'ON',                        # OPTIONAL
      ObjectLockMode            => 'GOVERNANCE',                # OPTIONAL
      ObjectLockRetainUntilDate => '1970-01-01T01:00:00',       # OPTIONAL
      RequestPayer              => 'requester',                 # OPTIONAL
      SSECustomerAlgorithm      => 'MySSECustomerAlgorithm',    # OPTIONAL
      SSECustomerKey            => 'MySSECustomerKey',          # OPTIONAL
      SSECustomerKeyMD5         => 'MySSECustomerKeyMD5',       # OPTIONAL
      SSEKMSKeyId               => 'MySSEKMSKeyId',             # OPTIONAL
      ServerSideEncryption      => 'AES256',                    # OPTIONAL
      StorageClass              => 'STANDARD',                  # OPTIONAL
      Tagging                   => 'MyTaggingHeader',           # OPTIONAL
      WebsiteRedirectLocation   => 'MyWebsiteRedirectLocation', # OPTIONAL

    # Results:
    my $ETag                 = $PutObjectOutput->ETag;
    my $Expiration           = $PutObjectOutput->Expiration;
    my $RequestCharged       = $PutObjectOutput->RequestCharged;
    my $SSECustomerAlgorithm = $PutObjectOutput->SSECustomerAlgorithm;
    my $SSECustomerKeyMD5    = $PutObjectOutput->SSECustomerKeyMD5;
    my $SSEKMSKeyId          = $PutObjectOutput->SSEKMSKeyId;
    my $ServerSideEncryption = $PutObjectOutput->ServerSideEncryption;
    my $VersionId            = $PutObjectOutput->VersionId;

    # Returns a L<Paws::S3::PutObjectOutput> 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


ACL => Str

The canned ACL to apply to the object.

Valid values are: "private", "public-read", "public-read-write", "authenticated-read", "aws-exec-read", "bucket-owner-read", "bucket-owner-full-control"

Body => Str

Object data.

REQUIRED Bucket => Str

Name of the bucket to which the PUT operation was initiated.

CacheControl => Str

Specifies caching behavior along the request/reply chain.

ContentDisposition => Str

Specifies presentational information for the object.

ContentEncoding => Str

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

ContentLanguage => Str

The language the content is in.

ContentLength => Int

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

ContentMD5 => Str

The base64-encoded 128-bit MD5 digest of the part data.

ContentType => Str

A standard MIME type describing the format of the object data.

Expires => Str

The date and time at which the object is no longer cacheable.

GrantFullControl => Str

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

GrantRead => Str

Allows grantee to read the object data and its metadata.

GrantReadACP => Str

Allows grantee to read the object ACL.

GrantWriteACP => Str

Allows grantee to write the ACL for the applicable object.


Object key for which the PUT operation was initiated.

Metadata => Paws::S3::Metadata

A map of metadata to store with the object in S3.

ObjectLockLegalHoldStatus => Str

The Legal Hold status that you want to apply to the specified object.

Valid values are: "ON", "OFF"

ObjectLockMode => Str

The Object Lock mode that you want to apply to this object.

Valid values are: "GOVERNANCE", "COMPLIANCE"

ObjectLockRetainUntilDate => Str

The date and time when you want this object's Object Lock to expire.

RequestPayer => Str

Valid values are: "requester"

ServerSideEncryption => Str

The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

Valid values are: "AES256", "aws:kms"

SSECustomerAlgorithm => Str

Specifies the algorithm to use to when encrypting the object (e.g., AES256).

SSECustomerKey => Str

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

SSECustomerKeyMD5 => Str

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

SSEKMSKeyId => Str

Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at

StorageClass => Str

The type of storage to use for the object. Defaults to 'STANDARD'.


Tagging => Str

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")

WebsiteRedirectLocation => Str

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.


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


The source code is located here:

Please report bugs to: