| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
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
- data ListEmailIdentities = ListEmailIdentities' {}
- newListEmailIdentities :: ListEmailIdentities
- listEmailIdentities_nextToken :: Lens' ListEmailIdentities (Maybe Text)
- listEmailIdentities_pageSize :: Lens' ListEmailIdentities (Maybe Int)
- data ListEmailIdentitiesResponse = ListEmailIdentitiesResponse' {
- nextToken :: Maybe Text
- emailIdentities :: Maybe [IdentityInfo]
- httpStatus :: Int
- newListEmailIdentitiesResponse :: Int -> ListEmailIdentitiesResponse
- listEmailIdentitiesResponse_nextToken :: Lens' ListEmailIdentitiesResponse (Maybe Text)
- listEmailIdentitiesResponse_emailIdentities :: Lens' ListEmailIdentitiesResponse (Maybe [IdentityInfo])
- listEmailIdentitiesResponse_httpStatus :: Lens' ListEmailIdentitiesResponse Int
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
| |
Instances
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
| |
Instances
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.
listEmailIdentitiesResponse_httpStatus :: Lens' ListEmailIdentitiesResponse Int Source #
The response's http status code.