paws.storage (version 0.1.0)

s3_create_multipart_upload: Initiates a multipart upload and returns an upload ID

Description

Initiates a multipart upload and returns an upload ID.

Usage

s3_create_multipart_upload(ACL, Bucket, CacheControl,
  ContentDisposition, ContentEncoding, ContentLanguage, ContentType,
  Expires, GrantFullControl, GrantRead, GrantReadACP, GrantWriteACP, Key,
  Metadata, ServerSideEncryption, StorageClass, WebsiteRedirectLocation,
  SSECustomerAlgorithm, SSECustomerKey, SSECustomerKeyMD5, SSEKMSKeyId,
  RequestPayer, Tagging, ObjectLockMode, ObjectLockRetainUntilDate,
  ObjectLockLegalHoldStatus)

Arguments

ACL

The canned ACL to apply to the object.

Bucket

[required]

CacheControl

Specifies caching behavior along the request/reply chain.

ContentDisposition

Specifies presentational information for the object.

ContentEncoding

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

The language the content is in.

ContentType

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

Expires

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

GrantFullControl

Gives the grantee READ, READ\_ACP, and WRITE\_ACP permissions on the object.

GrantRead

Allows grantee to read the object data and its metadata.

GrantReadACP

Allows grantee to read the object ACL.

GrantWriteACP

Allows grantee to write the ACL for the applicable object.

Key

[required]

Metadata

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

ServerSideEncryption

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

StorageClass

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

WebsiteRedirectLocation

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.

SSECustomerAlgorithm

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

SSECustomerKey

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<U+00E2><U+20AC><U+2039>-encryption<U+00E2><U+20AC><U+2039>-customer-algorithm header.

SSECustomerKeyMD5

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

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 http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html\#specify-signature-version

RequestPayer

Tagging

The tag-set for the object. The tag-set must be encoded as URL Query parameters

ObjectLockMode

Specifies the Object Lock mode that you want to apply to the uploaded object.

ObjectLockRetainUntilDate

Specifies the date and time when you want the Object Lock to expire.

ObjectLockLegalHoldStatus

Specifies whether you want to apply a Legal Hold to the uploaded object.

Request syntax

svc$create_multipart_upload(
  ACL = "private"|"public-read"|"public-read-write"|"authenticated-read"|"aws-exec-read"|"bucket-owner-read"|"bucket-owner-full-control",
  Bucket = "string",
  CacheControl = "string",
  ContentDisposition = "string",
  ContentEncoding = "string",
  ContentLanguage = "string",
  ContentType = "string",
  Expires = as.POSIXct(
    "2015-01-01"
  ),
  GrantFullControl = "string",
  GrantRead = "string",
  GrantReadACP = "string",
  GrantWriteACP = "string",
  Key = "string",
  Metadata = list(
    "string"
  ),
  ServerSideEncryption = "AES256"|"aws:kms",
  StorageClass = "STANDARD"|"REDUCED_REDUNDANCY"|"STANDARD_IA"|"ONEZONE_IA"|"INTELLIGENT_TIERING"|"GLACIER"|"DEEP_ARCHIVE",
  WebsiteRedirectLocation = "string",
  SSECustomerAlgorithm = "string",
  SSECustomerKey = raw,
  SSECustomerKeyMD5 = "string",
  SSEKMSKeyId = "string",
  RequestPayer = "requester",
  Tagging = "string",
  ObjectLockMode = "GOVERNANCE"|"COMPLIANCE",
  ObjectLockRetainUntilDate = as.POSIXct(
    "2015-01-01"
  ),
  ObjectLockLegalHoldStatus = "ON"|"OFF"
)

Details

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

Examples

# NOT RUN {
# The following example initiates a multipart upload.
# }
# NOT RUN {
svc$create_multipart_upload(
  Bucket = "examplebucket",
  Key = "largeobject"
)
# }
# NOT RUN {
# }