Network.AWS.Glacier.ListVaults

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 1,000 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 Glacier and List Vaults in the Amazon Glacier Developer Guide .

This operation returns paginated results.

Creating a Request

listVaults

Arguments

:: Text

lvAccountId

-> ListVaults

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

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

• lvMarker - A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.
• lvLimit - The maximum number of vaults to be returned. The default limit is 1000. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.
• lvAccountId - 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 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.

data ListVaults

Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.

See: listVaults smart constructor.

Instances

Eq ListVaults

Defined in Network.AWS.Glacier.ListVaults

Methods

(==) :: ListVaults -> ListVaults -> Bool

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

Data ListVaults

Defined in Network.AWS.Glacier.ListVaults

Methods

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

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

toConstr :: ListVaults -> Constr

dataTypeOf :: ListVaults -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListVaults

Defined in Network.AWS.Glacier.ListVaults

Methods

readsPrec :: Int -> ReadS ListVaults

readList :: ReadS [ListVaults]

readPrec :: ReadPrec ListVaults

readListPrec :: ReadPrec [ListVaults]

Show ListVaults

Defined in Network.AWS.Glacier.ListVaults

Methods

showsPrec :: Int -> ListVaults -> ShowS

show :: ListVaults -> String

showList :: [ListVaults] -> ShowS

Generic ListVaults

Defined in Network.AWS.Glacier.ListVaults

Associated Types

type Rep ListVaults :: Type -> Type

Methods

from :: ListVaults -> Rep ListVaults x

to :: Rep ListVaults x -> ListVaults

Hashable ListVaults

Defined in Network.AWS.Glacier.ListVaults

Methods

hashWithSalt :: Int -> ListVaults -> Int

hash :: ListVaults -> Int

AWSPager ListVaults

Defined in Network.AWS.Glacier.ListVaults

Methods

page :: ListVaults -> Rs ListVaults -> Maybe ListVaults

AWSRequest ListVaults

Defined in Network.AWS.Glacier.ListVaults

Associated Types

type Rs ListVaults :: Type

Methods

request :: ListVaults -> Request ListVaults

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListVaults -> ClientResponse -> m (Response ListVaults)

ToHeaders ListVaults

Defined in Network.AWS.Glacier.ListVaults

Methods

toHeaders :: ListVaults -> [Header]

ToPath ListVaults

Defined in Network.AWS.Glacier.ListVaults

Methods

toPath :: ListVaults -> ByteString

ToQuery ListVaults

Defined in Network.AWS.Glacier.ListVaults

Methods

toQuery :: ListVaults -> QueryString

NFData ListVaults

Defined in Network.AWS.Glacier.ListVaults

Methods

rnf :: ListVaults -> ()

type Rep ListVaults

Defined in Network.AWS.Glacier.ListVaults

type Rep ListVaults = D1 (MetaData "ListVaults" "Network.AWS.Glacier.ListVaults" "amazonka-glacier-1.6.1-1jk94OYE8nZKrGhzWrcb8m" False) (C1 (MetaCons "ListVaults'" PrefixI True) (S1 (MetaSel (Just "_lvMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lvLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lvAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs ListVaults

Defined in Network.AWS.Glacier.ListVaults

type Rs ListVaults = ListVaultsResponse

Request Lenses

lvMarker :: Lens' ListVaults (Maybe Text)

A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

lvLimit :: Lens' ListVaults (Maybe Text)

The maximum number of vaults to be returned. The default limit is 1000. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

lvAccountId :: Lens' ListVaults 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 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

listVaultsResponse

Arguments

:: Int

lvrsResponseStatus

-> ListVaultsResponse

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

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

• lvrsMarker - The vault ARN at which to continue pagination of the results. You use the marker in another List Vaults request to obtain more vaults in the list.
• lvrsVaultList - List of vaults.
• lvrsResponseStatus - -- | The response status code.

data ListVaultsResponse

Contains the Amazon Glacier response to your request.

See: listVaultsResponse smart constructor.

Instances

Eq ListVaultsResponse

Defined in Network.AWS.Glacier.ListVaults

Methods

(==) :: ListVaultsResponse -> ListVaultsResponse -> Bool

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

Data ListVaultsResponse

Defined in Network.AWS.Glacier.ListVaults

Methods

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

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

toConstr :: ListVaultsResponse -> Constr

dataTypeOf :: ListVaultsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListVaultsResponse

Defined in Network.AWS.Glacier.ListVaults

Methods

readsPrec :: Int -> ReadS ListVaultsResponse

readList :: ReadS [ListVaultsResponse]

readPrec :: ReadPrec ListVaultsResponse

readListPrec :: ReadPrec [ListVaultsResponse]

Show ListVaultsResponse

Defined in Network.AWS.Glacier.ListVaults

Methods

showsPrec :: Int -> ListVaultsResponse -> ShowS

show :: ListVaultsResponse -> String

showList :: [ListVaultsResponse] -> ShowS

Generic ListVaultsResponse

Defined in Network.AWS.Glacier.ListVaults

Associated Types

type Rep ListVaultsResponse :: Type -> Type

Methods

from :: ListVaultsResponse -> Rep ListVaultsResponse x

to :: Rep ListVaultsResponse x -> ListVaultsResponse

NFData ListVaultsResponse

Defined in Network.AWS.Glacier.ListVaults

Methods

rnf :: ListVaultsResponse -> ()

type Rep ListVaultsResponse

Defined in Network.AWS.Glacier.ListVaults

type Rep ListVaultsResponse = D1 (MetaData "ListVaultsResponse" "Network.AWS.Glacier.ListVaults" "amazonka-glacier-1.6.1-1jk94OYE8nZKrGhzWrcb8m" False) (C1 (MetaCons "ListVaultsResponse'" PrefixI True) (S1 (MetaSel (Just "_lvrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lvrsVaultList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [DescribeVaultOutput])) :*: S1 (MetaSel (Just "_lvrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

lvrsMarker :: Lens' ListVaultsResponse (Maybe Text)

The vault ARN at which to continue pagination of the results. You use the marker in another List Vaults request to obtain more vaults in the list.

lvrsVaultList :: Lens' ListVaultsResponse [DescribeVaultOutput]

List of vaults.

lvrsResponseStatus :: Lens' ListVaultsResponse Int

• - | The response status code.