| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Glacier.ListVaults
Description
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 10 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, see Retrieving Vault Metadata in Amazon S3 Glacier and List Vaults in the Amazon Glacier Developer Guide.
This operation returns paginated results.
Synopsis
- data ListVaults = ListVaults' {}
- newListVaults :: Text -> ListVaults
- listVaults_marker :: Lens' ListVaults (Maybe Text)
- listVaults_limit :: Lens' ListVaults (Maybe Text)
- listVaults_accountId :: Lens' ListVaults Text
- data ListVaultsResponse = ListVaultsResponse' {
- marker :: Maybe Text
- vaultList :: Maybe [DescribeVaultOutput]
- httpStatus :: Int
- newListVaultsResponse :: Int -> ListVaultsResponse
- listVaultsResponse_marker :: Lens' ListVaultsResponse (Maybe Text)
- listVaultsResponse_vaultList :: Lens' ListVaultsResponse (Maybe [DescribeVaultOutput])
- listVaultsResponse_httpStatus :: Lens' ListVaultsResponse Int
Creating a Request
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: newListVaults smart constructor.
Constructors
| ListVaults' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ListVaults |
Create a value of ListVaults with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:ListVaults', listVaults_marker - A string used for pagination. The marker specifies the vault ARN after
which the listing of vaults should begin.
$sel:limit:ListVaults', listVaults_limit - The maximum number of vaults to be returned. The default limit is 10.
The number of vaults returned might be fewer than the specified limit,
but the number of returned vaults never exceeds the limit.
$sel:accountId:ListVaults', listVaults_accountId - 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 '-'
(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 ('-') in the ID.
Request Lenses
listVaults_marker :: Lens' ListVaults (Maybe Text) Source #
A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.
listVaults_limit :: Lens' ListVaults (Maybe Text) Source #
The maximum number of vaults to be returned. The default limit is 10. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.
listVaults_accountId :: 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 '-'
(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 ('-') in the ID.
Destructuring the Response
data ListVaultsResponse Source #
Contains the Amazon S3 Glacier response to your request.
See: newListVaultsResponse smart constructor.
Constructors
| ListVaultsResponse' | |
Fields
| |
Instances
newListVaultsResponse Source #
Arguments
| :: Int | |
| -> ListVaultsResponse |
Create a value of ListVaultsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:ListVaults', listVaultsResponse_marker - 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.
$sel:vaultList:ListVaultsResponse', listVaultsResponse_vaultList - List of vaults.
$sel:httpStatus:ListVaultsResponse', listVaultsResponse_httpStatus - The response's http status code.
Response Lenses
listVaultsResponse_marker :: 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.
listVaultsResponse_vaultList :: Lens' ListVaultsResponse (Maybe [DescribeVaultOutput]) Source #
List of vaults.
listVaultsResponse_httpStatus :: Lens' ListVaultsResponse Int Source #
The response's http status code.