Class: Aws::S3::Types::GetObjectRetentionRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

The bucket name containing the object whose retention settings you want to retrieve.

**Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html

Returns:

  • (String)


7475
7476
7477
7478
7479
7480
7481
7482
7483
# File 'lib/aws-sdk-s3/types.rb', line 7475

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

#expected_bucket_ownerString

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

  • (String)


7475
7476
7477
7478
7479
7480
7481
7482
7483
# File 'lib/aws-sdk-s3/types.rb', line 7475

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

#keyString

The key name for the object whose retention settings you want to retrieve.

Returns:

  • (String)


7475
7476
7477
7478
7479
7480
7481
7482
7483
# File 'lib/aws-sdk-s3/types.rb', line 7475

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

#request_payerString

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 corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

  • (String)


7475
7476
7477
7478
7479
7480
7481
7482
7483
# File 'lib/aws-sdk-s3/types.rb', line 7475

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

#version_idString

The version ID for the object whose retention settings you want to retrieve.

Returns:

  • (String)


7475
7476
7477
7478
7479
7480
7481
7482
7483
# File 'lib/aws-sdk-s3/types.rb', line 7475

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