Class: Aws::S3::Types::CompleteMultipartUploadRequest

Inherits:

Struct

Object
Struct
Aws::S3::Types::CompleteMultipartUploadRequest

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass CompleteMultipartUploadRequest data as a hash:

{
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  multipart_upload: {
    parts: [
      {
        etag: "ETag",
        checksum_crc32: "ChecksumCRC32",
        checksum_crc32c: "ChecksumCRC32C",
        checksum_sha1: "ChecksumSHA1",
        checksum_sha256: "ChecksumSHA256",
        part_number: 1,
      },
    ],
  },
  upload_id: "MultipartUploadId", # required
  checksum_crc32: "ChecksumCRC32",
  checksum_crc32c: "ChecksumCRC32C",
  checksum_sha1: "ChecksumSHA1",
  checksum_sha256: "ChecksumSHA256",
  request_payer: "requester", # accepts requester
  expected_bucket_owner: "AccountId",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
}

Constant Summary collapse

SENSITIVE =

[:sse_customer_key]

Instance Attribute Summary collapse

#bucket ⇒ String

Name of the bucket to which the multipart upload was initiated.
#checksum_crc32 ⇒ String

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
#checksum_crc32c ⇒ String

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
#checksum_sha1 ⇒ String

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
#checksum_sha256 ⇒ String

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
#expected_bucket_owner ⇒ String

The account ID of the expected bucket owner.
#key ⇒ String

Object key for which the multipart upload was initiated.
#multipart_upload ⇒ Types::CompletedMultipartUpload

The container for the multipart upload request information.
#request_payer ⇒ String

Confirms that the requester knows that they will be charged for the request.
#sse_customer_algorithm ⇒ String

The server-side encryption (SSE) algorithm used to encrypt the object.
#sse_customer_key ⇒ String

The server-side encryption (SSE) customer managed key.
#sse_customer_key_md5 ⇒ String

The MD5 server-side encryption (SSE) customer managed key.
#upload_id ⇒ String

ID for the initiated multipart upload.

Instance Attribute Details

#bucket ⇒ `String`

Name of the bucket to which the multipart upload 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 Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see

Using access points][1: 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 with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see

Using Amazon S3 on Outposts][2: in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 1314

class CompleteMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :multipart_upload,
  :upload_id,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :request_payer,
  :expected_bucket_owner,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#checksum_crc32 ⇒ `String`

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 1314

class CompleteMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :multipart_upload,
  :upload_id,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :request_payer,
  :expected_bucket_owner,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#checksum_crc32c ⇒ `String`

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 1314

class CompleteMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :multipart_upload,
  :upload_id,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :request_payer,
  :expected_bucket_owner,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#checksum_sha1 ⇒ `String`

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 1314

class CompleteMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :multipart_upload,
  :upload_id,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :request_payer,
  :expected_bucket_owner,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#checksum_sha256 ⇒ `String`

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 1314

class CompleteMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :multipart_upload,
  :upload_id,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :request_payer,
  :expected_bucket_owner,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#expected_bucket_owner ⇒ `String`

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 1314

class CompleteMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :multipart_upload,
  :upload_id,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :request_payer,
  :expected_bucket_owner,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#key ⇒ `String`

Object key for which the multipart upload was initiated.

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 1314

class CompleteMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :multipart_upload,
  :upload_id,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :request_payer,
  :expected_bucket_owner,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#multipart_upload ⇒ `Types::CompletedMultipartUpload`

The container for the multipart upload request information.

Returns:

(Types::CompletedMultipartUpload)

# File 'lib/aws-sdk-s3/types.rb', line 1314

class CompleteMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :multipart_upload,
  :upload_id,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :request_payer,
  :expected_bucket_owner,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#request_payer ⇒ `String`

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 1314

class CompleteMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :multipart_upload,
  :upload_id,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :request_payer,
  :expected_bucket_owner,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#sse_customer_algorithm ⇒ `String`

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see [Protecting data using SSE-C keys] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 1314

class CompleteMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :multipart_upload,
  :upload_id,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :request_payer,
  :expected_bucket_owner,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#sse_customer_key ⇒ `String`

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see [Protecting data using SSE-C keys] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 1314

class CompleteMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :multipart_upload,
  :upload_id,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :request_payer,
  :expected_bucket_owner,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#sse_customer_key_md5 ⇒ `String`

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see [Protecting data using SSE-C keys] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 1314

class CompleteMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :multipart_upload,
  :upload_id,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :request_payer,
  :expected_bucket_owner,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#upload_id ⇒ `String`

ID for the initiated multipart upload.

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 1314

class CompleteMultipartUploadRequest < Struct.new(
  :bucket,
  :key,
  :multipart_upload,
  :upload_id,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :request_payer,
  :expected_bucket_owner,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

Class: Aws::S3::Types::CompleteMultipartUploadRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

#checksum_crc32 ⇒ String

#checksum_crc32c ⇒ String

#checksum_sha1 ⇒ String

#checksum_sha256 ⇒ String

#expected_bucket_owner ⇒ String

#key ⇒ String

#multipart_upload ⇒ Types::CompletedMultipartUpload

#request_payer ⇒ String

#sse_customer_algorithm ⇒ String

#sse_customer_key ⇒ String

#sse_customer_key_md5 ⇒ String

#upload_id ⇒ String

#bucket ⇒ `String`

#checksum_crc32 ⇒ `String`

#checksum_crc32c ⇒ `String`

#checksum_sha1 ⇒ `String`

#checksum_sha256 ⇒ `String`

#expected_bucket_owner ⇒ `String`

#key ⇒ `String`

#multipart_upload ⇒ `Types::CompletedMultipartUpload`

#request_payer ⇒ `String`

#sse_customer_algorithm ⇒ `String`

#sse_customer_key ⇒ `String`

#sse_customer_key_md5 ⇒ `String`

#upload_id ⇒ `String`