LISTPROMPTS()`¶

About ListPrompts¶

Returns either information about the working draft (DRAFT version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include the promptIdentifier field or not. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.

Method Signature¶

METHODS /AWS1/IF_BDA~LISTPROMPTS
  IMPORTING
    !IV_PROMPTIDENTIFIER TYPE /AWS1/BDAPROMPTIDENTIFIER OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BDAMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BDANEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdalistpromptsrsp
  RAISING
    /AWS1/CX_BDAACCESSDENIEDEX
    /AWS1/CX_BDAINTERNALSERVEREX
    /AWS1/CX_BDARESOURCENOTFOUNDEX
    /AWS1/CX_BDATHROTTLINGEX
    /AWS1/CX_BDAVALIDATIONEX
    /AWS1/CX_BDACLIENTEXC
    /AWS1/CX_BDASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_promptidentifier` `TYPE /AWS1/BDAPROMPTIDENTIFIER` `/AWS1/BDAPROMPTIDENTIFIER`¶

The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.

`iv_maxresults` `TYPE /AWS1/BDAMAXRESULTS` `/AWS1/BDAMAXRESULTS`¶

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/BDANEXTTOKEN` `/AWS1/BDANEXTTOKEN`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_bdalistpromptsrsp` `/AWS1/CL_BDALISTPROMPTSRSP`¶

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->listprompts(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_promptidentifier = |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_promptsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_promptname = lo_row_1->get_name( ).
      lv_promptdescription = lo_row_1->get_description( ).
      lv_promptid = lo_row_1->get_id( ).
      lv_promptarn = lo_row_1->get_arn( ).
      lv_version = lo_row_1->get_version( ).
      lv_datetimestamp = lo_row_1->get_createdat( ).
      lv_datetimestamp = lo_row_1->get_updatedat( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_BDA=>LISTPROMPTS()¶