Network.AWS.KMS.ListKeyPolicies

Retrieves a list of policies attached to a key.

See: AWS API Reference for ListKeyPolicies.

This operation returns paginated results.

Creating a Request

listKeyPolicies

Arguments

:: Text

lkpKeyId

-> ListKeyPolicies

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

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

• lkpMarker
• lkpLimit
• lkpKeyId

data ListKeyPolicies

See: listKeyPolicies smart constructor.

Instances

Eq ListKeyPolicies

Data ListKeyPolicies

Read ListKeyPolicies

Show ListKeyPolicies

Generic ListKeyPolicies

ToJSON ListKeyPolicies

AWSPager ListKeyPolicies

AWSRequest ListKeyPolicies

ToPath ListKeyPolicies

ToHeaders ListKeyPolicies

ToQuery ListKeyPolicies

type Rep ListKeyPolicies

type Rs ListKeyPolicies = ListKeyPoliciesResponse

Request Lenses

lkpMarker :: Lens' ListKeyPolicies (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.

lkpLimit :: Lens' ListKeyPolicies (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 1000, inclusive. If you do not include a value, it defaults to 100.

Currently only 1 policy can be attached to a key.

lkpKeyId :: Lens' ListKeyPolicies Text

A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

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

Destructuring the Response

listKeyPoliciesResponse

Arguments

:: Int

lkprsResponseStatus

-> ListKeyPoliciesResponse

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

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

• lkprsPolicyNames
• lkprsTruncated
• lkprsNextMarker
• lkprsResponseStatus

data ListKeyPoliciesResponse

See: listKeyPoliciesResponse smart constructor.

Instances

Eq ListKeyPoliciesResponse

Data ListKeyPoliciesResponse

Read ListKeyPoliciesResponse

Show ListKeyPoliciesResponse

Generic ListKeyPoliciesResponse

type Rep ListKeyPoliciesResponse

Response Lenses

lkprsPolicyNames :: Lens' ListKeyPoliciesResponse [Text]

A list of policy names. Currently, there is only one policy and it is named "Default".

lkprsTruncated :: Lens' ListKeyPoliciesResponse (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.

lkprsNextMarker :: Lens' ListKeyPoliciesResponse (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.

lkprsResponseStatus :: Lens' ListKeyPoliciesResponse Int

The response status code.