Skip to content

/AWS1/IF_TBD=>CREATEMONITOR()

About CreateMonitor

Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job's results.

Method Signature

METHODS /AWS1/IF_TBD~CREATEMONITOR
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/TBDCLIENTTOKEN OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/TBDRESOURCENAME OPTIONAL
    !IV_IDENTITYCENTERINSTANCEARN TYPE /AWS1/TBDIDCENTERINSTANCEARN OPTIONAL
    !IV_IDENTITYCENTERREGION TYPE /AWS1/TBDREGION OPTIONAL
    !IV_SUBDOMAIN TYPE /AWS1/TBDSUBDOMAIN OPTIONAL
    !IV_ROLEARN TYPE /AWS1/TBDIAMROLEARN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_TBDTAGS_W=>TT_TAGS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tbdcreatemonitorrsp
  RAISING
    /AWS1/CX_TBDACCESSDENIEDEX
    /AWS1/CX_TBDINTERNALSERVERER00
    /AWS1/CX_TBDSERVICEQUOTAEXCDEX
    /AWS1/CX_TBDTHROTTLINGEX
    /AWS1/CX_TBDVALIDATIONEX
    /AWS1/CX_TBDCLIENTEXC
    /AWS1/CX_TBDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_displayname TYPE /AWS1/TBDRESOURCENAME /AWS1/TBDRESOURCENAME

The name that you give the monitor that is displayed in the Deadline Cloud console.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

iv_identitycenterinstancearn TYPE /AWS1/TBDIDCENTERINSTANCEARN /AWS1/TBDIDCENTERINSTANCEARN

The Amazon Resource Name of the IAM Identity Center instance that authenticates monitor users.

iv_subdomain TYPE /AWS1/TBDSUBDOMAIN /AWS1/TBDSUBDOMAIN

The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

iv_rolearn TYPE /AWS1/TBDIAMROLEARN /AWS1/TBDIAMROLEARN

The Amazon Resource Name of the IAM role that the monitor uses to connect to Deadline Cloud. Every user that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud resources.

Optional arguments:

iv_clienttoken TYPE /AWS1/TBDCLIENTTOKEN /AWS1/TBDCLIENTTOKEN

The unique token which the server uses to recognize retries of the same request.

iv_identitycenterregion TYPE /AWS1/TBDREGION /AWS1/TBDREGION

The AWS region where IAM Identity Center is enabled. Required when Identity Center is in a different region than the monitor.

it_tags TYPE /AWS1/CL_TBDTAGS_W=>TT_TAGS TT_TAGS

The tags to add to your monitor. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

RETURNING

oo_output TYPE REF TO /aws1/cl_tbdcreatemonitorrsp /AWS1/CL_TBDCREATEMONITORRSP

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->createmonitor(
  it_tags = VALUE /aws1/cl_tbdtags_w=>tt_tags(
    (
      VALUE /aws1/cl_tbdtags_w=>ts_tags_maprow(
        key = |string|
        value = new /aws1/cl_tbdtags_w( |string| )
      )
    )
  )
  iv_clienttoken = |string|
  iv_displayname = |string|
  iv_identitycenterinstancearn = |string|
  iv_identitycenterregion = |string|
  iv_rolearn = |string|
  iv_subdomain = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_monitorid = lo_result->get_monitorid( ).
  lv_identitycenterapplicati = lo_result->get_idcenterapplicationarn( ).
ENDIF.