Network.AWS.KMS.ListGrants

List the grants for a specified key.

See: AWS API Reference for ListGrants.

Creating a Request

listGrants

Arguments

:: Text

lgKeyId

-> ListGrants

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

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

• lgMarker
• lgLimit
• lgKeyId

data ListGrants

See: listGrants smart constructor.

Instances

Eq ListGrants

Data ListGrants

Read ListGrants

Show ListGrants

Generic ListGrants

ToJSON ListGrants

AWSRequest ListGrants

ToPath ListGrants

ToHeaders ListGrants

ToQuery ListGrants

type Rep ListGrants

type Rs ListGrants = ListGrantsResponse

Request Lenses

lgMarker :: Lens' ListGrants (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.

lgLimit :: Lens' ListGrants (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.

lgKeyId :: Lens' ListGrants Text

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

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.