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

Class: Aws::Glacier::Types::InitiateJobInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing InitiateJobInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  account_id: "string", # required
  vault_name: "string", # required
  job_parameters: {
    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
      },
    },
  },
}

Provides options for initiating an Amazon Glacier job.

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single \'-\' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (\'-\') in the ID.

Returns:

  • (String)

    The AccountId value is the AWS account ID of the account that owns the vault.

#job_parametersTypes::JobParameters

Provides options for specifying job information.

Returns:

#vault_nameString

The name of the vault.

Returns:

  • (String)

    The name of the vault.