Network.AWS.Glacier.DescribeVault

This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault. The number of archives and their total size are as of the last inventory generation. This means that if you add or remove an archive from a vault, and then immediately use Describe Vault, the change in contents will not be immediately reflected. If you want to retrieve the latest inventory of the vault, use InitiateJob . Amazon Glacier generates vault inventories approximately daily. For more information, see Downloading a Vault Inventory in Amazon Glacier .

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 Glacier and Describe Vault in the Amazon Glacier Developer Guide .

Creating a Request

describeVault

Arguments

:: Text

dvAccountId

-> Text

dvVaultName

-> DescribeVault

Creates a value of DescribeVault with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dvAccountId - The AccountId value is the AWS account ID of the account that owns the vault. 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 use an account ID, do not include any hyphens (-) in the ID.
• dvVaultName - The name of the vault.

data DescribeVault

Provides options for retrieving metadata for a specific vault in Amazon Glacier.

See: describeVault smart constructor.

Instances

Eq DescribeVault

Methods

(==) :: DescribeVault -> DescribeVault -> Bool

(/=) :: DescribeVault -> DescribeVault -> Bool

Data DescribeVault

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeVault -> c DescribeVault

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeVault

toConstr :: DescribeVault -> Constr

dataTypeOf :: DescribeVault -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeVault)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeVault)

gmapT :: (forall b. Data b => b -> b) -> DescribeVault -> DescribeVault

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeVault -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeVault -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeVault -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeVault -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeVault -> m DescribeVault

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeVault -> m DescribeVault

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeVault -> m DescribeVault

Read DescribeVault

Methods

readsPrec :: Int -> ReadS DescribeVault

readList :: ReadS [DescribeVault]

readPrec :: ReadPrec DescribeVault

readListPrec :: ReadPrec [DescribeVault]

Show DescribeVault

Methods

showsPrec :: Int -> DescribeVault -> ShowS

show :: DescribeVault -> String

showList :: [DescribeVault] -> ShowS

Generic DescribeVault

Associated Types

type Rep DescribeVault :: * -> *

Methods

from :: DescribeVault -> Rep DescribeVault x

to :: Rep DescribeVault x -> DescribeVault

Hashable DescribeVault

Methods

hashWithSalt :: Int -> DescribeVault -> Int

hash :: DescribeVault -> Int

NFData DescribeVault

Methods

rnf :: DescribeVault -> ()

AWSRequest DescribeVault

Associated Types

type Rs DescribeVault :: *

Methods

request :: DescribeVault -> Request DescribeVault

response :: MonadResource m => Logger -> Service -> Proxy * DescribeVault -> ClientResponse -> m (Response DescribeVault)

ToQuery DescribeVault

Methods

toQuery :: DescribeVault -> QueryString

ToPath DescribeVault

Methods

toPath :: DescribeVault -> ByteString

ToHeaders DescribeVault

Methods

toHeaders :: DescribeVault -> [Header]

type Rep DescribeVault

type Rep DescribeVault = D1 (MetaData "DescribeVault" "Network.AWS.Glacier.DescribeVault" "amazonka-glacier-1.5.0-AWAt53IVogG613fTETHcMP" False) (C1 (MetaCons "DescribeVault'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dvAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_dvVaultName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs DescribeVault

type Rs DescribeVault = DescribeVaultOutput

Request Lenses

dvAccountId :: Lens' DescribeVault Text

The AccountId value is the AWS account ID of the account that owns the vault. 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 use an account ID, do not include any hyphens (-) in the ID.

dvVaultName :: Lens' DescribeVault Text

The name of the vault.

Destructuring the Response

describeVaultOutput :: DescribeVaultOutput

Creates a value of DescribeVaultOutput with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dvoVaultName - The name of the vault.
• dvoSizeInBytes - Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.
• dvoLastInventoryDate - The Universal Coordinated Time (UTC) date when Amazon Glacier completed the last vault inventory. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z .
• dvoVaultARN - The Amazon Resource Name (ARN) of the vault.
• dvoCreationDate - The Universal Coordinated Time (UTC) date when the vault was created. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z .
• dvoNumberOfArchives - The number of archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.

data DescribeVaultOutput

Contains the Amazon Glacier response to your request.

See: describeVaultOutput smart constructor.

Instances

Eq DescribeVaultOutput

Methods

(==) :: DescribeVaultOutput -> DescribeVaultOutput -> Bool

(/=) :: DescribeVaultOutput -> DescribeVaultOutput -> Bool

Data DescribeVaultOutput

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeVaultOutput -> c DescribeVaultOutput

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeVaultOutput

toConstr :: DescribeVaultOutput -> Constr

dataTypeOf :: DescribeVaultOutput -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeVaultOutput)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeVaultOutput)

gmapT :: (forall b. Data b => b -> b) -> DescribeVaultOutput -> DescribeVaultOutput

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeVaultOutput -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeVaultOutput -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeVaultOutput -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeVaultOutput -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeVaultOutput -> m DescribeVaultOutput

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeVaultOutput -> m DescribeVaultOutput

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeVaultOutput -> m DescribeVaultOutput

Read DescribeVaultOutput

Methods

readsPrec :: Int -> ReadS DescribeVaultOutput

readList :: ReadS [DescribeVaultOutput]

readPrec :: ReadPrec DescribeVaultOutput

readListPrec :: ReadPrec [DescribeVaultOutput]

Show DescribeVaultOutput

Methods

showsPrec :: Int -> DescribeVaultOutput -> ShowS

show :: DescribeVaultOutput -> String

showList :: [DescribeVaultOutput] -> ShowS

Generic DescribeVaultOutput

Associated Types

type Rep DescribeVaultOutput :: * -> *

Methods

from :: DescribeVaultOutput -> Rep DescribeVaultOutput x

to :: Rep DescribeVaultOutput x -> DescribeVaultOutput

Hashable DescribeVaultOutput

Methods

hashWithSalt :: Int -> DescribeVaultOutput -> Int

hash :: DescribeVaultOutput -> Int

FromJSON DescribeVaultOutput

Methods

parseJSON :: Value -> Parser DescribeVaultOutput

parseJSONList :: Value -> Parser [DescribeVaultOutput]

NFData DescribeVaultOutput

Methods

rnf :: DescribeVaultOutput -> ()

type Rep DescribeVaultOutput

type Rep DescribeVaultOutput = D1 (MetaData "DescribeVaultOutput" "Network.AWS.Glacier.Types.Product" "amazonka-glacier-1.5.0-AWAt53IVogG613fTETHcMP" False) (C1 (MetaCons "DescribeVaultOutput'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dvoVaultName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dvoSizeInBytes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) (S1 (MetaSel (Just Symbol "_dvoLastInventoryDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_dvoVaultARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dvoCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dvoNumberOfArchives") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)))))))

Response Lenses

dvoVaultName :: Lens' DescribeVaultOutput (Maybe Text)

The name of the vault.

dvoSizeInBytes :: Lens' DescribeVaultOutput (Maybe Integer)

Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.

dvoLastInventoryDate :: Lens' DescribeVaultOutput (Maybe Text)

The Universal Coordinated Time (UTC) date when Amazon Glacier completed the last vault inventory. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z .

dvoVaultARN :: Lens' DescribeVaultOutput (Maybe Text)

The Amazon Resource Name (ARN) of the vault.

dvoCreationDate :: Lens' DescribeVaultOutput (Maybe Text)

The Universal Coordinated Time (UTC) date when the vault was created. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z .

dvoNumberOfArchives :: Lens' DescribeVaultOutput (Maybe Integer)

The number of archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.