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 :: ListGrantsResponse
- data ListGrantsResponse
- lgTruncated :: Lens' ListGrantsResponse (Maybe Bool)
- lgGrants :: Lens' ListGrantsResponse [GrantListEntry]
- lgNextMarker :: Lens' ListGrantsResponse (Maybe Text)
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 with truncated results. Set it
to the value of NextMarker
from the response you just received.
lgLimit :: Lens' ListGrants (Maybe Natural) Source
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 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
listGrantsResponse :: ListGrantsResponse Source
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
lgTruncated :: Lens' ListGrantsResponse (Maybe Bool) Source
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] Source
A list of grants.
lgNextMarker :: Lens' ListGrantsResponse (Maybe Text) Source
When Truncated
is true, this value is present and contains the value
to use for the Marker
parameter in a subsequent pagination request.