libZSservicesZSamazonka-backupZSamazonka-backup
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Backup.ListBackupVaults

Description

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

Synopsis

Creating a Request

data ListBackupVaults Source #

See: newListBackupVaults smart constructor.

Constructors

ListBackupVaults' 

Fields

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

  • maxResults :: Maybe Natural

    The maximum number of items to be returned.

Instances

Instances details
Eq ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Methods

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

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

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 #

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 #

NFData ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Methods

rnf :: ListBackupVaults -> () #

Hashable ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Methods

hashWithSalt :: Int -> ListBackupVaults -> Int #

hash :: ListBackupVaults -> Int #

AWSRequest ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Associated Types

type AWSResponse ListBackupVaults #

Methods

request :: ListBackupVaults -> Request ListBackupVaults #

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

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 #

type Rep ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

type Rep ListBackupVaults = D1 ('MetaData "ListBackupVaults" "Amazonka.Backup.ListBackupVaults" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "ListBackupVaults'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse ListBackupVaults Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

type AWSResponse ListBackupVaults = ListBackupVaultsResponse

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:nextToken: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.

$sel:maxResults:ListBackupVaults', listBackupVaults_maxResults - The maximum number of items to be returned.

Request Lenses

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.

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

The maximum number of items to be returned.

Destructuring the Response

data ListBackupVaultsResponse Source #

See: newListBackupVaultsResponse smart constructor.

Constructors

ListBackupVaultsResponse' 

Fields

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

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListBackupVaultsResponse Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Methods

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

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

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 #

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 #

NFData ListBackupVaultsResponse Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

Methods

rnf :: ListBackupVaultsResponse -> () #

type Rep ListBackupVaultsResponse Source # 
Instance details

Defined in Amazonka.Backup.ListBackupVaults

type Rep ListBackupVaultsResponse = D1 ('MetaData "ListBackupVaultsResponse" "Amazonka.Backup.ListBackupVaults" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "ListBackupVaultsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "backupVaultList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BackupVaultListMember])) :*: 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:nextToken: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: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.

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

Response Lenses

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_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_httpStatus :: Lens' ListBackupVaultsResponse Int Source #

The response's http status code.