Class: Aws::S3::Types::GetObjectRetentionRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::GetObjectRetentionRequest
- Defined in:
- gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#bucket ⇒ String
The bucket name containing the object whose retention settings you want to retrieve.
-
#expected_bucket_owner ⇒ String
The account ID of the expected bucket owner.
-
#key ⇒ String
The key name for the object whose retention settings you want to retrieve.
-
#request_payer ⇒ String
Confirms that the requester knows that they will be charged for the request.
-
#version_id ⇒ String
The version ID for the object whose retention settings you want to retrieve.
Instance Attribute Details
#bucket ⇒ String
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 in the Amazon S3 User Guide.
7757 7758 7759 7760 7761 7762 7763 7764 7765 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7757 class GetObjectRetentionRequest < Struct.new( :bucket, :key, :version_id, :request_payer, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#expected_bucket_owner ⇒ String
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).
7757 7758 7759 7760 7761 7762 7763 7764 7765 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7757 class GetObjectRetentionRequest < Struct.new( :bucket, :key, :version_id, :request_payer, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#key ⇒ String
The key name for the object whose retention settings you want to retrieve.
7757 7758 7759 7760 7761 7762 7763 7764 7765 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7757 class GetObjectRetentionRequest < Struct.new( :bucket, :key, :version_id, :request_payer, :expected_bucket_owner) 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 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.
7757 7758 7759 7760 7761 7762 7763 7764 7765 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7757 class GetObjectRetentionRequest < Struct.new( :bucket, :key, :version_id, :request_payer, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#version_id ⇒ String
The version ID for the object whose retention settings you want to retrieve.
7757 7758 7759 7760 7761 7762 7763 7764 7765 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7757 class GetObjectRetentionRequest < Struct.new( :bucket, :key, :version_id, :request_payer, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |