amazonka-backup-2.0: Amazon Backup 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.Backup.ListBackupVaults

Description

Returns a list of recovery point storage containers along with information about them.

This operation returns paginated results.

Synopsis

Creating a Request

data ListBackupVaults Source #

See: newListBackupVaults smart constructor.

Constructors

ListBackupVaults' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of items to be returned.

  • nextToken :: Maybe Text

    The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Instances

Instances details
ToHeaders ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Methods

toHeaders :: ListBackupVaults -> [Header] #

ToPath ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Methods

toPath :: ListBackupVaults -> ByteString #

ToQuery ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Methods

toQuery :: ListBackupVaults -> QueryString #

AWSPager ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Methods

page :: ListBackupVaults -> AWSResponse ListBackupVaults -> Maybe ListBackupVaults #

AWSRequest ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Associated Types

type AWSResponse ListBackupVaults #

Methods

request :: (Service -> Service) -> ListBackupVaults -> Request ListBackupVaults #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListBackupVaults -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListBackupVaults))) #

Generic ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Associated Types

type Rep ListBackupVaults :: Type -> Type #

Methods

from :: ListBackupVaults -> Rep ListBackupVaults x #

to :: Rep ListBackupVaults x -> ListBackupVaults #

Read ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Methods

readsPrec :: Int -> ReadS ListBackupVaults #

readList :: ReadS [ListBackupVaults] #

readPrec :: ReadPrec ListBackupVaults #

readListPrec :: ReadPrec [ListBackupVaults] #

Show ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Methods

showsPrec :: Int -> ListBackupVaults -> ShowS #

show :: ListBackupVaults -> String #

showList :: [ListBackupVaults] -> ShowS #

NFData ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Methods

rnf :: ListBackupVaults -> () #

Eq ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Methods

(==) :: ListBackupVaults -> ListBackupVaults -> Bool #

(/=) :: ListBackupVaults -> ListBackupVaults -> Bool #

Hashable ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Methods

hashWithSalt :: Int -> ListBackupVaults -> Int #

hash :: ListBackupVaults -> Int #

type AWSResponse ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

type AWSResponse ListBackupVaults = ListBackupVaultsResponse
type Rep ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

type Rep ListBackupVaults = D1 ('MetaData "ListBackupVaults" "Amazonka.Backup.ListBackupVaults" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ListBackupVaults'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListBackupVaults :: ListBackupVaults Source #

Create a value of ListBackupVaults 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:maxResults:ListBackupVaults', listBackupVaults_maxResults - The maximum number of items to be returned.

ListBackupVaults, listBackupVaults_nextToken - The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Request Lenses

listBackupVaults_maxResults :: Lens' ListBackupVaults (Maybe Natural) Source #

The maximum number of items to be returned.

listBackupVaults_nextToken :: Lens' ListBackupVaults (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Destructuring the Response

data ListBackupVaultsResponse Source #

See: newListBackupVaultsResponse smart constructor.

Constructors

ListBackupVaultsResponse' 

Fields

  • backupVaultList :: Maybe [BackupVaultListMember]

    An array of backup vault list members containing vault metadata, including Amazon Resource Name (ARN), display name, creation date, number of saved recovery points, and encryption information if the resources saved in the backup vault are encrypted.

  • nextToken :: Maybe Text

    The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListBackupVaultsResponse Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Associated Types

type Rep ListBackupVaultsResponse :: Type -> Type #

Methods

from :: ListBackupVaultsResponse -> Rep ListBackupVaultsResponse x #

to :: Rep ListBackupVaultsResponse x -> ListBackupVaultsResponse #

Read ListBackupVaultsResponse Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Methods

readsPrec :: Int -> ReadS ListBackupVaultsResponse #

readList :: ReadS [ListBackupVaultsResponse] #

readPrec :: ReadPrec ListBackupVaultsResponse #

readListPrec :: ReadPrec [ListBackupVaultsResponse] #

Show ListBackupVaultsResponse Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Methods

showsPrec :: Int -> ListBackupVaultsResponse -> ShowS #

show :: ListBackupVaultsResponse -> String #

showList :: [ListBackupVaultsResponse] -> ShowS #

NFData ListBackupVaultsResponse Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Methods

rnf :: ListBackupVaultsResponse -> () #

Eq ListBackupVaultsResponse Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Methods

(==) :: ListBackupVaultsResponse -> ListBackupVaultsResponse -> Bool #

(/=) :: ListBackupVaultsResponse -> ListBackupVaultsResponse -> Bool #

type Rep ListBackupVaultsResponse Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

type Rep ListBackupVaultsResponse = D1 ('MetaData "ListBackupVaultsResponse" "Amazonka.Backup.ListBackupVaults" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ListBackupVaultsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupVaultList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BackupVaultListMember])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListBackupVaultsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListBackupVaultsResponse'

-> ListBackupVaultsResponse 

Create a value of ListBackupVaultsResponse 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:backupVaultList:ListBackupVaultsResponse', listBackupVaultsResponse_backupVaultList - An array of backup vault list members containing vault metadata, including Amazon Resource Name (ARN), display name, creation date, number of saved recovery points, and encryption information if the resources saved in the backup vault are encrypted.

ListBackupVaults, listBackupVaultsResponse_nextToken - The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

$sel:httpStatus:ListBackupVaultsResponse', listBackupVaultsResponse_httpStatus - The response's http status code.

Response Lenses

listBackupVaultsResponse_backupVaultList :: Lens' ListBackupVaultsResponse (Maybe [BackupVaultListMember]) Source #

An array of backup vault list members containing vault metadata, including Amazon Resource Name (ARN), display name, creation date, number of saved recovery points, and encryption information if the resources saved in the backup vault are encrypted.

listBackupVaultsResponse_nextToken :: Lens' ListBackupVaultsResponse (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listBackupVaultsResponse_httpStatus :: Lens' ListBackupVaultsResponse Int Source #

The response's http status code.