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

Container for restore job parameters.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#daysInteger

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

The Days element is required for regular restores, and must not be provided for select requests.

Returns:

  • (Integer)


13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13754

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

#descriptionString

The optional description for the job.

Returns:

  • (String)


13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13754

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

#glacier_job_parametersTypes::GlacierJobParameters

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



13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13754

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

#output_locationTypes::OutputLocation

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



13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13754

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

#select_parametersTypes::SelectParameters

Describes the parameters for Select job types.



13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13754

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

#tierString

Retrieval tier at which the restore will be processed.

Returns:

  • (String)


13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13754

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

#typeString

Type of restore request.

Returns:

  • (String)


13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13754

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