You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/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",
        },
      },
      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",
        },
      },
    },
    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
      },
    },
  },
  request_payer: "requester", # accepts requester
}

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

Returns:

  • (String)


7453
7454
7455
7456
7457
7458
7459
7460
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7453

class RestoreObjectRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :restore_request,
  :request_payer)
  include Aws::Structure
end

#keyString

Returns:

  • (String)


7453
7454
7455
7456
7457
7458
7459
7460
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7453

class RestoreObjectRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :restore_request,
  :request_payer)
  include Aws::Structure
end

#request_payerString

Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

  • (String)


7453
7454
7455
7456
7457
7458
7459
7460
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7453

class RestoreObjectRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :restore_request,
  :request_payer)
  include Aws::Structure
end

#restore_requestTypes::RestoreRequest

Container for restore job parameters.



7453
7454
7455
7456
7457
7458
7459
7460
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7453

class RestoreObjectRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :restore_request,
  :request_payer)
  include Aws::Structure
end

#version_idString

Returns:

  • (String)


7453
7454
7455
7456
7457
7458
7459
7460
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7453

class RestoreObjectRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :restore_request,
  :request_payer)
  include Aws::Structure
end