NAME

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

DESCRIPTION

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.

SYNOPSIS

   my $s3 = Paws->service('S3');
# To create an object.
# The following example creates an object. If the bucket is versioning enabled,
# S3 returns version ID in response.
   my $PutObjectOutput = $s3->PutObject(
     'Body'   => 'filetoupload',
     'Bucket' => 'examplebucket',
     'Key'    => 'objectkey'
   );

   # Results:
   my $ETag      = $PutObjectOutput->ETag;
   my $VersionId = $PutObjectOutput->VersionId;

   # Returns a L<Paws::S3::PutObjectOutput> object.
   # To upload an object (specify optional headers)
   # The following example uploads an object. The request specifies optional
   # request headers to directs S3 to use specific storage class and use
   # server-side encryption.
   my $PutObjectOutput = $s3->PutObject(
     'Body'                 => 'HappyFace.jpg',
     'Bucket'               => 'examplebucket',
     'Key'                  => 'HappyFace.jpg',
     'ServerSideEncryption' => 'AES256',
     'StorageClass'         => 'STANDARD_IA'
   );

   # Results:
   my $ETag                 = $PutObjectOutput->ETag;
   my $ServerSideEncryption = $PutObjectOutput->ServerSideEncryption;
   my $VersionId            = $PutObjectOutput->VersionId;

# Returns a Paws::S3::PutObjectOutput object. # To upload an object and specify canned ACL. # The following example uploads and object. The request specifies optional # canned ACL (access control list) to all READ access to authenticated users. If # the bucket is versioning enabled, S3 returns version ID in response. my $PutObjectOutput = $s3->PutObject( 'ACL' => 'authenticated-read', 'Body' => 'filetoupload', 'Bucket' => 'examplebucket', 'Key' => 'exampleobject' );

  # Results:
  my $ETag      = $PutObjectOutput->ETag;
  my $VersionId = $PutObjectOutput->VersionId;

 # Returns a L<Paws::S3::PutObjectOutput> object.
 # To upload an object
 # The following example uploads an object to a versioning-enabled bucket. The
 # source file is specified using Windows file syntax. S3 returns VersionId of
 # the newly created object.
  my $PutObjectOutput = $s3->PutObject(
    'Body'   => 'HappyFace.jpg',
    'Bucket' => 'examplebucket',
    'Key'    => 'HappyFace.jpg'
  );

  # Results:
  my $ETag      = $PutObjectOutput->ETag;
  my $VersionId = $PutObjectOutput->VersionId;

# Returns a L<Paws::S3::PutObjectOutput> object.
# To upload object and specify user-defined metadata
# The following example creates an object. The request also specifies optional
# metadata. If the bucket is versioning enabled, S3 returns version ID in
# response.
  my $PutObjectOutput = $s3->PutObject(
    'Body'     => 'filetoupload',
    'Bucket'   => 'examplebucket',
    'Key'      => 'exampleobject',
    'Metadata' => {
      'Metadata1' => 'value1',
      'Metadata2' => 'value2'
    }
  );

  # Results:
  my $ETag      = $PutObjectOutput->ETag;
  my $VersionId = $PutObjectOutput->VersionId;

# Returns a Paws::S3::PutObjectOutput object. # To upload an object and specify optional tags # The following example uploads an object. The request specifies optional object # tags. The bucket is versioned, therefore S3 returns version ID of the newly # created object. my $PutObjectOutput = $s3->PutObject( 'Body' => 'c:\HappyFace.jpg', 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', 'Tagging' => 'key1=value1&key2=value2' );

   # Results:
   my $ETag      = $PutObjectOutput->ETag;
   my $VersionId = $PutObjectOutput->VersionId;

# Returns a L<Paws::S3::PutObjectOutput> object.
# To upload an object and specify server-side encryption and object tags
# The following example uploads and object. The request specifies the optional
# server-side encryption option. The request also specifies optional object
# tags. If the bucket is versioning enabled, S3 returns version ID in response.
   my $PutObjectOutput = $s3->PutObject(
     'Body'                 => 'filetoupload',
     'Bucket'               => 'examplebucket',
     'Key'                  => 'exampleobject',
     'ServerSideEncryption' => 'AES256',
     'Tagging'              => 'key1=value1&key2=value2'
   );

   # Results:
   my $ETag                 = $PutObjectOutput->ETag;
   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 https://docs.aws.amazon.com/goto/WebAPI/s3/PutObject

ATTRIBUTES

ACL => Str

The canned ACL to apply to the object. For more information, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).

This action is not supported by Amazon S3 on Outposts.

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

The bucket name to which the PUT action was initiated.

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.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the Amazon S3 User Guide.

BucketKeyEnabled => Bool

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.

CacheControl => Str

Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9).

ContentDisposition => Str

Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1 (http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1).

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. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11 (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11).

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. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13 (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13).

ContentMD5 => Str

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).

ContentType => Str

A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17 (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17).

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.

Expires => Str

The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21 (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21).

GrantFullControl => Str

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

This action is not supported by Amazon S3 on Outposts.

GrantRead => Str

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

GrantReadACP => Str

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

GrantWriteACP => Str

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

REQUIRED Key => Str

Object key for which the PUT action was initiated.

Metadata => Paws::S3::Metadata

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

ObjectLockLegalHoldStatus => Str

Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).

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. Must be formatted as a timestamp parameter.

RequestPayer => Str

Valid values are: "requester"

ServerSideEncryption => Str

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

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

SSECustomerAlgorithm => Str

Specifies the algorithm to use to when encrypting the object (for example, 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 S3 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 that the encryption key was transmitted without error.

SSEKMSEncryptionContext => Str

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

SSEKMSKeyId => Str

If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS to protect the data. If the KMS key does not exist in the same account issuing the command, you must use the full ARN and not just the ID.

StorageClass => Str

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in the Amazon S3 User Guide.

Valid values are: "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS"

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. For information about object metadata, see Object Key and Metadata (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html).

In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

x-amz-website-redirect-location: /anotherPage.html

In the following example, the request header sets the object redirect to another website:

x-amz-website-redirect-location: http://www.example.com/

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) and How to Configure Website Page Redirects (https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html).

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

To install Paws, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Paws

CPAN shell

perl -MCPAN -e shell
install Paws

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

DESCRIPTION

SYNOPSIS

ATTRIBUTES

ACL => Str

Body => Str

REQUIRED Bucket => Str

BucketKeyEnabled => Bool

CacheControl => Str

ContentDisposition => Str

ContentEncoding => Str

ContentLanguage => Str

ContentLength => Int

ContentMD5 => Str

ContentType => Str

ExpectedBucketOwner => Str

Expires => Str

GrantFullControl => Str

GrantRead => Str

GrantReadACP => Str

GrantWriteACP => Str

REQUIRED Key => Str

Metadata => Paws::S3::Metadata

ObjectLockLegalHoldStatus => Str

ObjectLockMode => Str

ObjectLockRetainUntilDate => Str

RequestPayer => Str

ServerSideEncryption => Str

SSECustomerAlgorithm => Str

SSECustomerKey => Str

SSECustomerKeyMD5 => Str

SSEKMSEncryptionContext => Str

SSEKMSKeyId => Str

StorageClass => Str

Tagging => Str

WebsiteRedirectLocation => Str

SEE ALSO

BUGS and CONTRIBUTIONS

Module Install Instructions