/AWS1/CL_GLAJOBPARAMETERS

Provides options for defining a job.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_format TYPE /AWS1/GLASTRING /AWS1/GLASTRING

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".

iv_type TYPE /AWS1/GLASTRING /AWS1/GLASTRING

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".

iv_archiveid TYPE /AWS1/GLASTRING /AWS1/GLASTRING

The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.

iv_description TYPE /AWS1/GLASTRING /AWS1/GLASTRING

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.

iv_snstopic TYPE /AWS1/GLASTRING /AWS1/GLASTRING

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.

iv_retrievalbyterange TYPE /AWS1/GLASTRING /AWS1/GLASTRING

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.

iv_tier TYPE /AWS1/GLASTRING /AWS1/GLASTRING

The tier to use for a select or an archive retrieval job. Valid values are Expedited, Standard, or Bulk. Standard is the default.

io_invretrievalparameters TYPE REF TO /AWS1/CL_GLAINVRETRIEVALJOBINP /AWS1/CL_GLAINVRETRIEVALJOBINP

Input parameters used for range inventory retrieval.

io_selectparameters TYPE REF TO /AWS1/CL_GLASELECTPARAMETERS /AWS1/CL_GLASELECTPARAMETERS

Contains the parameters that define a job.

io_outputlocation TYPE REF TO /AWS1/CL_GLAOUTPUTLOCATION /AWS1/CL_GLAOUTPUTLOCATION

Contains information about the location where the select job results are stored.

---

Queryable Attributes

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".

Accessible with the following methods

Method	Description
GET_FORMAT()	Getter for FORMAT, with configurable default
ASK_FORMAT()	Getter for FORMAT w/ exceptions if field has no value
HAS_FORMAT()	Determine if FORMAT has a value

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".

Accessible with the following methods

Method	Description
GET_TYPE()	Getter for TYPE, with configurable default
ASK_TYPE()	Getter for TYPE w/ exceptions if field has no value
HAS_TYPE()	Determine if TYPE has a value

ArchiveId

The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.

Accessible with the following methods

Method	Description
GET_ARCHIVEID()	Getter for ARCHIVEID, with configurable default
ASK_ARCHIVEID()	Getter for ARCHIVEID w/ exceptions if field has no value
HAS_ARCHIVEID()	Determine if ARCHIVEID has a value

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.

Accessible with the following methods

Method	Description
GET_DESCRIPTION()	Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION()	Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION()	Determine if DESCRIPTION has a value

SNSTopic

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.

Accessible with the following methods

Method	Description
GET_SNSTOPIC()	Getter for SNSTOPIC, with configurable default
ASK_SNSTOPIC()	Getter for SNSTOPIC w/ exceptions if field has no value
HAS_SNSTOPIC()	Determine if SNSTOPIC has a value

RetrievalByteRange

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.

Accessible with the following methods

Method	Description
GET_RETRIEVALBYTERANGE()	Getter for RETRIEVALBYTERANGE, with configurable default
ASK_RETRIEVALBYTERANGE()	Getter for RETRIEVALBYTERANGE w/ exceptions if field has no
HAS_RETRIEVALBYTERANGE()	Determine if RETRIEVALBYTERANGE has a value

Tier

The tier to use for a select or an archive retrieval job. Valid values are Expedited, Standard, or Bulk. Standard is the default.

Accessible with the following methods

Method	Description
GET_TIER()	Getter for TIER, with configurable default
ASK_TIER()	Getter for TIER w/ exceptions if field has no value
HAS_TIER()	Determine if TIER has a value

InventoryRetrievalParameters

Input parameters used for range inventory retrieval.

Accessible with the following methods

Method	Description
GET_INVRETRIEVALPARAMETERS()	Getter for INVENTORYRETRIEVALPARAMETERS

SelectParameters

Contains the parameters that define a job.

Accessible with the following methods

Method	Description
GET_SELECTPARAMETERS()	Getter for SELECTPARAMETERS

OutputLocation

Contains information about the location where the select job results are stored.

Accessible with the following methods

Method	Description
GET_OUTPUTLOCATION()	Getter for OUTPUTLOCATION