IAmazonGlacier.ListVaults Method (ListVaultsRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to ListVaultsAsync.

Namespace: Amazon.Glacier
Assembly: AWSSDK.Glacier.dll
Version: 3.x.y.z

Syntax

public abstract ListVaultsResponse ListVaults(
         ListVaultsRequest request
)

Parameters

request: Type: Amazon.Glacier.Model.ListVaultsRequest

Container for the necessary parameters to execute the ListVaults service method.

Return Value

Type: ListVaultsResponse

The response from the ListVaults service method, as returned by Glacier.

Exceptions

Exception	Condition
InvalidParameterValueException	Returned if a parameter of the request is incorrectly specified.
MissingParameterValueException	Returned if a required header or parameter is missing from the request.
ResourceNotFoundException	Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
ServiceUnavailableException	Returned if the service cannot complete the request.

Examples

The example lists all vaults owned by the specified AWS account.

To list all vaults owned by the calling user's account


var client = new AmazonGlacierClient();
var response = client.ListVaults(new ListVaultsRequest 
{
    AccountId = "-",
    Limit = "",
    Marker = ""
});

List<DescribeVaultOutput> vaultList = response.VaultList;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

IAmazonGlacier.ListVaults (ListVaultsRequest)

Method