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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:ssekms_key_id, :ssekms_encryption_context]

Instance Attribute Summary

• #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 Amazon Web Services KMS (SSE-KMS).

• #checksum_algorithm ⇒ String

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

• #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 storing this object in Amazon S3 (for example, AES256, aws:kms).

• #sse_customer_algorithm ⇒ String

  If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm 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 round-trip message integrity verification of the customer-provided encryption key.

• #ssekms_encryption_context ⇒ String

  If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption.

• #ssekms_key_id ⇒ String

  If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

• #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 Policy.

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

Returns:

• (Time)

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

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)
  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.

Returns:

• (String)

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

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)
  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.

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 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 in the Amazon S3 User Guide.

Returns:

• (String)

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

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)
  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 Amazon Web Services KMS (SSE-KMS).

Returns:

• (Boolean)

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

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)
  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 2388

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)
  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 2388

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)
  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.

Returns:

• (String)

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

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)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#server_side_encryption ⇒ String

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Returns:

• (String)

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

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)
  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 confirming the encryption algorithm used.

Returns:

• (String)

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

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)
  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 round-trip message integrity verification of the customer-provided encryption key.

Returns:

• (String)

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

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)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#ssekms_encryption_context ⇒ String

If present, specifies the Amazon Web Services 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.

Returns:

• (String)

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

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)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#ssekms_key_id ⇒ String

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

Returns:

• (String)

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

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)
  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 2388

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)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end