NAME
Paws::S3::CreateMultipartUpload - Arguments for method CreateMultipartUpload on Paws::S3
DESCRIPTION
This class represents the parameters used for calling the method CreateMultipartUpload on the Amazon Simple Storage Service service. Use the attributes of this class as arguments to method CreateMultipartUpload.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateMultipartUpload.
SYNOPSIS
my $s3 = Paws->service('S3');
# To initiate a multipart upload
# The following example initiates a multipart upload.
my $CreateMultipartUploadOutput = $s3->CreateMultipartUpload(
'Bucket' => 'examplebucket',
'Key' => 'largeobject'
);
# Results:
my $Bucket = $CreateMultipartUploadOutput->Bucket;
my $Key = $CreateMultipartUploadOutput->Key;
my $UploadId = $CreateMultipartUploadOutput->UploadId;
# Returns a L<Paws::S3::CreateMultipartUploadOutput> 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/CreateMultipartUpload
ATTRIBUTES
ACL => Str
The canned ACL to apply to the object.
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"
REQUIRED Bucket => Str
The name of the bucket to which to initiate the upload
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 an object action doesn’t affect bucket-level settings for S3 Bucket Key.
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.
ContentType => Str
A standard MIME type describing the format of the object data.
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.
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 multipart upload is to be initiated.
Metadata => Paws::S3::Metadata
A map of metadata to store with the object in S3.
ObjectLockLegalHoldStatus => Str
Specifies whether you want to apply a Legal Hold to the uploaded object.
Valid values are: "ON", "OFF"
ObjectLockMode => Str
Specifies the Object Lock mode that you want to apply to the uploaded object.
Valid values are: "GOVERNANCE", "COMPLIANCE"
ObjectLockRetainUntilDate => Str
Specifies the date and time when you want the Object Lock to expire.
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
Specifies the ID of the symmetric customer managed AWS KMS CMK 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. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version) in the Amazon S3 User Guide.
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.
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.
SEE ALSO
This class forms part of Paws, documenting arguments for method CreateMultipartUpload 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