LISTRETIRABLEGRANTS()`¶

About ListRetirableGrants¶

Returns information about all grants in the Amazon Web Services account and Region that have the specified retiring principal.

You can specify any principal in your Amazon Web Services account. The grants that are returned include grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this operation to determine which grants you may retire. To retire a grant, use the RetireGrant operation.

For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of creating grants in several programming languages, see Use CreateGrant with an Amazon Web Services SDK or CLI.

Cross-account use: You must specify a principal in your Amazon Web Services account. This operation returns a list of grants where the retiring principal specified in the ListRetirableGrants request is the same retiring principal on the grant. This can include grants on KMS keys owned by other Amazon Web Services accounts, but you do not need kms:ListRetirableGrants permission (or any other additional permission) in any Amazon Web Services account other than your own.

Required permissions: kms:ListRetirableGrants (IAM policy) in your Amazon Web Services account.

KMS authorizes ListRetirableGrants requests by evaluating the caller account's kms:ListRetirableGrants permissions. The authorized resource in ListRetirableGrants calls is the retiring principal specified in the request. KMS does not evaluate the caller's permissions to verify their access to any KMS keys or grants that might be returned by the ListRetirableGrants call.

Related operations:

CreateGrant
ListGrants
RetireGrant
RevokeGrant

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

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_retiringprincipal` `TYPE /AWS1/KMSPRINCIPALIDTYPE` `/AWS1/KMSPRINCIPALIDTYPE`¶

The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .

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

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~listretirablegrants(
  iv_limit = 123
  iv_marker = |string|
  iv_retiringprincipal = |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_grants( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_keyidtype = lo_row_1->get_keyid( ).
      lv_grantidtype = lo_row_1->get_grantid( ).
      lv_grantnametype = lo_row_1->get_name( ).
      lv_datetype = lo_row_1->get_creationdate( ).
      lv_principalidtype = lo_row_1->get_granteeprincipal( ).
      lv_principalidtype = lo_row_1->get_retiringprincipal( ).
      lv_principalidtype = lo_row_1->get_issuingaccount( ).
      LOOP AT lo_row_1->get_operations( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_grantoperation = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lo_grantconstraints = lo_row_1->get_constraints( ).
      IF lo_grantconstraints IS NOT INITIAL.
        LOOP AT lo_grantconstraints->get_encryptioncontextsubset( ) into ls_row_4.
          lv_key = ls_row_4-key.
          lo_value = ls_row_4-value.
          IF lo_value IS NOT INITIAL.
            lv_encryptioncontextvalue = lo_value->get_value( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_grantconstraints->get_encryptioncontextequals( ) into ls_row_4.
          lv_key = ls_row_4-key.
          lo_value = ls_row_4-value.
          IF lo_value IS NOT INITIAL.
            lv_encryptioncontextvalue = lo_value->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_markertype = lo_result->get_nextmarker( ).
  lv_booleantype = lo_result->get_truncated( ).
ENDIF.

/AWS1/CL_KMS=>LISTRETIRABLEGRANTS()¶