Class: Aws::S3::Types::RestoreObjectRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::RestoreObjectRequest
- 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 to restore.
-
#checksum_algorithm ⇒ String
Indicates the algorithm used to create the checksum for the object when you use the SDK.
-
#expected_bucket_owner ⇒ String
The account ID of the expected bucket owner.
-
#key ⇒ String
Object key for which the action was initiated.
-
#request_payer ⇒ String
Confirms that the requester knows that they will be charged for the request.
-
#restore_request ⇒ Types::RestoreRequest
Container for restore job parameters.
-
#version_id ⇒ String
VersionId used to reference a specific version of the object.
Instance Attribute Details
#bucket ⇒ String
The bucket name containing the object to restore.
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.
S3 on Outposts - When you use this action with Amazon S3 on
Outposts, you must direct requests to the S3 on Outposts hostname.
The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
.
When you use this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts access point ARN in place of
the bucket name. For more information about S3 on Outposts ARNs, see
What is S3 on Outposts? in the Amazon S3 User Guide.
15218 15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 15218 class RestoreObjectRequest < Struct.new( :bucket, :key, :version_id, :restore_request, :request_payer, :checksum_algorithm, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#checksum_algorithm ⇒ String
Indicates the algorithm used to create the checksum for the object
when you use the SDK. This header will not provide any additional
functionality if you don't use the SDK. When you send this header,
there must be a corresponding x-amz-checksum
or x-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP
status code 400 Bad Request
. For more information, see Checking
object integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm
parameter.
15218 15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 15218 class RestoreObjectRequest < Struct.new( :bucket, :key, :version_id, :restore_request, :request_payer, :checksum_algorithm, :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).
15218 15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 15218 class RestoreObjectRequest < Struct.new( :bucket, :key, :version_id, :restore_request, :request_payer, :checksum_algorithm, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#key ⇒ String
Object key for which the action was initiated.
15218 15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 15218 class RestoreObjectRequest < Struct.new( :bucket, :key, :version_id, :restore_request, :request_payer, :checksum_algorithm, :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.
15218 15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 15218 class RestoreObjectRequest < Struct.new( :bucket, :key, :version_id, :restore_request, :request_payer, :checksum_algorithm, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#restore_request ⇒ Types::RestoreRequest
Container for restore job parameters.
15218 15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 15218 class RestoreObjectRequest < Struct.new( :bucket, :key, :version_id, :restore_request, :request_payer, :checksum_algorithm, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#version_id ⇒ String
VersionId used to reference a specific version of the object.
15218 15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 15218 class RestoreObjectRequest < Struct.new( :bucket, :key, :version_id, :restore_request, :request_payer, :checksum_algorithm, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |