Class: Aws::S3::Types::GetObjectAnnotationRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#annotation_name ⇒ String

The name of the annotation to retrieve.

Length Constraints: Minimum length of 1. Maximum length of 512 bytes.

Returns:

  • (String)


8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8522

class GetObjectAnnotationRequest < Struct.new(
  :bucket,
  :key,
  :annotation_name,
  :version_id,
  :request_payer,
  :expected_bucket_owner,
  :checksum_mode)
  SENSITIVE = []
  include Aws::Structure
end

#bucket ⇒ String

The name of the bucket that contains the object.

Returns:

  • (String)


8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8522

class GetObjectAnnotationRequest < Struct.new(
  :bucket,
  :key,
  :annotation_name,
  :version_id,
  :request_payer,
  :expected_bucket_owner,
  :checksum_mode)
  SENSITIVE = []
  include Aws::Structure
end

#checksum_mode ⇒ String

Set to ENABLED to validate the checksum of the annotation payload on retrieval.

Returns:

  • (String)


8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8522

class GetObjectAnnotationRequest < Struct.new(
  :bucket,
  :key,
  :annotation_name,
  :version_id,
  :request_payer,
  :expected_bucket_owner,
  :checksum_mode)
  SENSITIVE = []
  include Aws::Structure
end

#expected_bucket_owner ⇒ String

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with an HTTP 403 (Access Denied) error.

Returns:

  • (String)


8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8522

class GetObjectAnnotationRequest < Struct.new(
  :bucket,
  :key,
  :annotation_name,
  :version_id,
  :request_payer,
  :expected_bucket_owner,
  :checksum_mode)
  SENSITIVE = []
  include Aws::Structure
end

#key ⇒ String

The object key.

Returns:

  • (String)


8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8522

class GetObjectAnnotationRequest < Struct.new(
  :bucket,
  :key,
  :annotation_name,
  :version_id,
  :request_payer,
  :expected_bucket_owner,
  :checksum_mode)
  SENSITIVE = []
  include Aws::Structure
end

#request_payer ⇒ String

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for the corresponding charges. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

Returns:

  • (String)


8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8522

class GetObjectAnnotationRequest < Struct.new(
  :bucket,
  :key,
  :annotation_name,
  :version_id,
  :request_payer,
  :expected_bucket_owner,
  :checksum_mode)
  SENSITIVE = []
  include Aws::Structure
end

#version_id ⇒ String

The version ID of the object.

Returns:

  • (String)


8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8522

class GetObjectAnnotationRequest < Struct.new(
  :bucket,
  :key,
  :annotation_name,
  :version_id,
  :request_payer,
  :expected_bucket_owner,
  :checksum_mode)
  SENSITIVE = []
  include Aws::Structure
end