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 |
List the grants for a specified key.
See: AWS API Reference for ListGrants.
- listGrants :: Text -> ListGrants
- data ListGrants
- lgMarker :: Lens' ListGrants (Maybe Text)
- lgLimit :: Lens' ListGrants (Maybe Natural)
- lgKeyId :: Lens' ListGrants Text
- listGrantsResponse :: Int -> ListGrantsResponse
- data ListGrantsResponse
- lgrsTruncated :: Lens' ListGrantsResponse (Maybe Bool)
- lgrsGrants :: Lens' ListGrantsResponse [GrantListEntry]
- lgrsNextMarker :: Lens' ListGrantsResponse (Maybe Text)
- lgrsResponseStatus :: Lens' ListGrantsResponse Int
Creating a Request
:: Text | |
-> 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:
data ListGrants Source
See: listGrants
smart constructor.
Request Lenses
lgMarker :: Lens' ListGrants (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.
lgLimit :: Lens' ListGrants (Maybe Natural) Source
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 Source
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
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:
data ListGrantsResponse Source
See: listGrantsResponse
smart constructor.
Response Lenses
lgrsTruncated :: Lens' ListGrantsResponse (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 grants in the
list.
lgrsGrants :: Lens' ListGrantsResponse [GrantListEntry] Source
A list of grants.
lgrsNextMarker :: Lens' ListGrantsResponse (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.
lgrsResponseStatus :: Lens' ListGrantsResponse Int Source
The response status code.