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

Description

Returns a list of all of the email identities that are associated with your Amazon Pinpoint account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't.

This operation returns paginated results.

Synopsis

Creating a Request

data ListEmailIdentities Source #

A request to list all of the email identities associated with your Amazon Pinpoint account. This list includes identities that you've already verified, identities that are unverified, and identities that were verified in the past, but are no longer verified.

See: newListEmailIdentities smart constructor.

Constructors

ListEmailIdentities' 

Fields

  • nextToken :: Maybe Text

    A token returned from a previous call to ListEmailIdentities to indicate the position in the list of identities.

  • pageSize :: Maybe Int

    The number of results to show in a single call to ListEmailIdentities. 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.

    The value you specify has to be at least 0, and can be no more than 1000.

Instances

Instances details
Eq ListEmailIdentities Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListEmailIdentities

Read ListEmailIdentities Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListEmailIdentities

Show ListEmailIdentities Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListEmailIdentities

Generic ListEmailIdentities Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListEmailIdentities

Associated Types

type Rep ListEmailIdentities :: Type -> Type #

NFData ListEmailIdentities Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListEmailIdentities

Methods

rnf :: ListEmailIdentities -> () #

Hashable ListEmailIdentities Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListEmailIdentities

AWSPager ListEmailIdentities Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListEmailIdentities

AWSRequest ListEmailIdentities Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListEmailIdentities

Associated Types

type AWSResponse ListEmailIdentities #

ToHeaders ListEmailIdentities Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListEmailIdentities

ToPath ListEmailIdentities Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListEmailIdentities

ToQuery ListEmailIdentities Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListEmailIdentities

type Rep ListEmailIdentities Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListEmailIdentities

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

Defined in Amazonka.PinpointEmail.ListEmailIdentities

newListEmailIdentities :: ListEmailIdentities Source #

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

$sel:pageSize:ListEmailIdentities', listEmailIdentities_pageSize - The number of results to show in a single call to ListEmailIdentities. 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.

The value you specify has to be at least 0, and can be no more than 1000.

Request Lenses

listEmailIdentities_nextToken :: Lens' ListEmailIdentities (Maybe Text) Source #

A token returned from a previous call to ListEmailIdentities to indicate the position in the list of identities.

listEmailIdentities_pageSize :: Lens' ListEmailIdentities (Maybe Int) Source #

The number of results to show in a single call to ListEmailIdentities. 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.

The value you specify has to be at least 0, and can be no more than 1000.

Destructuring the Response

data ListEmailIdentitiesResponse Source #

A list of all of the identities that you've attempted to verify for use with Amazon Pinpoint, regardless of whether or not those identities were successfully verified.

See: newListEmailIdentitiesResponse smart constructor.

Constructors

ListEmailIdentitiesResponse' 

Fields

  • nextToken :: Maybe Text

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

  • emailIdentities :: Maybe [IdentityInfo]

    An array that includes all of the identities associated with your Amazon Pinpoint account.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListEmailIdentitiesResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListEmailIdentities

Read ListEmailIdentitiesResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListEmailIdentities

Show ListEmailIdentitiesResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListEmailIdentities

Generic ListEmailIdentitiesResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListEmailIdentities

Associated Types

type Rep ListEmailIdentitiesResponse :: Type -> Type #

NFData ListEmailIdentitiesResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListEmailIdentities

type Rep ListEmailIdentitiesResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListEmailIdentities

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

newListEmailIdentitiesResponse Source #

Create a value of ListEmailIdentitiesResponse 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:ListEmailIdentities', listEmailIdentitiesResponse_nextToken - A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListEmailIdentities, and pass this token in the NextToken parameter.

$sel:emailIdentities:ListEmailIdentitiesResponse', listEmailIdentitiesResponse_emailIdentities - An array that includes all of the identities associated with your Amazon Pinpoint account.

$sel:httpStatus:ListEmailIdentitiesResponse', listEmailIdentitiesResponse_httpStatus - The response's http status code.

Response Lenses

listEmailIdentitiesResponse_nextToken :: Lens' ListEmailIdentitiesResponse (Maybe Text) Source #

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

listEmailIdentitiesResponse_emailIdentities :: Lens' ListEmailIdentitiesResponse (Maybe [IdentityInfo]) Source #

An array that includes all of the identities associated with your Amazon Pinpoint account.