Class: Aws::S3::Types::CompleteMultipartUploadOutput

Inherits:

Struct

Object
Struct
Aws::S3::Types::CompleteMultipartUploadOutput

show all

Includes:: Aws::Structure

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

Overview

Constant Summary collapse

SENSITIVE =

[:ssekms_key_id]

Instance Attribute Summary collapse

#bucket ⇒ String

The name of the bucket that contains the newly created object.
#bucket_key_enabled ⇒ Boolean

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
#checksum_crc32 ⇒ String

The Base64 encoded, 32-bit ‘CRC32 checksum` of the object.
#checksum_crc32c ⇒ String

The Base64 encoded, 32-bit ‘CRC32C` checksum of the object.
#checksum_crc64nvme ⇒ 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

The Base64 encoded, 160-bit ‘SHA1` digest of the object.
#checksum_sha256 ⇒ String

The Base64 encoded, 256-bit ‘SHA256` digest of the object.
#checksum_type ⇒ String

The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects.
#etag ⇒ String

Entity tag that identifies the newly created object’s data.
#expiration ⇒ String

If the object expiration is configured, this will contain the expiration date (‘expiry-date`) and rule ID (`rule-id`).
#key ⇒ String

The object key of the newly created object.
#location ⇒ String

The URI that identifies the newly created object.
#request_charged ⇒ String

If present, indicates that the requester was successfully charged for the request.
#server_side_encryption ⇒ String

The server-side encryption algorithm used when storing this object in Amazon S3.
#ssekms_key_id ⇒ String

If present, indicates the ID of the KMS key that was used for object encryption.
#version_id ⇒ String

Version ID of the newly created object, in case the bucket has versioning turned on.

Instance Attribute Details

#bucket ⇒ `String`

The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used.

<note markdown=“1”> Access points are not supported by directory buckets.

</note>

Returns:

(String)

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

class CompleteMultipartUploadOutput < Struct.new(
  :location,
  :bucket,
  :key,
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :server_side_encryption,
  :version_id,
  :ssekms_key_id,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#bucket_key_enabled ⇒ `Boolean`

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

Returns:

(Boolean)

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

class CompleteMultipartUploadOutput < Struct.new(
  :location,
  :bucket,
  :key,
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :server_side_encryption,
  :version_id,
  :ssekms_key_id,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#checksum_crc32 ⇒ `String`

The Base64 encoded, 32-bit ‘CRC32 checksum` of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it’s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see [ Checking object integrity] in the *Amazon S3 User Guide*.

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

Returns:

(String)

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

class CompleteMultipartUploadOutput < Struct.new(
  :location,
  :bucket,
  :key,
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :server_side_encryption,
  :version_id,
  :ssekms_key_id,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#checksum_crc32c ⇒ `String`

The Base64 encoded, 32-bit ‘CRC32C` checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it’s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see [ Checking object integrity] in the *Amazon S3 User Guide*.

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

Returns:

(String)

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

class CompleteMultipartUploadOutput < Struct.new(
  :location,
  :bucket,
  :key,
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :server_side_encryption,
  :version_id,
  :ssekms_key_id,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#checksum_crc64nvme ⇒ `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, 64-bit ‘CRC64NVME` checksum of the object. The `CRC64NVME` checksum is always a full object checksum. 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 1092

class CompleteMultipartUploadOutput < Struct.new(
  :location,
  :bucket,
  :key,
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :server_side_encryption,
  :version_id,
  :ssekms_key_id,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#checksum_sha1 ⇒ `String`

The Base64 encoded, 160-bit ‘SHA1` digest of the object. This checksum is only present if the checksum was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it’s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see [ Checking object integrity] in the *Amazon S3 User Guide*.

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

Returns:

(String)

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

class CompleteMultipartUploadOutput < Struct.new(
  :location,
  :bucket,
  :key,
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :server_side_encryption,
  :version_id,
  :ssekms_key_id,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#checksum_sha256 ⇒ `String`

The Base64 encoded, 256-bit ‘SHA256` digest of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it’s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see [ Checking object integrity] in the *Amazon S3 User Guide*.

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

Returns:

(String)

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

class CompleteMultipartUploadOutput < Struct.new(
  :location,
  :bucket,
  :key,
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :server_side_encryption,
  :version_id,
  :ssekms_key_id,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#checksum_type ⇒ `String`

The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum type that was specified during the ‘CreateMultipartUpload` request. 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 1092

class CompleteMultipartUploadOutput < Struct.new(
  :location,
  :bucket,
  :key,
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :server_side_encryption,
  :version_id,
  :ssekms_key_id,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#etag ⇒ `String`

Entity tag that identifies the newly created object’s data. Objects with different object data will have different entity tags. The entity tag is an opaque string. The entity tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters and/or will consist of less than 32 or more than 32 hexadecimal digits. For more information about how the entity tag is calculated, 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 1092

class CompleteMultipartUploadOutput < Struct.new(
  :location,
  :bucket,
  :key,
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :server_side_encryption,
  :version_id,
  :ssekms_key_id,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#expiration ⇒ `String`

If the object expiration is configured, this will contain the expiration date (‘expiry-date`) and rule ID (`rule-id`). The value of `rule-id` is URL-encoded.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

(String)

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

class CompleteMultipartUploadOutput < Struct.new(
  :location,
  :bucket,
  :key,
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :server_side_encryption,
  :version_id,
  :ssekms_key_id,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#key ⇒ `String`

The object key of the newly created object.

Returns:

(String)

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

class CompleteMultipartUploadOutput < Struct.new(
  :location,
  :bucket,
  :key,
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :server_side_encryption,
  :version_id,
  :ssekms_key_id,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#location ⇒ `String`

The URI that identifies the newly created object.

Returns:

(String)

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

class CompleteMultipartUploadOutput < Struct.new(
  :location,
  :bucket,
  :key,
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :server_side_encryption,
  :version_id,
  :ssekms_key_id,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#request_charged ⇒ `String`

If present, indicates that the requester was successfully charged for the request. For more information, see [Using Requester Pays buckets for storage transfers and usage] in the *Amazon Simple Storage Service user guide*.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html

Returns:

(String)

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

class CompleteMultipartUploadOutput < Struct.new(
  :location,
  :bucket,
  :key,
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :server_side_encryption,
  :version_id,
  :ssekms_key_id,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#server_side_encryption ⇒ `String`

The server-side encryption algorithm used when storing this object in Amazon S3.

<note markdown=“1”> When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is ‘aws:fsx`.

</note>

Returns:

(String)

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

class CompleteMultipartUploadOutput < Struct.new(
  :location,
  :bucket,
  :key,
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :server_side_encryption,
  :version_id,
  :ssekms_key_id,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#ssekms_key_id ⇒ `String`

If present, indicates the ID of the KMS key that was used for object encryption.

Returns:

(String)

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

class CompleteMultipartUploadOutput < Struct.new(
  :location,
  :bucket,
  :key,
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :server_side_encryption,
  :version_id,
  :ssekms_key_id,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#version_id ⇒ `String`

Version ID of the newly created object, in case the bucket has versioning turned on.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

(String)

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

class CompleteMultipartUploadOutput < Struct.new(
  :location,
  :bucket,
  :key,
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :server_side_encryption,
  :version_id,
  :ssekms_key_id,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

Class: Aws::S3::Types::CompleteMultipartUploadOutput

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

#bucket_key_enabled ⇒ Boolean

#checksum_crc32 ⇒ String

#checksum_crc32c ⇒ String

#checksum_crc64nvme ⇒ String

#checksum_sha1 ⇒ String

#checksum_sha256 ⇒ String

#checksum_type ⇒ String

#etag ⇒ String

#expiration ⇒ String

#key ⇒ String

#location ⇒ String

#request_charged ⇒ String

#server_side_encryption ⇒ String

#ssekms_key_id ⇒ String

#version_id ⇒ String

#bucket ⇒ `String`

#bucket_key_enabled ⇒ `Boolean`

#checksum_crc32 ⇒ `String`

#checksum_crc32c ⇒ `String`

#checksum_crc64nvme ⇒ `String`

#checksum_sha1 ⇒ `String`

#checksum_sha256 ⇒ `String`

#checksum_type ⇒ `String`

#etag ⇒ `String`

#expiration ⇒ `String`

#key ⇒ `String`

#location ⇒ `String`

#request_charged ⇒ `String`

#server_side_encryption ⇒ `String`

#ssekms_key_id ⇒ `String`

#version_id ⇒ `String`