Skip to content

/AWS1/IF_BDK=>LISTCUSTOMMODELDEPLOYMENTS()

About ListCustomModelDeployments

Lists custom model deployments in your account. You can filter the results by creation time, name, status, and associated model. Use this operation to manage and monitor your custom model deployments.

We recommend using pagination to ensure that the operation returns quickly and successfully.

The following actions are related to the ListCustomModelDeployments operation:

Method Signature

METHODS /AWS1/IF_BDK~LISTCUSTOMMODELDEPLOYMENTS
  IMPORTING
    !IV_CREATEDBEFORE TYPE /AWS1/BDKTIMESTAMP OPTIONAL
    !IV_CREATEDAFTER TYPE /AWS1/BDKTIMESTAMP OPTIONAL
    !IV_NAMECONTAINS TYPE /AWS1/BDKMODELDEPLOYMENTNAME OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BDKMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BDKPAGINATIONTOKEN OPTIONAL
    !IV_SORTBY TYPE /AWS1/BDKSORTMODELSBY OPTIONAL
    !IV_SORTORDER TYPE /AWS1/BDKSORTORDER OPTIONAL
    !IV_STATUSEQUALS TYPE /AWS1/BDKCUSTMDELDEPLOYMENTS00 OPTIONAL
    !IV_MODELARNEQUALS TYPE /AWS1/BDKCUSTOMMODELARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdklstcustmdeldeplo01
  RAISING
    /AWS1/CX_BDKACCESSDENIEDEX
    /AWS1/CX_BDKINTERNALSERVEREX
    /AWS1/CX_BDKTHROTTLINGEX
    /AWS1/CX_BDKVALIDATIONEX
    /AWS1/CX_BDKCLIENTEXC
    /AWS1/CX_BDKSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_createdbefore TYPE /AWS1/BDKTIMESTAMP /AWS1/BDKTIMESTAMP

Filters deployments created before the specified date and time.

iv_createdafter TYPE /AWS1/BDKTIMESTAMP /AWS1/BDKTIMESTAMP

Filters deployments created after the specified date and time.

iv_namecontains TYPE /AWS1/BDKMODELDEPLOYMENTNAME /AWS1/BDKMODELDEPLOYMENTNAME

Filters deployments whose names contain the specified string.

iv_maxresults TYPE /AWS1/BDKMAXRESULTS /AWS1/BDKMAXRESULTS

The maximum number of results to return in a single call.

iv_nexttoken TYPE /AWS1/BDKPAGINATIONTOKEN /AWS1/BDKPAGINATIONTOKEN

The token for the next set of results. Use this token to retrieve additional results when the response is truncated.

iv_sortby TYPE /AWS1/BDKSORTMODELSBY /AWS1/BDKSORTMODELSBY

The field to sort the results by. The only supported value is CreationTime.

iv_sortorder TYPE /AWS1/BDKSORTORDER /AWS1/BDKSORTORDER

The sort order for the results. Valid values are Ascending and Descending. Default is Descending.

iv_statusequals TYPE /AWS1/BDKCUSTMDELDEPLOYMENTS00 /AWS1/BDKCUSTMDELDEPLOYMENTS00

Filters deployments by status. Valid values are CREATING, ACTIVE, and FAILED.

iv_modelarnequals TYPE /AWS1/BDKCUSTOMMODELARN /AWS1/BDKCUSTOMMODELARN

Filters deployments by the Amazon Resource Name (ARN) of the associated custom model.

RETURNING

oo_output TYPE REF TO /aws1/cl_bdklstcustmdeldeplo01 /AWS1/CL_BDKLSTCUSTMDELDEPLO01

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->listcustommodeldeployments(
  iv_createdafter = '20150101000000.0000000'
  iv_createdbefore = '20150101000000.0000000'
  iv_maxresults = 123
  iv_modelarnequals = |string|
  iv_namecontains = |string|
  iv_nexttoken = |string|
  iv_sortby = |string|
  iv_sortorder = |string|
  iv_statusequals = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_paginationtoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_modeldeploymentsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_custommodeldeploymentar = lo_row_1->get_custommodeldeploymentarn( ).
      lv_modeldeploymentname = lo_row_1->get_custmodeldeploymentname( ).
      lv_modelarn = lo_row_1->get_modelarn( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_custommodeldeploymentst = lo_row_1->get_status( ).
      lv_timestamp = lo_row_1->get_lastupdatedat( ).
      lv_errormessage = lo_row_1->get_failuremessage( ).
    ENDIF.
  ENDLOOP.
ENDIF.