amazonka-pinpoint-2.0: Amazon Pinpoint 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.Pinpoint.ListTemplates

Description

Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.

Synopsis

Creating a Request

data ListTemplates Source #

See: newListTemplates smart constructor.

Constructors

ListTemplates' 

Fields

  • nextToken :: Maybe Text

    The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

  • pageSize :: Maybe Text

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

  • prefix :: Maybe Text

    The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

  • templateType :: Maybe Text

    The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.

Instances

Instances details
ToHeaders ListTemplates Source # 
Instance details

Defined in Amazonka.Pinpoint.ListTemplates

Methods

toHeaders :: ListTemplates -> [Header] #

ToPath ListTemplates Source # 
Instance details

Defined in Amazonka.Pinpoint.ListTemplates

Methods

toPath :: ListTemplates -> ByteString #

ToQuery ListTemplates Source # 
Instance details

Defined in Amazonka.Pinpoint.ListTemplates

Methods

toQuery :: ListTemplates -> QueryString #

AWSRequest ListTemplates Source # 
Instance details

Defined in Amazonka.Pinpoint.ListTemplates

Associated Types

type AWSResponse ListTemplates #

Methods

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

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

Generic ListTemplates Source # 
Instance details

Defined in Amazonka.Pinpoint.ListTemplates

Associated Types

type Rep ListTemplates :: Type -> Type #

Methods

from :: ListTemplates -> Rep ListTemplates x #

to :: Rep ListTemplates x -> ListTemplates #

Read ListTemplates Source # 
Instance details

Defined in Amazonka.Pinpoint.ListTemplates

Methods

readsPrec :: Int -> ReadS ListTemplates #

readList :: ReadS [ListTemplates] #

readPrec :: ReadPrec ListTemplates #

readListPrec :: ReadPrec [ListTemplates] #

Show ListTemplates Source # 
Instance details

Defined in Amazonka.Pinpoint.ListTemplates

Methods

showsPrec :: Int -> ListTemplates -> ShowS #

show :: ListTemplates -> String #

showList :: [ListTemplates] -> ShowS #

NFData ListTemplates Source # 
Instance details

Defined in Amazonka.Pinpoint.ListTemplates

Methods

rnf :: ListTemplates -> () #

Eq ListTemplates Source # 
Instance details

Defined in Amazonka.Pinpoint.ListTemplates

Methods

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

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

Hashable ListTemplates Source # 
Instance details

Defined in Amazonka.Pinpoint.ListTemplates

Methods

hashWithSalt :: Int -> ListTemplates -> Int #

hash :: ListTemplates -> Int #

type AWSResponse ListTemplates Source # 
Instance details

Defined in Amazonka.Pinpoint.ListTemplates

type AWSResponse ListTemplates = ListTemplatesResponse
type Rep ListTemplates Source # 
Instance details

Defined in Amazonka.Pinpoint.ListTemplates

type Rep ListTemplates = D1 ('MetaData "ListTemplates" "Amazonka.Pinpoint.ListTemplates" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "ListTemplates'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListTemplates :: ListTemplates Source #

Create a value of ListTemplates 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:

ListTemplates, listTemplates_nextToken - The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

$sel:pageSize:ListTemplates', listTemplates_pageSize - The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

$sel:prefix:ListTemplates', listTemplates_prefix - The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

ListTemplates, listTemplates_templateType - The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.

Request Lenses

listTemplates_nextToken :: Lens' ListTemplates (Maybe Text) Source #

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

listTemplates_pageSize :: Lens' ListTemplates (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

listTemplates_prefix :: Lens' ListTemplates (Maybe Text) Source #

The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

listTemplates_templateType :: Lens' ListTemplates (Maybe Text) Source #

The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.

Destructuring the Response

data ListTemplatesResponse Source #

See: newListTemplatesResponse smart constructor.

Constructors

ListTemplatesResponse' 

Fields

Instances

Instances details
Generic ListTemplatesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.ListTemplates

Associated Types

type Rep ListTemplatesResponse :: Type -> Type #

Methods

from :: ListTemplatesResponse -> Rep ListTemplatesResponse x #

to :: Rep ListTemplatesResponse x -> ListTemplatesResponse #

Read ListTemplatesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.ListTemplates

Methods

readsPrec :: Int -> ReadS ListTemplatesResponse #

readList :: ReadS [ListTemplatesResponse] #

readPrec :: ReadPrec ListTemplatesResponse #

readListPrec :: ReadPrec [ListTemplatesResponse] #

Show ListTemplatesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.ListTemplates

Methods

showsPrec :: Int -> ListTemplatesResponse -> ShowS #

show :: ListTemplatesResponse -> String #

showList :: [ListTemplatesResponse] -> ShowS #

NFData ListTemplatesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.ListTemplates

Methods

rnf :: ListTemplatesResponse -> () #

Eq ListTemplatesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.ListTemplates

Methods

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

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

type Rep ListTemplatesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.ListTemplates

type Rep ListTemplatesResponse = D1 ('MetaData "ListTemplatesResponse" "Amazonka.Pinpoint.ListTemplates" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "ListTemplatesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "templatesResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TemplatesResponse)))

newListTemplatesResponse Source #

Arguments

:: Int

$sel:httpStatus:ListTemplatesResponse'

-> TemplatesResponse

$sel:templatesResponse:ListTemplatesResponse'

-> ListTemplatesResponse 

Create a value of ListTemplatesResponse 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:httpStatus:ListTemplatesResponse', listTemplatesResponse_httpStatus - The response's http status code.

$sel:templatesResponse:ListTemplatesResponse', listTemplatesResponse_templatesResponse - Undocumented member.

Response Lenses

listTemplatesResponse_httpStatus :: Lens' ListTemplatesResponse Int Source #

The response's http status code.

listTemplatesResponse_templatesResponse :: Lens' ListTemplatesResponse TemplatesResponse Source #

Undocumented member.