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 |
This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name.
By default, this operation returns up to 1,000 items. If there are more
vaults to list, the response marker
field contains the vault Amazon
Resource Name (ARN) at which to continue the list with a new List Vaults
request; otherwise, the marker
field is null
. To return a list of
vaults that begins at a specific vault, set the marker
request
parameter to the vault ARN you obtained from a previous List Vaults
request. You can also limit the number of vaults returned in the
response by specifying the limit
parameter in the request.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and underlying REST API, go to Retrieving Vault Metadata in Amazon Glacier and List Vaults in the Amazon Glacier Developer Guide.
See: AWS API Reference for ListVaults.
- listVaults :: Text -> ListVaults
- data ListVaults
- lvMarker :: Lens' ListVaults (Maybe Text)
- lvLimit :: Lens' ListVaults (Maybe Text)
- lvAccountId :: Lens' ListVaults Text
- listVaultsResponse :: Int -> ListVaultsResponse
- data ListVaultsResponse
- lvrsMarker :: Lens' ListVaultsResponse (Maybe Text)
- lvrsVaultList :: Lens' ListVaultsResponse [DescribeVaultOutput]
- lvrsStatus :: Lens' ListVaultsResponse Int
Creating a Request
Creates a value of ListVaults
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListVaults Source
Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.
See: listVaults
smart constructor.
Request Lenses
lvMarker :: Lens' ListVaults (Maybe Text) Source
A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.
lvLimit :: Lens' ListVaults (Maybe Text) Source
The maximum number of items returned in the response. If you don't specify a value, the List Vaults operation returns up to 1,000 items.
lvAccountId :: Lens' ListVaults Text Source
The AccountId
value is the AWS account ID. This value must match the
AWS account ID associated with the credentials used to sign the request.
You can either specify an AWS account ID or optionally a single
apos-
apos (hyphen), in which case Amazon Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you
specify your account ID, do not include any hyphens (apos-apos) in the
ID.
Destructuring the Response
Creates a value of ListVaultsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListVaultsResponse Source
Contains the Amazon Glacier response to your request.
See: listVaultsResponse
smart constructor.
Response Lenses
lvrsMarker :: Lens' ListVaultsResponse (Maybe Text) Source
The vault ARN at which to continue pagination of the results. You use the marker in another List Vaults request to obtain more vaults in the list.
lvrsVaultList :: Lens' ListVaultsResponse [DescribeVaultOutput] Source
List of vaults.
lvrsStatus :: Lens' ListVaultsResponse Int Source
The response status code.