class Aws::S3::Types::RestoreRequest

Container for restore job parameters.

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

@!attribute [rw] days

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.
@return [Integer]

@!attribute [rw] glacier_job_parameters

S3 Glacier related parameters pertaining to this job. Do not use
with restores that specify `OutputLocation`.
@return [Types::GlacierJobParameters]

@!attribute [rw] type

Type of restore request.
@return [String]

@!attribute [rw] tier

Retrieval tier at which the restore will be processed.
@return [String]

@!attribute [rw] description

The optional description for the job.
@return [String]

@!attribute [rw] select_parameters

Describes the parameters for Select job types.
@return [Types::SelectParameters]

@!attribute [rw] output_location

Describes the location where the restore job's output is stored.
@return [Types::OutputLocation]

@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreRequest AWS API Documentation

Constants

SENSITIVE