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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.

This operation returns paginated results.

Synopsis

Creating a Request

data ListBackupPlanTemplates Source #

See: newListBackupPlanTemplates smart constructor.

Constructors

ListBackupPlanTemplates'
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 ListBackupPlanTemplates Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates Methods toHeaders :: ListBackupPlanTemplates -> [Header] #
ToPath ListBackupPlanTemplates Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates Methods toPath :: ListBackupPlanTemplates -> ByteString #
ToQuery ListBackupPlanTemplates Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates Methods toQuery :: ListBackupPlanTemplates -> QueryString #
AWSPager ListBackupPlanTemplates Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates Methods page :: ListBackupPlanTemplates -> AWSResponse ListBackupPlanTemplates -> Maybe ListBackupPlanTemplates #
AWSRequest ListBackupPlanTemplates Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates Associated Types type AWSResponse ListBackupPlanTemplates # Methods request :: (Service -> Service) -> ListBackupPlanTemplates -> Request ListBackupPlanTemplates # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListBackupPlanTemplates -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListBackupPlanTemplates))) #
Generic ListBackupPlanTemplates Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates Associated Types type Rep ListBackupPlanTemplates :: Type -> Type # Methods from :: ListBackupPlanTemplates -> Rep ListBackupPlanTemplates x # to :: Rep ListBackupPlanTemplates x -> ListBackupPlanTemplates #
Read ListBackupPlanTemplates Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates Methods readsPrec :: Int -> ReadS ListBackupPlanTemplates # readList :: ReadS [ListBackupPlanTemplates] # readPrec :: ReadPrec ListBackupPlanTemplates # readListPrec :: ReadPrec [ListBackupPlanTemplates] #
Show ListBackupPlanTemplates Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates Methods showsPrec :: Int -> ListBackupPlanTemplates -> ShowS # show :: ListBackupPlanTemplates -> String # showList :: [ListBackupPlanTemplates] -> ShowS #
NFData ListBackupPlanTemplates Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates Methods rnf :: ListBackupPlanTemplates -> () #
Eq ListBackupPlanTemplates Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates Methods (==) :: ListBackupPlanTemplates -> ListBackupPlanTemplates -> Bool # (/=) :: ListBackupPlanTemplates -> ListBackupPlanTemplates -> Bool #
Hashable ListBackupPlanTemplates Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates Methods hashWithSalt :: Int -> ListBackupPlanTemplates -> Int # hash :: ListBackupPlanTemplates -> Int #
type AWSResponse ListBackupPlanTemplates Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates type AWSResponse ListBackupPlanTemplates = ListBackupPlanTemplatesResponse
type Rep ListBackupPlanTemplates Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates type Rep ListBackupPlanTemplates = D1 ('MetaData "ListBackupPlanTemplates" "Amazonka.Backup.ListBackupPlanTemplates" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ListBackupPlanTemplates'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListBackupPlanTemplates :: ListBackupPlanTemplates Source #

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

ListBackupPlanTemplates, listBackupPlanTemplates_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

listBackupPlanTemplates_maxResults :: Lens' ListBackupPlanTemplates (Maybe Natural) Source #

The maximum number of items to be returned.

listBackupPlanTemplates_nextToken :: Lens' ListBackupPlanTemplates (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 ListBackupPlanTemplatesResponse Source #

See: newListBackupPlanTemplatesResponse smart constructor.

Constructors

ListBackupPlanTemplatesResponse'

Fields

backupPlanTemplatesList :: Maybe [BackupPlanTemplatesListMember]
An array of template list items containing metadata about your saved templates.
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 ListBackupPlanTemplatesResponse Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates Associated Types type Rep ListBackupPlanTemplatesResponse :: Type -> Type # Methods from :: ListBackupPlanTemplatesResponse -> Rep ListBackupPlanTemplatesResponse x # to :: Rep ListBackupPlanTemplatesResponse x -> ListBackupPlanTemplatesResponse #
Read ListBackupPlanTemplatesResponse Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates Methods readsPrec :: Int -> ReadS ListBackupPlanTemplatesResponse # readList :: ReadS [ListBackupPlanTemplatesResponse] # readPrec :: ReadPrec ListBackupPlanTemplatesResponse # readListPrec :: ReadPrec [ListBackupPlanTemplatesResponse] #
Show ListBackupPlanTemplatesResponse Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates Methods showsPrec :: Int -> ListBackupPlanTemplatesResponse -> ShowS # show :: ListBackupPlanTemplatesResponse -> String # showList :: [ListBackupPlanTemplatesResponse] -> ShowS #
NFData ListBackupPlanTemplatesResponse Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates Methods rnf :: ListBackupPlanTemplatesResponse -> () #
Eq ListBackupPlanTemplatesResponse Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates Methods (==) :: ListBackupPlanTemplatesResponse -> ListBackupPlanTemplatesResponse -> Bool # (/=) :: ListBackupPlanTemplatesResponse -> ListBackupPlanTemplatesResponse -> Bool #
type Rep ListBackupPlanTemplatesResponse Source #
Instance details Defined in Amazonka.Backup.ListBackupPlanTemplates type Rep ListBackupPlanTemplatesResponse = D1 ('MetaData "ListBackupPlanTemplatesResponse" "Amazonka.Backup.ListBackupPlanTemplates" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ListBackupPlanTemplatesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupPlanTemplatesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BackupPlanTemplatesListMember])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListBackupPlanTemplatesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListBackupPlanTemplatesResponse'`
-> ListBackupPlanTemplatesResponse

Create a value of ListBackupPlanTemplatesResponse 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:backupPlanTemplatesList:ListBackupPlanTemplatesResponse', listBackupPlanTemplatesResponse_backupPlanTemplatesList - An array of template list items containing metadata about your saved templates.

ListBackupPlanTemplates, listBackupPlanTemplatesResponse_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:ListBackupPlanTemplatesResponse', listBackupPlanTemplatesResponse_httpStatus - The response's http status code.

Response Lenses

listBackupPlanTemplatesResponse_backupPlanTemplatesList :: Lens' ListBackupPlanTemplatesResponse (Maybe [BackupPlanTemplatesListMember]) Source #

An array of template list items containing metadata about your saved templates.

listBackupPlanTemplatesResponse_nextToken :: Lens' ListBackupPlanTemplatesResponse (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.

listBackupPlanTemplatesResponse_httpStatus :: Lens' ListBackupPlanTemplatesResponse Int Source #

The response's http status code.