libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email
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.PinpointEmail.ListConfigurationSets

Description

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

This operation returns paginated results.

Synopsis

Creating a Request

data ListConfigurationSets Source #

A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS Region.

See: newListConfigurationSets smart constructor.

Constructors

ListConfigurationSets' 

Fields

  • nextToken :: Maybe Text

    A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.

  • pageSize :: Maybe Int

    The number of results to show in a single call to ListConfigurationSets. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

Instances

Instances details
Eq ListConfigurationSets Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

Read ListConfigurationSets Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

Show ListConfigurationSets Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

Generic ListConfigurationSets Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

Associated Types

type Rep ListConfigurationSets :: Type -> Type #

NFData ListConfigurationSets Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

Methods

rnf :: ListConfigurationSets -> () #

Hashable ListConfigurationSets Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

AWSPager ListConfigurationSets Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

AWSRequest ListConfigurationSets Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

Associated Types

type AWSResponse ListConfigurationSets #

ToHeaders ListConfigurationSets Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

ToPath ListConfigurationSets Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

ToQuery ListConfigurationSets Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

type Rep ListConfigurationSets Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

type Rep ListConfigurationSets = D1 ('MetaData "ListConfigurationSets" "Amazonka.PinpointEmail.ListConfigurationSets" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "ListConfigurationSets'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))
type AWSResponse ListConfigurationSets Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

newListConfigurationSets :: ListConfigurationSets Source #

Create a value of ListConfigurationSets 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:ListConfigurationSets', listConfigurationSets_nextToken - A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.

$sel:pageSize:ListConfigurationSets', listConfigurationSets_pageSize - The number of results to show in a single call to ListConfigurationSets. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

Request Lenses

listConfigurationSets_nextToken :: Lens' ListConfigurationSets (Maybe Text) Source #

A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.

listConfigurationSets_pageSize :: Lens' ListConfigurationSets (Maybe Int) Source #

The number of results to show in a single call to ListConfigurationSets. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

Destructuring the Response

data ListConfigurationSetsResponse Source #

A list of configuration sets in your Amazon Pinpoint account in the current AWS Region.

See: newListConfigurationSetsResponse smart constructor.

Constructors

ListConfigurationSetsResponse' 

Fields

  • configurationSets :: Maybe [Text]

    An array that contains all of the configuration sets in your Amazon Pinpoint account in the current AWS Region.

  • nextToken :: Maybe Text

    A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListConfigurationSets, and pass this token in the NextToken parameter.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListConfigurationSetsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

Read ListConfigurationSetsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

Show ListConfigurationSetsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

Generic ListConfigurationSetsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

Associated Types

type Rep ListConfigurationSetsResponse :: Type -> Type #

NFData ListConfigurationSetsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

type Rep ListConfigurationSetsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListConfigurationSets

type Rep ListConfigurationSetsResponse = D1 ('MetaData "ListConfigurationSetsResponse" "Amazonka.PinpointEmail.ListConfigurationSets" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "ListConfigurationSetsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "configurationSets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListConfigurationSetsResponse Source #

Create a value of ListConfigurationSetsResponse 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:configurationSets:ListConfigurationSetsResponse', listConfigurationSetsResponse_configurationSets - An array that contains all of the configuration sets in your Amazon Pinpoint account in the current AWS Region.

$sel:nextToken:ListConfigurationSets', listConfigurationSetsResponse_nextToken - A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListConfigurationSets, and pass this token in the NextToken parameter.

$sel:httpStatus:ListConfigurationSetsResponse', listConfigurationSetsResponse_httpStatus - The response's http status code.

Response Lenses

listConfigurationSetsResponse_configurationSets :: Lens' ListConfigurationSetsResponse (Maybe [Text]) Source #

An array that contains all of the configuration sets in your Amazon Pinpoint account in the current AWS Region.

listConfigurationSetsResponse_nextToken :: Lens' ListConfigurationSetsResponse (Maybe Text) Source #

A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListConfigurationSets, and pass this token in the NextToken parameter.