Class: Aws::S3::Types::RestoreRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::RestoreRequest
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-s3/types.rb
Overview
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",
},
compression_type: "NONE", # accepts NONE, GZIP
json: {
type: "DOCUMENT", # accepts DOCUMENT, LINES
},
},
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
},
},
}
Container for restore job parameters.
Instance Attribute Summary collapse
-
#days ⇒ Integer
Lifetime of the active copy in days.
-
#description ⇒ String
The optional description for the job.
-
#glacier_job_parameters ⇒ Types::GlacierJobParameters
Glacier related parameters pertaining to this job.
-
#output_location ⇒ Types::OutputLocation
Describes the location where the restore job’s output is stored.
-
#select_parameters ⇒ Types::SelectParameters
Describes the parameters for Select job types.
-
#tier ⇒ String
Glacier retrieval tier at which the restore will be processed.
-
#type ⇒ String
Type of restore request.
Instance Attribute Details
#days ⇒ Integer
Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.
7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 |
# File 'lib/aws-sdk-s3/types.rb', line 7683 class RestoreRequest < Struct.new( :days, :glacier_job_parameters, :type, :tier, :description, :select_parameters, :output_location) include Aws::Structure end |
#description ⇒ String
The optional description for the job.
7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 |
# File 'lib/aws-sdk-s3/types.rb', line 7683 class RestoreRequest < Struct.new( :days, :glacier_job_parameters, :type, :tier, :description, :select_parameters, :output_location) include Aws::Structure end |
#glacier_job_parameters ⇒ Types::GlacierJobParameters
Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.
7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 |
# File 'lib/aws-sdk-s3/types.rb', line 7683 class RestoreRequest < Struct.new( :days, :glacier_job_parameters, :type, :tier, :description, :select_parameters, :output_location) include Aws::Structure end |
#output_location ⇒ Types::OutputLocation
Describes the location where the restore job’s output is stored.
7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 |
# File 'lib/aws-sdk-s3/types.rb', line 7683 class RestoreRequest < Struct.new( :days, :glacier_job_parameters, :type, :tier, :description, :select_parameters, :output_location) include Aws::Structure end |
#select_parameters ⇒ Types::SelectParameters
Describes the parameters for Select job types.
7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 |
# File 'lib/aws-sdk-s3/types.rb', line 7683 class RestoreRequest < Struct.new( :days, :glacier_job_parameters, :type, :tier, :description, :select_parameters, :output_location) include Aws::Structure end |
#tier ⇒ String
Glacier retrieval tier at which the restore will be processed.
7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 |
# File 'lib/aws-sdk-s3/types.rb', line 7683 class RestoreRequest < Struct.new( :days, :glacier_job_parameters, :type, :tier, :description, :select_parameters, :output_location) include Aws::Structure end |
#type ⇒ String
Type of restore request.
7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 |
# File 'lib/aws-sdk-s3/types.rb', line 7683 class RestoreRequest < Struct.new( :days, :glacier_job_parameters, :type, :tier, :description, :select_parameters, :output_location) include Aws::Structure end |