Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Backup.ListBackupPlans

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

This operation returns paginated results.

Creating a Request

data ListBackupPlans Source #

See: newListBackupPlans smart constructor.

Constructors

ListBackupPlans'

Fields

includeDeleted :: Maybe Bool
A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.
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 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 #
AWSPager ListBackupPlans Source #
Instance details Defined in Amazonka.Backup.ListBackupPlans Methods page :: ListBackupPlans -> AWSResponse ListBackupPlans -> Maybe ListBackupPlans #
AWSRequest ListBackupPlans Source #
Instance details Defined in Amazonka.Backup.ListBackupPlans Associated Types type AWSResponse ListBackupPlans # Methods request :: (Service -> Service) -> ListBackupPlans -> Request ListBackupPlans # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListBackupPlans -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListBackupPlans))) #
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 #
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 #
NFData ListBackupPlans Source #
Instance details Defined in Amazonka.Backup.ListBackupPlans Methods rnf :: ListBackupPlans -> () #
Eq ListBackupPlans Source #
Instance details Defined in Amazonka.Backup.ListBackupPlans Methods (==) :: ListBackupPlans -> ListBackupPlans -> Bool # (/=) :: ListBackupPlans -> ListBackupPlans -> Bool #
Hashable ListBackupPlans Source #
Instance details Defined in Amazonka.Backup.ListBackupPlans Methods hashWithSalt :: Int -> ListBackupPlans -> Int # hash :: ListBackupPlans -> Int #
type AWSResponse ListBackupPlans Source #
Instance details Defined in Amazonka.Backup.ListBackupPlans type AWSResponse ListBackupPlans = ListBackupPlansResponse
type Rep ListBackupPlans Source #
Instance details Defined in Amazonka.Backup.ListBackupPlans type Rep ListBackupPlans = D1 ('MetaData "ListBackupPlans" "Amazonka.Backup.ListBackupPlans" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ListBackupPlans'" 'PrefixI 'True) (S1 ('MetaSel ('Just "includeDeleted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

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:includeDeleted:ListBackupPlans', listBackupPlans_includeDeleted - A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.

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

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.

Request Lenses

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.

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

The maximum number of items to be returned.

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.

Destructuring the Response

data ListBackupPlansResponse Source #

See: newListBackupPlansResponse smart constructor.

Constructors

ListBackupPlansResponse'

Fields

backupPlansList :: Maybe [BackupPlansListMember]
An array of backup plan list items containing metadata about your saved backup plans.
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 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 #
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 #
NFData ListBackupPlansResponse Source #
Instance details Defined in Amazonka.Backup.ListBackupPlans Methods rnf :: ListBackupPlansResponse -> () #
Eq ListBackupPlansResponse Source #
Instance details Defined in Amazonka.Backup.ListBackupPlans Methods (==) :: ListBackupPlansResponse -> ListBackupPlansResponse -> Bool # (/=) :: ListBackupPlansResponse -> ListBackupPlansResponse -> Bool #
type Rep ListBackupPlansResponse Source #
Instance details Defined in Amazonka.Backup.ListBackupPlans type Rep ListBackupPlansResponse = D1 ('MetaData "ListBackupPlansResponse" "Amazonka.Backup.ListBackupPlans" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ListBackupPlansResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupPlansList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BackupPlansListMember])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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:backupPlansList:ListBackupPlansResponse', listBackupPlansResponse_backupPlansList - An array of backup plan list items containing metadata about your saved backup plans.

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:httpStatus:ListBackupPlansResponse', listBackupPlansResponse_httpStatus - The response's http status code.

Response Lenses

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

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

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

The response's http status code.