Class: Aws::S3::Types::PutObjectOutput

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::PutObjectOutput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:ssekms_key_id, :ssekms_encryption_context]

Instance Attribute Summary

• #bucket_key_enabled ⇒ Boolean

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

• #checksum_crc32 ⇒ String

  The base64-encoded, 32-bit CRC32 checksum of the object.

• #checksum_crc32c ⇒ String

  The base64-encoded, 32-bit CRC32C checksum of the object.

• #checksum_sha1 ⇒ String

  The base64-encoded, 160-bit SHA-1 digest of the object.

• #checksum_sha256 ⇒ String

  The base64-encoded, 256-bit SHA-256 digest of the object.

• #etag ⇒ String

  Entity tag for the uploaded object.

• #expiration ⇒ String

  If the expiration is configured for the object (see [PutBucketLifecycleConfiguration]), the response includes this header.

• #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`, `aws:kms:dsse`).

• #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 ‘x-amz-server-side-encryption` has a valid value of `aws:kms` or `aws:kms:dsse`, this header specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

• #version_id ⇒ String

  Version of the object.

Instance Attribute Details

#bucket_key_enabled ⇒ Boolean

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

Returns:

• (Boolean)

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

class PutObjectOutput < Struct.new(
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :server_side_encryption,
  :version_id,
  :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

#checksum_crc32 ⇒ String

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see [ Checking object integrity] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums

Returns:

• (String)

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

class PutObjectOutput < Struct.new(
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :server_side_encryption,
  :version_id,
  :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

#checksum_crc32c ⇒ String

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see [ Checking object integrity] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums

Returns:

• (String)

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

class PutObjectOutput < Struct.new(
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :server_side_encryption,
  :version_id,
  :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

#checksum_sha1 ⇒ String

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see [ Checking object integrity] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums

Returns:

• (String)

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

class PutObjectOutput < Struct.new(
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :server_side_encryption,
  :version_id,
  :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

#checksum_sha256 ⇒ String

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see [ Checking object integrity] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums

Returns:

• (String)

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

class PutObjectOutput < Struct.new(
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :server_side_encryption,
  :version_id,
  :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

#etag ⇒ String

Entity tag for the uploaded object.

Returns:

• (String)

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

class PutObjectOutput < Struct.new(
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :server_side_encryption,
  :version_id,
  :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

#expiration ⇒ String

If the expiration is configured for the object (see [PutBucketLifecycleConfiguration]), the response includes this header. It includes the ‘expiry-date` and `rule-id` key-value pairs that provide information about object expiration. The value of the `rule-id` is URL-encoded.

[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html

Returns:

• (String)

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

class PutObjectOutput < Struct.new(
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :server_side_encryption,
  :version_id,
  :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_charged ⇒ String

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

Returns:

• (String)

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

class PutObjectOutput < Struct.new(
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :server_side_encryption,
  :version_id,
  :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_encryption ⇒ String

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

Returns:

• (String)

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

class PutObjectOutput < Struct.new(
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :server_side_encryption,
  :version_id,
  :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_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 'lib/aws-sdk-s3/types.rb', line 11123

class PutObjectOutput < Struct.new(
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :server_side_encryption,
  :version_id,
  :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_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 'lib/aws-sdk-s3/types.rb', line 11123

class PutObjectOutput < Struct.new(
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :server_side_encryption,
  :version_id,
  :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_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. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future ‘GetObject` or `CopyObject` operations on this object.

Returns:

• (String)

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

class PutObjectOutput < Struct.new(
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :server_side_encryption,
  :version_id,
  :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_id ⇒ String

If ‘x-amz-server-side-encryption` has a valid value of `aws:kms` or `aws:kms:dsse`, this header specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

Returns:

• (String)

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

class PutObjectOutput < Struct.new(
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :server_side_encryption,
  :version_id,
  :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

#version_id ⇒ String

Version of the object.

Returns:

• (String)

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

class PutObjectOutput < Struct.new(
  :expiration,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_sha1,
  :checksum_sha256,
  :server_side_encryption,
  :version_id,
  :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