- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateVaultCommand
This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon S3 Glacier.
You must use the following guidelines when naming a vault.
-
Names can be between 1 and 255 characters long.
-
Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).
This operation is idempotent.
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 Creating a Vault in Amazon Glacier and Create Vault in the Amazon Glacier Developer Guide.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { GlacierClient, CreateVaultCommand } from "@aws-sdk/client-glacier"; // ES Modules import
// const { GlacierClient, CreateVaultCommand } = require("@aws-sdk/client-glacier"); // CommonJS import
const client = new GlacierClient(config);
const input = { // CreateVaultInput
accountId: "STRING_VALUE", // required
vaultName: "STRING_VALUE", // required
};
const command = new CreateVaultCommand(input);
const response = await client.send(command);
// { // CreateVaultOutput
// location: "STRING_VALUE",
// };
Example Usage
CreateVaultCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
accountId Required | string | undefined | The |
vaultName Required | string | undefined | The name of the vault. |
CreateVaultCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
location | string | undefined | The URI of the vault that was created. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InvalidParameterValueException | client | Returned if a parameter of the request is incorrectly specified. |
LimitExceededException | client | Returned if the request results in a vault or account limit being exceeded. |
MissingParameterValueException | client | Returned if a required header or parameter is missing from the request. |
ServiceUnavailableException | server | Returned if the service cannot complete the request. |
GlacierServiceException | Base exception class for all service exceptions from Glacier service. |