Network.AWS.KMS.ListRetirableGrants

Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.

A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.

See: AWS API Reference for ListRetirableGrants.

Creating a Request

listRetirableGrants

Arguments

:: Text

lrgRetiringPrincipal

-> ListRetirableGrants

Creates a value of ListRetirableGrants with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lrgMarker
• lrgLimit
• lrgRetiringPrincipal

data ListRetirableGrants

See: listRetirableGrants smart constructor.

Instances

Eq ListRetirableGrants

Data ListRetirableGrants

Read ListRetirableGrants

Show ListRetirableGrants

Generic ListRetirableGrants

ToJSON ListRetirableGrants

AWSRequest ListRetirableGrants

ToPath ListRetirableGrants

ToHeaders ListRetirableGrants

ToQuery ListRetirableGrants

type Rep ListRetirableGrants

type Rs ListRetirableGrants = ListGrantsResponse

Request Lenses

lrgMarker :: Lens' ListRetirableGrants (Maybe Text)

Use this parameter only when paginating results and only in a subsequent request after you've received a response with truncated results. Set it to the value of NextMarker from the response you just received.

lrgLimit :: Lens' ListRetirableGrants (Maybe Natural)

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

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.

lrgRetiringPrincipal :: Lens' ListRetirableGrants Text

The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, go to AWS Identity and Access Management (IAM) in the Example ARNs section of the /Amazon Web Services General Reference/.

Destructuring the Response

listGrantsResponse :: ListGrantsResponse

Creates a value of ListGrantsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lgTruncated
• lgGrants
• lgNextMarker

data ListGrantsResponse

See: listGrantsResponse smart constructor.

Instances

Eq ListGrantsResponse

Data ListGrantsResponse

Read ListGrantsResponse

Show ListGrantsResponse

Generic ListGrantsResponse

FromJSON ListGrantsResponse

type Rep ListGrantsResponse

Response Lenses

lgTruncated :: Lens' ListGrantsResponse (Maybe Bool)

A flag that indicates whether there are more items in the list. If your results were truncated, you can use the Marker parameter to make a subsequent pagination request to retrieve more items in the list.

lgGrants :: Lens' ListGrantsResponse [GrantListEntry]

A list of grants.

lgNextMarker :: Lens' ListGrantsResponse (Maybe Text)

When Truncated is true, this value is present and contains the value to use for the Marker parameter in a subsequent pagination request.