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

Typeable * ListGrants

type Rep ListGrants

type Sv ListGrants = KMS

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 where the results are truncated. Set it to the value of the NextMarker in the response you just received.

lgLimit :: Lens' ListGrants (Maybe Natural)

Specify this parameter only when paginating results to indicate the maximum number of grants you want listed in the response. If there are additional grants beyond the maximum you specify, the Truncated response element will be set to 'true.'

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

Arguments

:: Int

lgrsStatus

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

• lgrsTruncated
• lgrsGrants
• lgrsNextMarker
• lgrsStatus

data ListGrantsResponse

See: listGrantsResponse smart constructor.

Instances

Eq ListGrantsResponse

Data ListGrantsResponse

Read ListGrantsResponse

Show ListGrantsResponse

Generic ListGrantsResponse

Typeable * ListGrantsResponse

type Rep ListGrantsResponse

Response Lenses

lgrsTruncated :: Lens' ListGrantsResponse (Maybe Bool)

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

lgrsGrants :: Lens' ListGrantsResponse [GrantListEntry]

A list of grants.

lgrsNextMarker :: Lens' ListGrantsResponse (Maybe Text)

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

lgrsStatus :: Lens' ListGrantsResponse Int

The response status code.