LISTGUARDRAILS()`¶

About ListGuardrails¶

Lists details about all the guardrails in an account. To list the DRAFT version of all your guardrails, don't specify the guardrailIdentifier field. To list all versions of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field.

You can set the maximum number of results to return in a response in the maxResults field. If there are more results than the number you set, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.

Method Signature¶

METHODS /AWS1/IF_BDK~LISTGUARDRAILS
  IMPORTING
    !IV_GUARDRAILIDENTIFIER TYPE /AWS1/BDKGUARDRAILIDENTIFIER OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BDKMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BDKPAGINATIONTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdklistguardrailsrsp
  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_guardrailidentifier` `TYPE /AWS1/BDKGUARDRAILIDENTIFIER` `/AWS1/BDKGUARDRAILIDENTIFIER`¶

The unique identifier of the guardrail. This can be an ID or the ARN.

`iv_maxresults` `TYPE /AWS1/BDKMAXRESULTS` `/AWS1/BDKMAXRESULTS`¶

The maximum number of results to return in the response.

`iv_nexttoken` `TYPE /AWS1/BDKPAGINATIONTOKEN` `/AWS1/BDKPAGINATIONTOKEN`¶

If there are more results than were returned in the response, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_bdklistguardrailsrsp` `/AWS1/CL_BDKLISTGUARDRAILSRSP`¶

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->listguardrails(
  iv_guardrailidentifier = |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_guardrails( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_guardrailid = lo_row_1->get_id( ).
      lv_guardrailarn = lo_row_1->get_arn( ).
      lv_guardrailstatus = lo_row_1->get_status( ).
      lv_guardrailname = lo_row_1->get_name( ).
      lv_guardraildescription = lo_row_1->get_description( ).
      lv_guardrailversion = lo_row_1->get_version( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_updatedat( ).
      lo_guardrailcrossregiondet = lo_row_1->get_crossregiondetails( ).
      IF lo_guardrailcrossregiondet IS NOT INITIAL.
        lv_guardrailcrossregiongua = lo_guardrailcrossregiondet->get_guardrailprofileid( ).
        lv_guardrailcrossregiongua_1 = lo_guardrailcrossregiondet->get_guardrailprofilearn( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_BDK=>LISTGUARDRAILS()¶