Amazonka.SES.ListIdentities

Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status.

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

This operation returns paginated results.

Creating a Request

data ListIdentities

Represents a request to return a list of all identities (email addresses and domains) that you have attempted to verify under your AWS account, regardless of verification status.

See: newListIdentities smart constructor.

Constructors

ListIdentities'

Fields

• identityType :: Maybe IdentityType

  The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities will be listed.

• maxItems :: Maybe Int

  The maximum number of identities per page. Possible values are 1-1000 inclusive.

• nextToken :: Maybe Text

  The token to use for pagination.

Instances

ToHeaders ListIdentities

Defined in Amazonka.SES.ListIdentities

Methods

toHeaders :: ListIdentities -> [Header]

ToPath ListIdentities

Defined in Amazonka.SES.ListIdentities

Methods

toPath :: ListIdentities -> ByteString

ToQuery ListIdentities

Defined in Amazonka.SES.ListIdentities

Methods

toQuery :: ListIdentities -> QueryString

AWSPager ListIdentities

Defined in Amazonka.SES.ListIdentities

Methods

page :: ListIdentities -> AWSResponse ListIdentities -> Maybe ListIdentities

AWSRequest ListIdentities

Defined in Amazonka.SES.ListIdentities

Associated Types

type AWSResponse ListIdentities

Methods

request :: (Service -> Service) -> ListIdentities -> Request ListIdentities

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

Generic ListIdentities

Defined in Amazonka.SES.ListIdentities

Associated Types

type Rep ListIdentities :: Type -> Type

Methods

from :: ListIdentities -> Rep ListIdentities x

to :: Rep ListIdentities x -> ListIdentities

Read ListIdentities

Defined in Amazonka.SES.ListIdentities

Methods

readsPrec :: Int -> ReadS ListIdentities

readList :: ReadS [ListIdentities]

readPrec :: ReadPrec ListIdentities

readListPrec :: ReadPrec [ListIdentities]

Show ListIdentities

Defined in Amazonka.SES.ListIdentities

Methods

showsPrec :: Int -> ListIdentities -> ShowS

show :: ListIdentities -> String

showList :: [ListIdentities] -> ShowS

NFData ListIdentities

Defined in Amazonka.SES.ListIdentities

Methods

rnf :: ListIdentities -> ()

Eq ListIdentities

Defined in Amazonka.SES.ListIdentities

Methods

(==) :: ListIdentities -> ListIdentities -> Bool

(/=) :: ListIdentities -> ListIdentities -> Bool

Hashable ListIdentities

Defined in Amazonka.SES.ListIdentities

Methods

hashWithSalt :: Int -> ListIdentities -> Int

hash :: ListIdentities -> Int

type AWSResponse ListIdentities

Defined in Amazonka.SES.ListIdentities

type AWSResponse ListIdentities = ListIdentitiesResponse

type Rep ListIdentities

Defined in Amazonka.SES.ListIdentities

type Rep ListIdentities = D1 ('MetaData "ListIdentities" "Amazonka.SES.ListIdentities" "amazonka-ses-2.0-Gc6VkOIX7Sd2eunWehphuf" 'False) (C1 ('MetaCons "ListIdentities'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityType)) :*: (S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListIdentities :: ListIdentities

Create a value of ListIdentities 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:identityType:ListIdentities', listIdentities_identityType - The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities will be listed.

$sel:maxItems:ListIdentities', listIdentities_maxItems - The maximum number of identities per page. Possible values are 1-1000 inclusive.

ListIdentities, listIdentities_nextToken - The token to use for pagination.

Request Lenses

listIdentities_identityType :: Lens' ListIdentities (Maybe IdentityType)

The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities will be listed.

listIdentities_maxItems :: Lens' ListIdentities (Maybe Int)

The maximum number of identities per page. Possible values are 1-1000 inclusive.

listIdentities_nextToken :: Lens' ListIdentities (Maybe Text)

The token to use for pagination.

Destructuring the Response

data ListIdentitiesResponse

A list of all identities that you have attempted to verify under your AWS account, regardless of verification status.

See: newListIdentitiesResponse smart constructor.

Constructors

ListIdentitiesResponse'

Fields

• nextToken :: Maybe Text

  The token used for pagination.

• httpStatus :: Int

  The response's http status code.

• identities :: [Text]

  A list of identities.

Instances

Generic ListIdentitiesResponse

Defined in Amazonka.SES.ListIdentities

Associated Types

type Rep ListIdentitiesResponse :: Type -> Type

Methods

from :: ListIdentitiesResponse -> Rep ListIdentitiesResponse x

to :: Rep ListIdentitiesResponse x -> ListIdentitiesResponse

Read ListIdentitiesResponse

Defined in Amazonka.SES.ListIdentities

Methods

readsPrec :: Int -> ReadS ListIdentitiesResponse

readList :: ReadS [ListIdentitiesResponse]

readPrec :: ReadPrec ListIdentitiesResponse

readListPrec :: ReadPrec [ListIdentitiesResponse]

Show ListIdentitiesResponse

Defined in Amazonka.SES.ListIdentities

Methods

showsPrec :: Int -> ListIdentitiesResponse -> ShowS

show :: ListIdentitiesResponse -> String

showList :: [ListIdentitiesResponse] -> ShowS

NFData ListIdentitiesResponse

Defined in Amazonka.SES.ListIdentities

Methods

rnf :: ListIdentitiesResponse -> ()

Eq ListIdentitiesResponse

Defined in Amazonka.SES.ListIdentities

Methods

(==) :: ListIdentitiesResponse -> ListIdentitiesResponse -> Bool

(/=) :: ListIdentitiesResponse -> ListIdentitiesResponse -> Bool

type Rep ListIdentitiesResponse

Defined in Amazonka.SES.ListIdentities

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

newListIdentitiesResponse

Arguments

:: Int

$sel:httpStatus:ListIdentitiesResponse'

-> ListIdentitiesResponse

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

ListIdentities, listIdentitiesResponse_nextToken - The token used for pagination.

$sel:httpStatus:ListIdentitiesResponse', listIdentitiesResponse_httpStatus - The response's http status code.

$sel:identities:ListIdentitiesResponse', listIdentitiesResponse_identities - A list of identities.

Response Lenses

listIdentitiesResponse_nextToken :: Lens' ListIdentitiesResponse (Maybe Text)

The token used for pagination.

listIdentitiesResponse_httpStatus :: Lens' ListIdentitiesResponse Int

The response's http status code.

listIdentitiesResponse_identities :: Lens' ListIdentitiesResponse [Text]

A list of identities.