/AWS1/CL_GLA=>INITIATEJOB()

About InitiateJob

This operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval. For more information about using this operation, see the documentation for the underlying REST API Initiate a Job.

Method Signature

IMPORTING

Required arguments:

iv_accountid TYPE /AWS1/GLASTRING /AWS1/GLASTRING

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

iv_vaultname TYPE /AWS1/GLASTRING /AWS1/GLASTRING

The name of the vault.

Optional arguments:

io_jobparameters TYPE REF TO /AWS1/CL_GLAJOBPARAMETERS /AWS1/CL_GLAJOBPARAMETERS

Provides options for specifying job information.

RETURNING

oo_output TYPE REF TO /aws1/cl_glainitiatejoboutput /AWS1/CL_GLAINITIATEJOBOUTPUT

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_gla~initiatejob(
  io_jobparameters = new /aws1/cl_glajobparameters(
    io_invretrievalparameters = new /aws1/cl_glainvretrievaljobinp(
      iv_enddate = |string|
      iv_limit = |string|
      iv_marker = |string|
      iv_startdate = |string|
    )
    io_outputlocation = new /aws1/cl_glaoutputlocation(
      io_s3 = new /aws1/cl_glas3location(
        io_encryption = new /aws1/cl_glaencryption(
          iv_encryptiontype = |string|
          iv_kmscontext = |string|
          iv_kmskeyid = |string|
        )
        it_accesscontrollist = VALUE /aws1/cl_glagrant=>tt_accesscontrolpolicylist(
          (
            new /aws1/cl_glagrant(
              io_grantee = new /aws1/cl_glagrantee(
                iv_displayname = |string|
                iv_emailaddress = |string|
                iv_id = |string|
                iv_type = |string|
                iv_uri = |string|
              )
              iv_permission = |string|
            )
          )
        )
        it_tagging = VALUE /aws1/cl_glahashmap_w=>tt_hashmap(
          (
            VALUE /aws1/cl_glahashmap_w=>ts_hashmap_maprow(
              value = new /aws1/cl_glahashmap_w( |string| )
              key = |string|
            )
          )
        )
        it_usermetadata = VALUE /aws1/cl_glahashmap_w=>tt_hashmap(
          (
            VALUE /aws1/cl_glahashmap_w=>ts_hashmap_maprow(
              value = new /aws1/cl_glahashmap_w( |string| )
              key = |string|
            )
          )
        )
        iv_bucketname = |string|
        iv_cannedacl = |string|
        iv_prefix = |string|
        iv_storageclass = |string|
      )
    )
    io_selectparameters = new /aws1/cl_glaselectparameters(
      io_inputserialization = new /aws1/cl_glainputserialization(
        io_csv = new /aws1/cl_glacsvinput(
          iv_comments = |string|
          iv_fielddelimiter = |string|
          iv_fileheaderinfo = |string|
          iv_quotecharacter = |string|
          iv_quoteescapecharacter = |string|
          iv_recorddelimiter = |string|
        )
      )
      io_outputserialization = new /aws1/cl_glaoutserialization(
        io_csv = new /aws1/cl_glacsvoutput(
          iv_fielddelimiter = |string|
          iv_quotecharacter = |string|
          iv_quoteescapecharacter = |string|
          iv_quotefields = |string|
          iv_recorddelimiter = |string|
        )
      )
      iv_expression = |string|
      iv_expressiontype = |string|
    )
    iv_archiveid = |string|
    iv_description = |string|
    iv_format = |string|
    iv_retrievalbyterange = |string|
    iv_snstopic = |string|
    iv_tier = |string|
    iv_type = |string|
  )
  iv_accountid = |string|
  iv_vaultname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_location( ).
  lv_string = lo_result->get_jobid( ).
  lv_string = lo_result->get_joboutputpath( ).
ENDIF.

To initiate an inventory-retrieval job

The example initiates an inventory-retrieval job for the vault named examplevault.

DATA(lo_result) = lo_client->/aws1/if_gla~initiatejob(
  io_jobparameters = new /aws1/cl_glajobparameters(
    iv_description = |My inventory job|
    iv_format = |CSV|
    iv_snstopic = |arn:aws:sns:us-west-2:111111111111:Glacier-InventoryRetrieval-topic-Example|
    iv_type = |inventory-retrieval|
  )
  iv_accountid = |-|
  iv_vaultname = |examplevault|
).