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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config

Returns:

  • (Time)

1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
# File 'lib/aws-sdk-s3/types.rb', line 1942

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

1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
# File 'lib/aws-sdk-s3/types.rb', line 1942

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

#bucketString

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][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 using 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 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)

1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
# File 'lib/aws-sdk-s3/types.rb', line 1942

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

#bucket_key_enabledBoolean

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

Returns:

  • (Boolean)

1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
# File 'lib/aws-sdk-s3/types.rb', line 1942

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

#keyString

Object key for which the multipart upload was initiated.

Returns:

  • (String)

1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
# File 'lib/aws-sdk-s3/types.rb', line 1942

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

1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
# File 'lib/aws-sdk-s3/types.rb', line 1942

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

1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
# File 'lib/aws-sdk-s3/types.rb', line 1942

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

1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
# File 'lib/aws-sdk-s3/types.rb', line 1942

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

1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
# File 'lib/aws-sdk-s3/types.rb', line 1942

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

#ssekms_encryption_contextString

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)

1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
# File 'lib/aws-sdk-s3/types.rb', line 1942

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

#ssekms_key_idString

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)

1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
# File 'lib/aws-sdk-s3/types.rb', line 1942

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

#upload_idString

ID for the initiated multipart upload.

Returns:

  • (String)

1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
# File 'lib/aws-sdk-s3/types.rb', line 1942

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