| 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.SES.ListIdentities
Description
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.
Synopsis
- data ListIdentities = ListIdentities' {}
- newListIdentities :: ListIdentities
- listIdentities_identityType :: Lens' ListIdentities (Maybe IdentityType)
- listIdentities_nextToken :: Lens' ListIdentities (Maybe Text)
- listIdentities_maxItems :: Lens' ListIdentities (Maybe Int)
- data ListIdentitiesResponse = ListIdentitiesResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- identities :: [Text]
- newListIdentitiesResponse :: Int -> ListIdentitiesResponse
- listIdentitiesResponse_nextToken :: Lens' ListIdentitiesResponse (Maybe Text)
- listIdentitiesResponse_httpStatus :: Lens' ListIdentitiesResponse Int
- listIdentitiesResponse_identities :: Lens' ListIdentitiesResponse [Text]
Creating a Request
data ListIdentities Source #
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
| |
Instances
newListIdentities :: ListIdentities Source #
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:nextToken:ListIdentities', listIdentities_nextToken - The token to use for pagination.
$sel:maxItems:ListIdentities', listIdentities_maxItems - The maximum number of identities per page. Possible values are 1-1000
inclusive.
Request Lenses
listIdentities_identityType :: Lens' ListIdentities (Maybe IdentityType) Source #
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_nextToken :: Lens' ListIdentities (Maybe Text) Source #
The token to use for pagination.
listIdentities_maxItems :: Lens' ListIdentities (Maybe Int) Source #
The maximum number of identities per page. Possible values are 1-1000 inclusive.
Destructuring the Response
data ListIdentitiesResponse Source #
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
| |
Instances
newListIdentitiesResponse Source #
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:
$sel:nextToken: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) Source #
The token used for pagination.
listIdentitiesResponse_httpStatus :: Lens' ListIdentitiesResponse Int Source #
The response's http status code.
listIdentitiesResponse_identities :: Lens' ListIdentitiesResponse [Text] Source #
A list of identities.