amazonka-ses-2.0: Amazon Simple Email Service 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.SES.ListTemplates

Description

Lists the email templates present in your Amazon SES account in the current AWS Region.

You can execute this operation no more than once per second.

This operation returns paginated results.

Synopsis

Creating a Request

data ListTemplates Source #

See: newListTemplates smart constructor.

Constructors

ListTemplates' 

Fields

  • maxItems :: Maybe Int

    The maximum number of templates to return. This value must be at least 1 and less than or equal to 10. If you do not specify a value, or if you specify a value less than 1 or greater than 10, the operation will return up to 10 results.

  • nextToken :: Maybe Text

    A token returned from a previous call to ListTemplates to indicate the position in the list of email templates.

Instances

Instances details
ToHeaders ListTemplates Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

ToPath ListTemplates Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

ToQuery ListTemplates Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

AWSPager ListTemplates Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

AWSRequest ListTemplates Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

Associated Types

type AWSResponse ListTemplates #

Generic ListTemplates Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

Associated Types

type Rep ListTemplates :: Type -> Type #

Read ListTemplates Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

Show ListTemplates Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

NFData ListTemplates Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

Methods

rnf :: ListTemplates -> () #

Eq ListTemplates Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

Hashable ListTemplates Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

type AWSResponse ListTemplates Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

type Rep ListTemplates Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

type Rep ListTemplates = D1 ('MetaData "ListTemplates" "Amazonka.SES.ListTemplates" "amazonka-ses-2.0-Gc6VkOIX7Sd2eunWehphuf" 'False) (C1 ('MetaCons "ListTemplates'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") '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:

$sel:maxItems:ListTemplates', listTemplates_maxItems - The maximum number of templates to return. This value must be at least 1 and less than or equal to 10. If you do not specify a value, or if you specify a value less than 1 or greater than 10, the operation will return up to 10 results.

ListTemplates, listTemplates_nextToken - A token returned from a previous call to ListTemplates to indicate the position in the list of email templates.

Request Lenses

listTemplates_maxItems :: Lens' ListTemplates (Maybe Int) Source #

The maximum number of templates to return. This value must be at least 1 and less than or equal to 10. If you do not specify a value, or if you specify a value less than 1 or greater than 10, the operation will return up to 10 results.

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

A token returned from a previous call to ListTemplates to indicate the position in the list of email templates.

Destructuring the Response

data ListTemplatesResponse Source #

See: newListTemplatesResponse smart constructor.

Constructors

ListTemplatesResponse' 

Fields

  • nextToken :: Maybe Text

    A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next 50 email templates.

  • templatesMetadata :: Maybe [TemplateMetadata]

    An array the contains the name and creation time stamp for each template in your Amazon SES account.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListTemplatesResponse Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

Associated Types

type Rep ListTemplatesResponse :: Type -> Type #

Read ListTemplatesResponse Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

Show ListTemplatesResponse Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

NFData ListTemplatesResponse Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

Methods

rnf :: ListTemplatesResponse -> () #

Eq ListTemplatesResponse Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

type Rep ListTemplatesResponse Source # 
Instance details

Defined in Amazonka.SES.ListTemplates

type Rep ListTemplatesResponse = D1 ('MetaData "ListTemplatesResponse" "Amazonka.SES.ListTemplates" "amazonka-ses-2.0-Gc6VkOIX7Sd2eunWehphuf" 'False) (C1 ('MetaCons "ListTemplatesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "templatesMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TemplateMetadata])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTemplatesResponse Source #

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:

ListTemplates, listTemplatesResponse_nextToken - A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next 50 email templates.

$sel:templatesMetadata:ListTemplatesResponse', listTemplatesResponse_templatesMetadata - An array the contains the name and creation time stamp for each template in your Amazon SES account.

$sel:httpStatus:ListTemplatesResponse', listTemplatesResponse_httpStatus - The response's http status code.

Response Lenses

listTemplatesResponse_nextToken :: Lens' ListTemplatesResponse (Maybe Text) Source #

A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next 50 email templates.

listTemplatesResponse_templatesMetadata :: Lens' ListTemplatesResponse (Maybe [TemplateMetadata]) Source #

An array the contains the name and creation time stamp for each template in your Amazon SES account.