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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data CreateVault = CreateVault' {
- accountId :: Text
- vaultName :: Text
}
newCreateVault :: Text -> Text -> CreateVault
createVault_accountId :: Lens' CreateVault Text
createVault_vaultName :: Lens' CreateVault Text
data CreateVaultResponse = CreateVaultResponse' {
- location :: Maybe Text
- httpStatus :: Int
}
newCreateVaultResponse :: Int -> CreateVaultResponse
createVaultResponse_location :: Lens' CreateVaultResponse (Maybe Text)
createVaultResponse_httpStatus :: Lens' CreateVaultResponse Int

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

Eq CreateVault Source #
Instance details Defined in Amazonka.Glacier.CreateVault Methods (==) :: CreateVault -> CreateVault -> Bool # (/=) :: CreateVault -> CreateVault -> Bool #
Read CreateVault Source #
Instance details Defined in Amazonka.Glacier.CreateVault Methods readsPrec :: Int -> ReadS CreateVault # readList :: ReadS [CreateVault] # readPrec :: ReadPrec CreateVault # readListPrec :: ReadPrec [CreateVault] #
Show CreateVault Source #
Instance details Defined in Amazonka.Glacier.CreateVault Methods showsPrec :: Int -> CreateVault -> ShowS # show :: CreateVault -> String # showList :: [CreateVault] -> ShowS #
Generic CreateVault Source #
Instance details Defined in Amazonka.Glacier.CreateVault Associated Types type Rep CreateVault :: Type -> Type # Methods from :: CreateVault -> Rep CreateVault x # to :: Rep CreateVault x -> CreateVault #
NFData CreateVault Source #
Instance details Defined in Amazonka.Glacier.CreateVault Methods rnf :: CreateVault -> () #
Hashable CreateVault Source #
Instance details Defined in Amazonka.Glacier.CreateVault Methods hashWithSalt :: Int -> CreateVault -> Int # hash :: CreateVault -> Int #
ToJSON CreateVault Source #
Instance details Defined in Amazonka.Glacier.CreateVault Methods toJSON :: CreateVault -> Value # toEncoding :: CreateVault -> Encoding # toJSONList :: [CreateVault] -> Value # toEncodingList :: [CreateVault] -> Encoding #
AWSRequest CreateVault Source #
Instance details Defined in Amazonka.Glacier.CreateVault Associated Types type AWSResponse CreateVault # Methods request :: CreateVault -> Request CreateVault # response :: MonadResource m => Logger -> Service -> Proxy CreateVault -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse 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 Methods toPath :: CreateVault -> ByteString #
ToQuery CreateVault Source #
Instance details Defined in Amazonka.Glacier.CreateVault Methods toQuery :: CreateVault -> QueryString #
type Rep CreateVault Source #
Instance details Defined in Amazonka.Glacier.CreateVault type Rep CreateVault = D1 ('MetaData "CreateVault" "Amazonka.Glacier.CreateVault" "libZSservicesZSamazonka-glacierZSamazonka-glacier" 'False) (C1 ('MetaCons "CreateVault'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "vaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateVault Source #
Instance details Defined in Amazonka.Glacier.CreateVault type AWSResponse CreateVault = CreateVaultResponse

newCreateVault Source #

Arguments

:: Text	`$sel:accountId:CreateVault'`
-> Text	`$sel:vaultName:CreateVault'`
-> CreateVault

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.

$sel:vaultName: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.

createVault_vaultName :: Lens' CreateVault Text Source #

The name of the vault.

Destructuring the Response

data CreateVaultResponse Source #

Contains the Amazon S3 Glacier response to your request.

See: newCreateVaultResponse smart constructor.

Constructors

CreateVaultResponse'
Fields location :: Maybe Text The URI of the vault that was created. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateVaultResponse Source #
Instance details Defined in Amazonka.Glacier.CreateVault Methods (==) :: CreateVaultResponse -> CreateVaultResponse -> Bool # (/=) :: CreateVaultResponse -> CreateVaultResponse -> Bool #
Read CreateVaultResponse Source #
Instance details Defined in Amazonka.Glacier.CreateVault Methods readsPrec :: Int -> ReadS CreateVaultResponse # readList :: ReadS [CreateVaultResponse] # readPrec :: ReadPrec CreateVaultResponse # readListPrec :: ReadPrec [CreateVaultResponse] #
Show CreateVaultResponse Source #
Instance details Defined in Amazonka.Glacier.CreateVault Methods showsPrec :: Int -> CreateVaultResponse -> ShowS # show :: CreateVaultResponse -> String # showList :: [CreateVaultResponse] -> ShowS #
Generic CreateVaultResponse Source #
Instance details Defined in Amazonka.Glacier.CreateVault Associated Types type Rep CreateVaultResponse :: Type -> Type # Methods from :: CreateVaultResponse -> Rep CreateVaultResponse x # to :: Rep CreateVaultResponse x -> CreateVaultResponse #
NFData CreateVaultResponse Source #
Instance details Defined in Amazonka.Glacier.CreateVault Methods rnf :: CreateVaultResponse -> () #
type Rep CreateVaultResponse Source #
Instance details Defined in Amazonka.Glacier.CreateVault type Rep CreateVaultResponse = D1 ('MetaData "CreateVaultResponse" "Amazonka.Glacier.CreateVault" "libZSservicesZSamazonka-glacierZSamazonka-glacier" '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 #

Arguments

:: Int	`$sel:httpStatus:CreateVaultResponse'`
-> CreateVaultResponse

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:

$sel:location: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.

createVaultResponse_httpStatus :: Lens' CreateVaultResponse Int Source #

The response's http status code.