Class: Aws::S3::Types::CreateMultipartUploadOutput

Inherits:

Struct

Object
Struct
Aws::S3::Types::CreateMultipartUploadOutput

show all

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

Overview

Constant Summary collapse

SENSITIVE =

[:ssekms_key_id, :ssekms_encryption_context]

Instance Attribute Summary collapse

#abort_date ⇒ Time
If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header.
#abort_rule_id ⇒ String
This header is returned along with the x-amz-abort-date header.
#bucket ⇒ String
The name of the bucket to which the multipart upload was initiated.
#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_algorithm ⇒ String
The algorithm that was used to create a checksum of the object.
#checksum_type ⇒ String
Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value.
#key ⇒ String
Object key for which the multipart upload was initiated.
#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 you store this object in Amazon S3 or Amazon FSx.
#sse_customer_algorithm ⇒ String
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
#sse_customer_key_md5 ⇒ String
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
#ssekms_encryption_context ⇒ String
If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption.
#ssekms_key_id ⇒ String
If present, indicates the ID of the KMS key that was used for object encryption.
#upload_id ⇒ String
ID for the initiated multipart upload.

Instance Attribute Details

#abort_date ⇒ `Time`

If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header. The header indicates when the initiated multipart upload becomes eligible for an abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in the Amazon S3 User Guide.

The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines the abort action.

This functionality is not supported for directory buckets.

Returns:

(Time)

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

class CreateMultipartUploadOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#abort_rule_id ⇒ `String`

This header is returned along with the x-amz-abort-date header. It identifies the applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.

This functionality is not supported for directory buckets.

Returns:

(String)

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

class CreateMultipartUploadOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#bucket ⇒ `String`

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

Access points are not supported by directory buckets.

Returns:

(String)

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

class CreateMultipartUploadOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3096

class CreateMultipartUploadOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#checksum_algorithm ⇒ `String`

The algorithm that was used to create a checksum of the object.

Returns:

(String)

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

class CreateMultipartUploadOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#checksum_type ⇒ `String`

Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.

Returns:

(String)

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

class CreateMultipartUploadOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#key ⇒ `String`

Object key for which the multipart upload was initiated.

Returns:

(String)

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

class CreateMultipartUploadOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  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.

This functionality is not supported for directory buckets.

Returns:

(String)

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

class CreateMultipartUploadOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#server_side_encryption ⇒ `String`

The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.

When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.

Returns:

(String)

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

class CreateMultipartUploadOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#sse_customer_algorithm ⇒ `String`

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.

This functionality is not supported for directory buckets.

Returns:

(String)

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

class CreateMultipartUploadOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#sse_customer_key_md5 ⇒ `String`

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

Returns:

(String)

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

class CreateMultipartUploadOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#ssekms_encryption_context ⇒ `String`

If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.

Returns:

(String)

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

class CreateMultipartUploadOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3096

class CreateMultipartUploadOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#upload_id ⇒ `String`

ID for the initiated multipart upload.

Returns:

(String)

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

class CreateMultipartUploadOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

Class: Aws::S3::Types::CreateMultipartUploadOutput

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#abort_date ⇒ Time

#abort_rule_id ⇒ String

#bucket ⇒ String

#bucket_key_enabled ⇒ Boolean

#checksum_algorithm ⇒ String

#checksum_type ⇒ String

#key ⇒ String

#request_charged ⇒ String

#server_side_encryption ⇒ String

#sse_customer_algorithm ⇒ String

#sse_customer_key_md5 ⇒ String

#ssekms_encryption_context ⇒ String

#ssekms_key_id ⇒ String

#upload_id ⇒ String

#abort_date ⇒ `Time`

#abort_rule_id ⇒ `String`

#bucket ⇒ `String`

#bucket_key_enabled ⇒ `Boolean`

#checksum_algorithm ⇒ `String`

#checksum_type ⇒ `String`

#key ⇒ `String`

#request_charged ⇒ `String`

#server_side_encryption ⇒ `String`

#sse_customer_algorithm ⇒ `String`

#sse_customer_key_md5 ⇒ `String`

#ssekms_encryption_context ⇒ `String`

#ssekms_key_id ⇒ `String`

#upload_id ⇒ `String`