amazonka-glacier-2.0: Amazon Glacier SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Glacier.CreateVault

Description

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.

Synopsis

Creating a Request

data CreateVault Source #

Provides options to create a vault.

See: newCreateVault smart constructor.

Constructors

CreateVault' 

Fields

  • accountId :: Text

    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 S3 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.

  • vaultName :: Text

    The name of the vault.

Instances

Instances details
ToJSON CreateVault Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

ToHeaders CreateVault Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

Methods

toHeaders :: CreateVault -> [Header] #

ToPath CreateVault Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

ToQuery CreateVault Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

AWSRequest CreateVault Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

Associated Types

type AWSResponse CreateVault #

Generic CreateVault Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

Associated Types

type Rep CreateVault :: Type -> Type #

Read CreateVault Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

Show CreateVault Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

NFData CreateVault Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

Methods

rnf :: CreateVault -> () #

Eq CreateVault Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

Hashable CreateVault Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

type AWSResponse CreateVault Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

type Rep CreateVault Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

type Rep CreateVault = D1 ('MetaData "CreateVault" "Amazonka.Glacier.CreateVault" "amazonka-glacier-2.0-17Kmjv8nUJeKOtbrjLyy76" 'False) (C1 ('MetaCons "CreateVault'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "vaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateVault Source #

Create a value of CreateVault 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:accountId:CreateVault', createVault_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 S3 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.

CreateVault, createVault_vaultName - The name of the vault.

Request Lenses

createVault_accountId :: Lens' CreateVault 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 S3 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 CreateVaultResponse Source #

Contains the Amazon S3 Glacier response to your request.

See: newCreateVaultResponse smart constructor.

Constructors

CreateVaultResponse' 

Fields

Instances

Instances details
Generic CreateVaultResponse Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

Associated Types

type Rep CreateVaultResponse :: Type -> Type #

Read CreateVaultResponse Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

Show CreateVaultResponse Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

NFData CreateVaultResponse Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

Methods

rnf :: CreateVaultResponse -> () #

Eq CreateVaultResponse Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

type Rep CreateVaultResponse Source # 
Instance details

Defined in Amazonka.Glacier.CreateVault

type Rep CreateVaultResponse = D1 ('MetaData "CreateVaultResponse" "Amazonka.Glacier.CreateVault" "amazonka-glacier-2.0-17Kmjv8nUJeKOtbrjLyy76" 'False) (C1 ('MetaCons "CreateVaultResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateVaultResponse Source #

Create a value of CreateVaultResponse 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:

CreateVaultResponse, createVaultResponse_location - The URI of the vault that was created.

$sel:httpStatus:CreateVaultResponse', createVaultResponse_httpStatus - The response's http status code.

Response Lenses

createVaultResponse_location :: Lens' CreateVaultResponse (Maybe Text) Source #

The URI of the vault that was created.