Skip to content

/AWS1/IF_BDK=>LISTMODELCOPYJOBS()

About ListModelCopyJobs

Returns a list of model copy jobs that you have submitted. You can filter the jobs to return based on one or more criteria. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.

Method Signature

METHODS /AWS1/IF_BDK~LISTMODELCOPYJOBS
  IMPORTING
    !IV_CREATIONTIMEAFTER TYPE /AWS1/BDKTIMESTAMP OPTIONAL
    !IV_CREATIONTIMEBEFORE TYPE /AWS1/BDKTIMESTAMP OPTIONAL
    !IV_STATUSEQUALS TYPE /AWS1/BDKMODELCOPYJOBSTATUS OPTIONAL
    !IV_SOURCEACCOUNTEQUALS TYPE /AWS1/BDKACCOUNTID OPTIONAL
    !IV_SOURCEMODELARNEQUALS TYPE /AWS1/BDKMODELARN OPTIONAL
    !IV_TARGETMODELNAMECONTAINS TYPE /AWS1/BDKCUSTOMMODELNAME OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BDKMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BDKPAGINATIONTOKEN OPTIONAL
    !IV_SORTBY TYPE /AWS1/BDKSORTJOBSBY OPTIONAL
    !IV_SORTORDER TYPE /AWS1/BDKSORTORDER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdklstmodelcpyjobsrsp
  RAISING
    /AWS1/CX_BDKACCESSDENIEDEX
    /AWS1/CX_BDKINTERNALSERVEREX
    /AWS1/CX_BDKRESOURCENOTFOUNDEX
    /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_creationtimeafter TYPE /AWS1/BDKTIMESTAMP /AWS1/BDKTIMESTAMP

Filters for model copy jobs created after the specified time.

iv_creationtimebefore TYPE /AWS1/BDKTIMESTAMP /AWS1/BDKTIMESTAMP

Filters for model copy jobs created before the specified time.

iv_statusequals TYPE /AWS1/BDKMODELCOPYJOBSTATUS /AWS1/BDKMODELCOPYJOBSTATUS

Filters for model copy jobs whose status matches the value that you specify.

iv_sourceaccountequals TYPE /AWS1/BDKACCOUNTID /AWS1/BDKACCOUNTID

Filters for model copy jobs in which the account that the source model belongs to is equal to the value that you specify.

iv_sourcemodelarnequals TYPE /AWS1/BDKMODELARN /AWS1/BDKMODELARN

Filters for model copy jobs in which the Amazon Resource Name (ARN) of the source model to is equal to the value that you specify.

iv_targetmodelnamecontains TYPE /AWS1/BDKCUSTOMMODELNAME /AWS1/BDKCUSTOMMODELNAME

Filters for model copy jobs in which the name of the copied model contains the string that you specify.

iv_maxresults TYPE /AWS1/BDKMAXRESULTS /AWS1/BDKMAXRESULTS

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

iv_nexttoken TYPE /AWS1/BDKPAGINATIONTOKEN /AWS1/BDKPAGINATIONTOKEN

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

iv_sortby TYPE /AWS1/BDKSORTJOBSBY /AWS1/BDKSORTJOBSBY

The field to sort by in the returned list of model copy jobs.

iv_sortorder TYPE /AWS1/BDKSORTORDER /AWS1/BDKSORTORDER

Specifies whether to sort the results in ascending or descending order.

RETURNING

oo_output TYPE REF TO /aws1/cl_bdklstmodelcpyjobsrsp /AWS1/CL_BDKLSTMODELCPYJOBSRSP

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->listmodelcopyjobs(
  iv_creationtimeafter = '20150101000000.0000000'
  iv_creationtimebefore = '20150101000000.0000000'
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_sortby = |string|
  iv_sortorder = |string|
  iv_sourceaccountequals = |string|
  iv_sourcemodelarnequals = |string|
  iv_statusequals = |string|
  iv_targetmodelnamecontains = |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_modelcopyjobsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_modelcopyjobarn = lo_row_1->get_jobarn( ).
      lv_modelcopyjobstatus = lo_row_1->get_status( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
      lv_custommodelarn = lo_row_1->get_targetmodelarn( ).
      lv_custommodelname = lo_row_1->get_targetmodelname( ).
      lv_accountid = lo_row_1->get_sourceaccountid( ).
      lv_modelarn = lo_row_1->get_sourcemodelarn( ).
      lv_kmskeyarn = lo_row_1->get_targetmodelkmskeyarn( ).
      LOOP AT lo_row_1->get_targetmodeltags( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_tagkey = lo_row_3->get_key( ).
          lv_tagvalue = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_errormessage = lo_row_1->get_failuremessage( ).
      lv_custommodelname = lo_row_1->get_sourcemodelname( ).
    ENDIF.
  ENDLOOP.
ENDIF.