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

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

Overview

Note:

When making an API call, you may pass RestoreObjectRequest data as a hash:

{
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  version_id: "ObjectVersionId",
  restore_request: {
    days: 1,
    glacier_job_parameters: {
      tier: "Standard", # required, accepts Standard, Bulk, Expedited
    },
    type: "SELECT", # accepts SELECT
    tier: "Standard", # accepts Standard, Bulk, Expedited
    description: "Description",
    select_parameters: {
      input_serialization: { # required
        csv: {
          file_header_info: "USE", # accepts USE, IGNORE, NONE
          comments: "Comments",
          quote_escape_character: "QuoteEscapeCharacter",
          record_delimiter: "RecordDelimiter",
          field_delimiter: "FieldDelimiter",
          quote_character: "QuoteCharacter",
          allow_quoted_record_delimiter: false,
        },
        compression_type: "NONE", # accepts NONE, GZIP, BZIP2
        json: {
          type: "DOCUMENT", # accepts DOCUMENT, LINES
        },
        parquet: {
        },
      },
      expression_type: "SQL", # required, accepts SQL
      expression: "Expression", # required
      output_serialization: { # required
        csv: {
          quote_fields: "ALWAYS", # accepts ALWAYS, ASNEEDED
          quote_escape_character: "QuoteEscapeCharacter",
          record_delimiter: "RecordDelimiter",
          field_delimiter: "FieldDelimiter",
          quote_character: "QuoteCharacter",
        },
        json: {
          record_delimiter: "RecordDelimiter",
        },
      },
    },
    output_location: {
      s3: {
        bucket_name: "BucketName", # required
        prefix: "LocationPrefix", # required
        encryption: {
          encryption_type: "AES256", # required, accepts AES256, aws:kms
          kms_key_id: "SSEKMSKeyId",
          kms_context: "KMSContext",
        },
        canned_acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
        access_control_list: [
          {
            grantee: {
              display_name: "DisplayName",
              email_address: "EmailAddress",
              id: "ID",
              type: "CanonicalUser", # required, accepts CanonicalUser, AmazonCustomerByEmail, Group
              uri: "URI",
            },
            permission: "FULL_CONTROL", # accepts FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP
          },
        ],
        tagging: {
          tag_set: [ # required
            {
              key: "ObjectKey", # required
              value: "Value", # required
            },
          ],
        },
        user_metadata: [
          {
            name: "MetadataKey",
            value: "MetadataValue",
          },
        ],
        storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR
      },
    },
  },
  request_payer: "requester", # accepts requester
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
  expected_bucket_owner: "AccountId",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

The bucket name containing the object to restore.

When using this action with an access point, 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*.

When using 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 using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see

Using Amazon 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)

15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
# File 'lib/aws-sdk-s3/types.rb', line 15148

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 using the SDK. This header will not provide any additional functionality if not using the SDK. When sending 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)

15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
# File 'lib/aws-sdk-s3/types.rb', line 15148

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 bucket is owned by a different account, the request fails with the HTTP status code `403 Forbidden` (access denied).

Returns:

  • (String)

15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
# File 'lib/aws-sdk-s3/types.rb', line 15148

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)

15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
# File 'lib/aws-sdk-s3/types.rb', line 15148

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

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

Returns:

  • (String)

15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
# File 'lib/aws-sdk-s3/types.rb', line 15148

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.


15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
# File 'lib/aws-sdk-s3/types.rb', line 15148

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)

15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
# File 'lib/aws-sdk-s3/types.rb', line 15148

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