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

Class: Aws::S3::Types::RestoreRequest

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 RestoreRequest data as a hash:

{
  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
    },
  },
}

Container for restore job parameters.

Instance Attribute Summary collapse

Instance Attribute Details

#daysInteger

Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

Returns:

  • (Integer)


7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7571

class RestoreRequest < Struct.new(
  :days,
  :glacier_job_parameters,
  :type,
  :tier,
  :description,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#descriptionString

The optional description for the job.

Returns:

  • (String)


7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7571

class RestoreRequest < Struct.new(
  :days,
  :glacier_job_parameters,
  :type,
  :tier,
  :description,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#glacier_job_parametersTypes::GlacierJobParameters

Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.



7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7571

class RestoreRequest < Struct.new(
  :days,
  :glacier_job_parameters,
  :type,
  :tier,
  :description,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#output_locationTypes::OutputLocation

Describes the location where the restore job's output is stored.



7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7571

class RestoreRequest < Struct.new(
  :days,
  :glacier_job_parameters,
  :type,
  :tier,
  :description,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#select_parametersTypes::SelectParameters

Describes the parameters for Select job types.



7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7571

class RestoreRequest < Struct.new(
  :days,
  :glacier_job_parameters,
  :type,
  :tier,
  :description,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#tierString

Glacier retrieval tier at which the restore will be processed.

Returns:

  • (String)


7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7571

class RestoreRequest < Struct.new(
  :days,
  :glacier_job_parameters,
  :type,
  :tier,
  :description,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#typeString

Type of restore request.

Returns:

  • (String)


7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7571

class RestoreRequest < Struct.new(
  :days,
  :glacier_job_parameters,
  :type,
  :tier,
  :description,
  :select_parameters,
  :output_location)
  include Aws::Structure
end