LISTARTIFACTS()`¶

About ListArtifacts¶

Returns a list of end-to-end testing artifacts for a specified app, branch, and job.

To return the build artifacts, use the GetJob API.

For more information about Amplify testing support, see Setting up end-to-end Cypress tests for your Amplify application in the Amplify Hosting User Guide.

Method Signature¶

METHODS /AWS1/IF_AMF~LISTARTIFACTS
  IMPORTING
    !IV_APPID TYPE /AWS1/AMFAPPID OPTIONAL
    !IV_BRANCHNAME TYPE /AWS1/AMFBRANCHNAME OPTIONAL
    !IV_JOBID TYPE /AWS1/AMFJOBID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/AMFNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/AMFMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_amflistartifactsrslt
  RAISING
    /AWS1/CX_AMFBADREQUESTEX
    /AWS1/CX_AMFINTERNALFAILUREEX
    /AWS1/CX_AMFLIMITEXCEEDEDEX
    /AWS1/CX_AMFUNAUTHORIZEDEX
    /AWS1/CX_AMFCLIENTEXC
    /AWS1/CX_AMFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_appid` `TYPE /AWS1/AMFAPPID` `/AWS1/AMFAPPID`¶

The unique ID for an Amplify app.

`iv_branchname` `TYPE /AWS1/AMFBRANCHNAME` `/AWS1/AMFBRANCHNAME`¶

The name of a branch that is part of an Amplify app.

`iv_jobid` `TYPE /AWS1/AMFJOBID` `/AWS1/AMFJOBID`¶

The unique ID for a job.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/AMFNEXTTOKEN` `/AWS1/AMFNEXTTOKEN`¶

A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, pass its value in here to list more artifacts.

`iv_maxresults` `TYPE /AWS1/AMFMAXRESULTS` `/AWS1/AMFMAXRESULTS`¶

The maximum number of records to list in a single response.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_amflistartifactsrslt` `/AWS1/CL_AMFLISTARTIFACTSRSLT`¶

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->listartifacts(
  iv_appid = |string|
  iv_branchname = |string|
  iv_jobid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_artifacts( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_artifactfilename = lo_row_1->get_artifactfilename( ).
      lv_artifactid = lo_row_1->get_artifactid( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_AMF=>LISTARTIFACTS()¶