LISTGRANTS()`¶

About ListGrants¶

Gets a list of all grants for the specified KMS key.

You must specify the KMS key in all requests. You can filter the grant list by grant ID or grantee principal.

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.

The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.

Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter.

Required permissions: kms:ListGrants (key policy)

Related operations:

CreateGrant
ListRetirableGrants
RetireGrant
RevokeGrant

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

Method Signature¶

METHODS /AWS1/IF_KMS~LISTGRANTS
  IMPORTING
    !IV_LIMIT TYPE /AWS1/KMSLIMITTYPE OPTIONAL
    !IV_MARKER TYPE /AWS1/KMSMARKERTYPE OPTIONAL
    !IV_KEYID TYPE /AWS1/KMSKEYIDTYPE OPTIONAL
    !IV_GRANTID TYPE /AWS1/KMSGRANTIDTYPE OPTIONAL
    !IV_GRANTEEPRINCIPAL TYPE /AWS1/KMSPRINCIPALIDTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_kmslistgrantsresponse
  RAISING
    /AWS1/CX_KMSDEPENDENCYTMOUTEX
    /AWS1/CX_KMSINVALIDARNEX
    /AWS1/CX_KMSINVALIDGRANTIDEX
    /AWS1/CX_KMSINVALIDMARKEREX
    /AWS1/CX_KMSKMSINTERNALEX
    /AWS1/CX_KMSKMSINVALIDSTATEEX
    /AWS1/CX_KMSNOTFOUNDEXCEPTION
    /AWS1/CX_KMSCLIENTEXC
    /AWS1/CX_KMSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

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

Returns only grants for the specified KMS key. This parameter is required.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

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

`iv_grantid` `TYPE /AWS1/KMSGRANTIDTYPE` `/AWS1/KMSGRANTIDTYPE`¶

Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

`iv_granteeprincipal` `TYPE /AWS1/KMSPRINCIPALIDTYPE` `/AWS1/KMSPRINCIPALIDTYPE`¶

Returns only grants where the specified principal is the grantee principal for the grant.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_kmslistgrantsresponse` `/AWS1/CL_KMSLISTGRANTSRESPONSE`¶

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->listgrants(
  iv_granteeprincipal = |string|
  iv_grantid = |string|
  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_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/IF_KMS=>LISTGRANTS()¶