Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Retrieves a list of policies attached to a key.
See: AWS API Reference for ListKeyPolicies.
- listKeyPolicies :: Text -> ListKeyPolicies
- data ListKeyPolicies
- lkpMarker :: Lens' ListKeyPolicies (Maybe Text)
- lkpLimit :: Lens' ListKeyPolicies (Maybe Natural)
- lkpKeyId :: Lens' ListKeyPolicies Text
- listKeyPoliciesResponse :: Int -> ListKeyPoliciesResponse
- data ListKeyPoliciesResponse
- lkprsPolicyNames :: Lens' ListKeyPoliciesResponse [Text]
- lkprsTruncated :: Lens' ListKeyPoliciesResponse (Maybe Bool)
- lkprsNextMarker :: Lens' ListKeyPoliciesResponse (Maybe Text)
- lkprsStatus :: Lens' ListKeyPoliciesResponse Int
Creating a Request
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:
data ListKeyPolicies Source
See: listKeyPolicies
smart constructor.
Request Lenses
lkpMarker :: Lens' ListKeyPolicies (Maybe Text) Source
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.
lkpLimit :: Lens' ListKeyPolicies (Maybe Natural) Source
Specify this parameter only when paginating results to indicate the
maximum number of policies you want listed in the response. If there are
additional policies beyond the maximum you specify, the Truncated
response element will be set to 'true.'
lkpKeyId :: Lens' ListKeyPolicies Text Source
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 Source
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:
data ListKeyPoliciesResponse Source
See: listKeyPoliciesResponse
smart constructor.
Response Lenses
lkprsPolicyNames :: Lens' ListKeyPoliciesResponse [Text] Source
A list of policy names. Currently, there is only one policy and it is named "Default".
lkprsTruncated :: Lens' ListKeyPoliciesResponse (Maybe Bool) Source
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 policies in the
list.
lkprsNextMarker :: Lens' ListKeyPoliciesResponse (Maybe Text) Source
If Truncated
is true, this value is present and contains the value to
use for the Marker
request parameter in a subsequent pagination
request.
lkprsStatus :: Lens' ListKeyPoliciesResponse Int Source
The response status code.