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


2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2697

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

This functionality is not supported for directory buckets.

Returns:

  • (String)


2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2697

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

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

Access points are not supported by directory buckets.

Returns:

  • (String)


2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2697

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_enabledBoolean

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

This functionality is not supported for directory buckets.

Returns:

  • (Boolean)


2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2697

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_algorithmString

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

Returns:

  • (String)


2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2697

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

#keyString

Object key for which the multipart upload was initiated.

Returns:

  • (String)


2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2697

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_chargedString

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

This functionality is not supported for directory buckets.

Returns:

  • (String)


2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2697

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_encryptionString

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

For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.

Returns:

  • (String)


2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2697

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_algorithmString

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)


2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2697

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_md5String

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)


2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2697

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_contextString

If present, indicates 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.

This functionality is not supported for directory buckets.

Returns:

  • (String)


2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2697

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_idString

If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

This functionality is not supported for directory buckets.

Returns:

  • (String)


2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2697

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_idString

ID for the initiated multipart upload.

Returns:

  • (String)


2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2697

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