class Aws::Glacier::Types::JobParameters
Provides options for defining a job.
@note When making an API call, you may pass JobParameters
data as a hash: { format: "string", type: "string", archive_id: "string", description: "string", sns_topic: "string", retrieval_byte_range: "string", tier: "string", inventory_retrieval_parameters: { start_date: Time.now, end_date: Time.now, limit: "string", marker: "string", }, select_parameters: { input_serialization: { csv: { file_header_info: "USE", # accepts USE, IGNORE, NONE comments: "string", quote_escape_character: "string", record_delimiter: "string", field_delimiter: "string", quote_character: "string", }, }, expression_type: "SQL", # accepts SQL expression: "string", output_serialization: { csv: { quote_fields: "ALWAYS", # accepts ALWAYS, ASNEEDED quote_escape_character: "string", record_delimiter: "string", field_delimiter: "string", quote_character: "string", }, }, }, output_location: { s3: { bucket_name: "string", prefix: "string", encryption: { encryption_type: "aws:kms", # accepts aws:kms, AES256 kms_key_id: "string", kms_context: "string", }, canned_acl: "private", # accepts private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control access_control_list: [ { grantee: { type: "AmazonCustomerByEmail", # required, accepts AmazonCustomerByEmail, CanonicalUser, Group display_name: "string", uri: "string", id: "string", email_address: "string", }, permission: "FULL_CONTROL", # accepts FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP }, ], tagging: { "string" => "string", }, user_metadata: { "string" => "string", }, storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA }, }, }
@!attribute [rw] format
When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON". @return [String]
@!attribute [rw] type
The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval". @return [String]
@!attribute [rw] archive_id
The ID of the archive that you want to retrieve. This field is required only if `Type` is set to `select` or `archive-retrieval`code>. An error occurs if you specify this request parameter for an inventory retrieval job request. @return [String]
@!attribute [rw] description
The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal. @return [String]
@!attribute [rw] sns_topic
The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist. @return [String]
@!attribute [rw] retrieval_byte_range
The byte range to retrieve for an archive retrieval. in the form "*StartByteValue*-*EndByteValue*" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that *StartByteValue* must be divisible by 1 MB and *EndByteValue* plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response. An error occurs if you specify this field for an inventory retrieval job request. @return [String]
@!attribute [rw] tier
The tier to use for a select or an archive retrieval job. Valid values are `Expedited`, `Standard`, or `Bulk`. `Standard` is the default. @return [String]
@!attribute [rw] inventory_retrieval_parameters
Input parameters used for range inventory retrieval. @return [Types::InventoryRetrievalJobInput]
@!attribute [rw] select_parameters
Contains the parameters that define a job. @return [Types::SelectParameters]
@!attribute [rw] output_location
Contains information about the location where the select job results are stored. @return [Types::OutputLocation]
Constants
- SENSITIVE