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

Inherits:
Struct
  • Object
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

Instance Attribute Details

#abort_dateTime

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)


1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1869

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

#abort_rule_idString

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)


1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1869

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

#bucketString

The name of the bucket to which the multipart upload was initiated.

When using this API 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 operation with an access point through the AWS 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 Simple Storage Service Developer Guide.

When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

Returns:

  • (String)


1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1869

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

#keyString

Object key for which the multipart upload was initiated.

Returns:

  • (String)


1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1869

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

#request_chargedString

If present, indicates that the requester was successfully charged for the request.

Returns:

  • (String)


1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1869

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

#server_side_encryptionString

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

Returns:

  • (String)


1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1869

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

#sse_customer_algorithmString

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)


1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1869

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

#sse_customer_key_md5String

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)


1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1869

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

#ssekms_encryption_contextString

If present, specifies the AWS 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)


1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1869

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

#ssekms_key_idString

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.

Returns:

  • (String)


1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1869

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

#upload_idString

ID for the initiated multipart upload.

Returns:

  • (String)


1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 1869

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