Skip to content

/AWS1/IF_SNB=>UPDATEJOB()

About UpdateJob

While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.

Method Signature

METHODS /AWS1/IF_SNB~UPDATEJOB
  IMPORTING
    !IV_JOBID TYPE /AWS1/SNBJOBID OPTIONAL
    !IV_ROLEARN TYPE /AWS1/SNBROLEARN OPTIONAL
    !IO_NOTIFICATION TYPE REF TO /AWS1/CL_SNBNOTIFICATION OPTIONAL
    !IO_RESOURCES TYPE REF TO /AWS1/CL_SNBJOBRESOURCE OPTIONAL
    !IO_ONDEVICESERVICECONF TYPE REF TO /AWS1/CL_SNBONDEVICESVCCONF OPTIONAL
    !IV_ADDRESSID TYPE /AWS1/SNBADDRESSID OPTIONAL
    !IV_SHIPPINGOPTION TYPE /AWS1/SNBSHIPPINGOPTION OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/SNBSTRING OPTIONAL
    !IV_SNOWBALLCAPPREFERENCE TYPE /AWS1/SNBSNOWBALLCAPACITY OPTIONAL
    !IV_FORWARDINGADDRESSID TYPE /AWS1/SNBADDRESSID OPTIONAL
    !IO_PICKUPDETAILS TYPE REF TO /AWS1/CL_SNBPICKUPDETAILS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_snbupdatejobresult
  RAISING
    /AWS1/CX_SNBCLUSTERLIMITEXCDEX
    /AWS1/CX_SNBEC2REQUESTFAILEDEX
    /AWS1/CX_SNBINVINPCOMBINATIO00
    /AWS1/CX_SNBINVALIDJOBSTATEEX
    /AWS1/CX_SNBINVALIDRESOURCEEX
    /AWS1/CX_SNBKMSREQUESTFAILEDEX
    /AWS1/CX_SNBCLIENTEXC
    /AWS1/CX_SNBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_jobid TYPE /AWS1/SNBJOBID /AWS1/SNBJOBID

The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.

Optional arguments:

iv_rolearn TYPE /AWS1/SNBROLEARN /AWS1/SNBROLEARN

The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRoleIdentity and Access Management (IAM) API action.

io_notification TYPE REF TO /AWS1/CL_SNBNOTIFICATION /AWS1/CL_SNBNOTIFICATION

The new or updated Notification object.

io_resources TYPE REF TO /AWS1/CL_SNBJOBRESOURCE /AWS1/CL_SNBJOBRESOURCE

The updated JobResource object, or the updated JobResource object.

io_ondeviceserviceconf TYPE REF TO /AWS1/CL_SNBONDEVICESVCCONF /AWS1/CL_SNBONDEVICESVCCONF

Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon Web Services Storage Gateway service Tape Gateway type.

iv_addressid TYPE /AWS1/SNBADDRESSID /AWS1/SNBADDRESSID

The ID of the updated Address object.

iv_shippingoption TYPE /AWS1/SNBSHIPPINGOPTION /AWS1/SNBSHIPPINGOPTION

The updated shipping option value of this job's ShippingDetails object.

iv_description TYPE /AWS1/SNBSTRING /AWS1/SNBSTRING

The updated description of this job's JobMetadata object.

iv_snowballcappreference TYPE /AWS1/SNBSNOWBALLCAPACITY /AWS1/SNBSNOWBALLCAPACITY

The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US regions.

For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

iv_forwardingaddressid TYPE /AWS1/SNBADDRESSID /AWS1/SNBADDRESSID

The updated ID for the forwarding address for a job. This field is not supported in most regions.

io_pickupdetails TYPE REF TO /AWS1/CL_SNBPICKUPDETAILS /AWS1/CL_SNBPICKUPDETAILS

PickupDetails

RETURNING

oo_output TYPE REF TO /aws1/cl_snbupdatejobresult /AWS1/CL_SNBUPDATEJOBRESULT

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->updatejob(
  io_notification = new /aws1/cl_snbnotification(
    it_jobstatestonotify = VALUE /aws1/cl_snbjobstatelist_w=>tt_jobstatelist(
      ( new /aws1/cl_snbjobstatelist_w( |string| ) )
    )
    iv_devicepickupsnstopicarn = |string|
    iv_notifyall = ABAP_TRUE
    iv_snstopicarn = |string|
  )
  io_ondeviceserviceconf = new /aws1/cl_snbondevicesvcconf(
    io_eksondeviceservice = new /aws1/cl_snbeksondevicesvcconf(
      iv_eksanywhereversion = |string|
      iv_kubernetesversion = |string|
    )
    io_nfsondeviceservice = new /aws1/cl_snbnfsondevicesvcconf(
      iv_storagelimit = 123
      iv_storageunit = |string|
    )
    io_s3ondeviceservice = new /aws1/cl_snbs3ondevicesvcconf(
      iv_faulttolerance = 123
      iv_servicesize = 123
      iv_storagelimit = '0.1'
      iv_storageunit = |string|
    )
    io_tgwondeviceservice = new /aws1/cl_snbtgwondevicesvcconf(
      iv_storagelimit = 123
      iv_storageunit = |string|
    )
  )
  io_pickupdetails = new /aws1/cl_snbpickupdetails(
    iv_devicepickupid = |string|
    iv_email = |string|
    iv_identificationexpirdate = '20150101000000.0000000'
    iv_identificationissuingorg = |string|
    iv_identificationnumber = |string|
    iv_name = |string|
    iv_phonenumber = |string|
  )
  io_resources = new /aws1/cl_snbjobresource(
    it_ec2amiresources = VALUE /aws1/cl_snbec2amiresource=>tt_ec2amiresourcelist(
      (
        new /aws1/cl_snbec2amiresource(
          iv_amiid = |string|
          iv_snowballamiid = |string|
        )
      )
    )
    it_lambdaresources = VALUE /aws1/cl_snblambdaresource=>tt_lambdaresourcelist(
      (
        new /aws1/cl_snblambdaresource(
          it_eventtriggers = VALUE /aws1/cl_snbeventtriggerdefn=>tt_eventtriggerdefinitionlist(
            ( new /aws1/cl_snbeventtriggerdefn( |string| ) )
          )
          iv_lambdaarn = |string|
        )
      )
    )
    it_s3resources = VALUE /aws1/cl_snbs3resource=>tt_s3resourcelist(
      (
        new /aws1/cl_snbs3resource(
          io_keyrange = new /aws1/cl_snbkeyrange(
            iv_beginmarker = |string|
            iv_endmarker = |string|
          )
          it_targetondeviceservices = VALUE /aws1/cl_snbtargetondevicesvc=>tt_targetondeviceservicelist(
            (
              new /aws1/cl_snbtargetondevicesvc(
                iv_servicename = |string|
                iv_transferoption = |string|
              )
            )
          )
          iv_bucketarn = |string|
        )
      )
    )
  )
  iv_addressid = |string|
  iv_description = |string|
  iv_forwardingaddressid = |string|
  iv_jobid = |string|
  iv_rolearn = |string|
  iv_shippingoption = |string|
  iv_snowballcappreference = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.

To update a job

This action allows you to update certain parameters for a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.

DATA(lo_result) = lo_client->updatejob(
  iv_addressid = |ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b|
  iv_description = |updated-job-name|
  iv_jobid = |JID123e4567-e89b-12d3-a456-426655440000|
  iv_shippingoption = |NEXT_DAY|
  iv_snowballcappreference = |T100|
).