Class: Aws::S3::Types::RestoreObjectRequest

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 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][1

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?][2

in the *Amazon S3 User Guide*.

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

Returns:

  • (String)


15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
# File 'lib/aws-sdk-s3/types.rb', line 15199

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

#checksum_algorithmString

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.

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

Returns:

  • (String)


15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
# File 'lib/aws-sdk-s3/types.rb', line 15199

class RestoreObjectRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :restore_request,
  :request_payer,
  :checksum_algorithm,
  :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)


15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
# File 'lib/aws-sdk-s3/types.rb', line 15199

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

#keyString

Object key for which the action was initiated.

Returns:

  • (String)


15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
# File 'lib/aws-sdk-s3/types.rb', line 15199

class RestoreObjectRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :restore_request,
  :request_payer,
  :checksum_algorithm,
  :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)


15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
# File 'lib/aws-sdk-s3/types.rb', line 15199

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

#restore_requestTypes::RestoreRequest

Container for restore job parameters.



15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
# File 'lib/aws-sdk-s3/types.rb', line 15199

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

#version_idString

VersionId used to reference a specific version of the object.

Returns:

  • (String)


15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
# File 'lib/aws-sdk-s3/types.rb', line 15199

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