Skip to content

/AWS1/CL_KMS=>LISTRESOURCETAGS()

About ListResourceTags

Returns all tags on the specified KMS key.

For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference. For information about using tags in KMS, see Tagging keys.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:ListResourceTags (key policy)

Related operations:

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

Method Signature

IMPORTING

Required arguments:

iv_keyid TYPE /AWS1/KMSKEYIDTYPE /AWS1/KMSKEYIDTYPE

Gets tags on the specified KMS key.

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.

Optional arguments:

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 50, 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.

Do not attempt to construct this value. Use only the value of NextMarker from the truncated response you just received.

RETURNING

oo_output TYPE REF TO /aws1/cl_kmslistresrctagsrsp /AWS1/CL_KMSLISTRESRCTAGSRSP

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~listresourcetags(
  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_tags( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_tagkeytype = lo_row_1->get_tagkey( ).
      lv_tagvaluetype = lo_row_1->get_tagvalue( ).
    ENDIF.
  ENDLOOP.
  lv_markertype = lo_result->get_nextmarker( ).
  lv_booleantype = lo_result->get_truncated( ).
ENDIF.

To list tags for a KMS key

The following example lists tags for a KMS key.

DATA(lo_result) = lo_client->/aws1/if_kms~listresourcetags( iv_keyid = |1234abcd-12ab-34cd-56ef-1234567890ab| ) .