LISTALIASES()`¶

About ListAliases¶

Gets a list of aliases in the caller's Amazon Web Services account and region. For more information about aliases, see CreateAlias.

By default, the ListAliases operation returns all aliases in the account and region. To get only the aliases associated with a particular KMS key, use the KeyId parameter.

The ListAliases response can include aliases that you created and associated with your customer managed keys, and aliases that Amazon Web Services created and associated with Amazon Web Services managed keys in your account. You can recognize Amazon Web Services aliases because their names have the format aws/, such as aws/dynamodb.

The response might also include aliases that have no TargetKeyId field. These are predefined aliases that Amazon Web Services has created but has not yet associated with a KMS key. Aliases that Amazon Web Services creates in your account, including predefined aliases, do not count against your KMS aliases quota.

Cross-account use: No. ListAliases does not return aliases in other Amazon Web Services accounts.

Required permissions: kms:ListAliases (IAM policy)

For details, see Controlling access to aliases in the Key Management Service Developer Guide.

Related operations:

CreateAlias
DeleteAlias
UpdateAlias

Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.

Method Signature¶

IMPORTING¶

Optional arguments:¶

`iv_keyid` `TYPE /AWS1/KMSKEYIDTYPE` `/AWS1/KMSKEYIDTYPE`¶

Lists only aliases that are associated with the specified KMS key. Enter a KMS key in your Amazon Web Services account.

This parameter is optional. If you omit it, ListAliases returns all aliases in the account and Region.

Specify the key ID or key ARN of the KMS key.

For example:

Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

`iv_limit` `TYPE /AWS1/KMSLIMITTYPE` `/AWS1/KMSLIMITTYPE`¶

Use this parameter to specify the maximum number of items to return. When this value is present, KMS 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.

`iv_marker` `TYPE /AWS1/KMSMARKERTYPE` `/AWS1/KMSMARKERTYPE`¶

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

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_kmslistaliasesrsp` `/AWS1/CL_KMSLISTALIASESRSP`¶

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->/aws1/if_kms~listaliases(
  iv_keyid = |string|
  iv_limit = 123
  iv_marker = |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_aliasnametype = lo_row_1->get_aliasname( ).
      lv_arntype = lo_row_1->get_aliasarn( ).
      lv_keyidtype = lo_row_1->get_targetkeyid( ).
      lv_datetype = lo_row_1->get_creationdate( ).
      lv_datetype = lo_row_1->get_lastupdateddate( ).
    ENDIF.
  ENDLOOP.
  lv_markertype = lo_result->get_nextmarker( ).
  lv_booleantype = lo_result->get_truncated( ).
ENDIF.

To list aliases¶

The following example lists aliases.

DATA(lo_result) = lo_client->/aws1/if_kms~listaliases( ).

/AWS1/CL_KMS=>LISTALIASES()¶