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

Description

Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.

Synopsis

Creating a Request

data ListBackupPlans Source #

See: newListBackupPlans smart constructor.

Constructors

ListBackupPlans' 

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.

  • includeDeleted :: Maybe Bool

    A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.

Instances

Instances details
Eq ListBackupPlans Source # 
Instance details

Defined in Amazonka.Backup.ListBackupPlans

Methods

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

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

Read ListBackupPlans Source # 
Instance details

Defined in Amazonka.Backup.ListBackupPlans

Methods

readsPrec :: Int -> ReadS ListBackupPlans #

readList :: ReadS [ListBackupPlans] #

readPrec :: ReadPrec ListBackupPlans #

readListPrec :: ReadPrec [ListBackupPlans] #

Show ListBackupPlans Source # 
Instance details

Defined in Amazonka.Backup.ListBackupPlans

Methods

showsPrec :: Int -> ListBackupPlans -> ShowS #

show :: ListBackupPlans -> String #

showList :: [ListBackupPlans] -> ShowS #

Generic ListBackupPlans Source # 
Instance details

Defined in Amazonka.Backup.ListBackupPlans

Associated Types

type Rep ListBackupPlans :: Type -> Type #

Methods

from :: ListBackupPlans -> Rep ListBackupPlans x #

to :: Rep ListBackupPlans x -> ListBackupPlans #

NFData ListBackupPlans Source # 
Instance details

Defined in Amazonka.Backup.ListBackupPlans

Methods

rnf :: ListBackupPlans -> () #

Hashable ListBackupPlans Source # 
Instance details

Defined in Amazonka.Backup.ListBackupPlans

Methods

hashWithSalt :: Int -> ListBackupPlans -> Int #

hash :: ListBackupPlans -> Int #

AWSRequest ListBackupPlans Source # 
Instance details

Defined in Amazonka.Backup.ListBackupPlans

Associated Types

type AWSResponse ListBackupPlans #

Methods

request :: ListBackupPlans -> Request ListBackupPlans #

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

ToHeaders ListBackupPlans Source # 
Instance details

Defined in Amazonka.Backup.ListBackupPlans

Methods

toHeaders :: ListBackupPlans -> [Header] #

ToPath ListBackupPlans Source # 
Instance details

Defined in Amazonka.Backup.ListBackupPlans

Methods

toPath :: ListBackupPlans -> ByteString #

ToQuery ListBackupPlans Source # 
Instance details

Defined in Amazonka.Backup.ListBackupPlans

Methods

toQuery :: ListBackupPlans -> QueryString #

type Rep ListBackupPlans Source # 
Instance details

Defined in Amazonka.Backup.ListBackupPlans

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

Defined in Amazonka.Backup.ListBackupPlans

type AWSResponse ListBackupPlans = ListBackupPlansResponse

newListBackupPlans :: ListBackupPlans Source #

Create a value of ListBackupPlans 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:ListBackupPlans', listBackupPlans_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:ListBackupPlans', listBackupPlans_maxResults - The maximum number of items to be returned.

$sel:includeDeleted:ListBackupPlans', listBackupPlans_includeDeleted - A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.

Request Lenses

listBackupPlans_nextToken :: Lens' ListBackupPlans (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.

listBackupPlans_maxResults :: Lens' ListBackupPlans (Maybe Natural) Source #

The maximum number of items to be returned.

listBackupPlans_includeDeleted :: Lens' ListBackupPlans (Maybe Bool) Source #

A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.

Destructuring the Response

data ListBackupPlansResponse Source #

See: newListBackupPlansResponse smart constructor.

Constructors

ListBackupPlansResponse' 

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.

  • backupPlansList :: Maybe [BackupPlansListMember]

    An array of backup plan list items containing metadata about your saved backup plans.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListBackupPlansResponse Source # 
Instance details

Defined in Amazonka.Backup.ListBackupPlans

Methods

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

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

Read ListBackupPlansResponse Source # 
Instance details

Defined in Amazonka.Backup.ListBackupPlans

Methods

readsPrec :: Int -> ReadS ListBackupPlansResponse #

readList :: ReadS [ListBackupPlansResponse] #

readPrec :: ReadPrec ListBackupPlansResponse #

readListPrec :: ReadPrec [ListBackupPlansResponse] #

Show ListBackupPlansResponse Source # 
Instance details

Defined in Amazonka.Backup.ListBackupPlans

Methods

showsPrec :: Int -> ListBackupPlansResponse -> ShowS #

show :: ListBackupPlansResponse -> String #

showList :: [ListBackupPlansResponse] -> ShowS #

Generic ListBackupPlansResponse Source # 
Instance details

Defined in Amazonka.Backup.ListBackupPlans

Associated Types

type Rep ListBackupPlansResponse :: Type -> Type #

Methods

from :: ListBackupPlansResponse -> Rep ListBackupPlansResponse x #

to :: Rep ListBackupPlansResponse x -> ListBackupPlansResponse #

NFData ListBackupPlansResponse Source # 
Instance details

Defined in Amazonka.Backup.ListBackupPlans

Methods

rnf :: ListBackupPlansResponse -> () #

type Rep ListBackupPlansResponse Source # 
Instance details

Defined in Amazonka.Backup.ListBackupPlans

type Rep ListBackupPlansResponse = D1 ('MetaData "ListBackupPlansResponse" "Amazonka.Backup.ListBackupPlans" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "ListBackupPlansResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "backupPlansList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BackupPlansListMember])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListBackupPlansResponse Source #

Arguments

:: Int

$sel:httpStatus:ListBackupPlansResponse'

-> ListBackupPlansResponse 

Create a value of ListBackupPlansResponse 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:ListBackupPlans', listBackupPlansResponse_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:backupPlansList:ListBackupPlansResponse', listBackupPlansResponse_backupPlansList - An array of backup plan list items containing metadata about your saved backup plans.

$sel:httpStatus:ListBackupPlansResponse', listBackupPlansResponse_httpStatus - The response's http status code.

Response Lenses

listBackupPlansResponse_nextToken :: Lens' ListBackupPlansResponse (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.

listBackupPlansResponse_backupPlansList :: Lens' ListBackupPlansResponse (Maybe [BackupPlansListMember]) Source #

An array of backup plan list items containing metadata about your saved backup plans.

listBackupPlansResponse_httpStatus :: Lens' ListBackupPlansResponse Int Source #

The response's http status code.