LISTALIASES()`¶

About ListAliases¶

Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the aliases by keyARN. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide.

This is a paginated operation, which means that each response might contain only a subset of all the aliases. When the response contains only a subset of aliases, it includes a NextToken value. Use this value in a subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.

Cross-account use: This operation can't be used across different Amazon Web Services accounts.

Related operations:

Method Signature¶

METHODS /AWS1/IF_PCY~LISTALIASES
  IMPORTING
    !IV_KEYARN TYPE /AWS1/PCYKEYARN OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/PCYNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/PCYMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_pcylistaliasesoutput
  RAISING
    /AWS1/CX_PCYACCESSDENIEDEX
    /AWS1/CX_PCYINTERNALSERVEREX
    /AWS1/CX_PCYRESOURCENOTFOUNDEX
    /AWS1/CX_PCYSERVICEUNAVAILEX
    /AWS1/CX_PCYTHROTTLINGEX
    /AWS1/CX_PCYVALIDATIONEX
    /AWS1/CX_PCYCLIENTEXC
    /AWS1/CX_PCYSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_keyarn` `TYPE /AWS1/PCYKEYARN` `/AWS1/PCYKEYARN`¶

The keyARN for which you want to list all aliases.

`iv_nexttoken` `TYPE /AWS1/PCYNEXTTOKEN` `/AWS1/PCYNEXTTOKEN`¶

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.

`iv_maxresults` `TYPE /AWS1/PCYMAXRESULTS` `/AWS1/PCYMAXRESULTS`¶

Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_pcylistaliasesoutput` `/AWS1/CL_PCYLISTALIASESOUTPUT`¶

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->listaliases(
  iv_keyarn = |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_aliases( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_aliasname = lo_row_1->get_aliasname( ).
      lv_keyarn = lo_row_1->get_keyarn( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_PCY=>LISTALIASES()¶