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.
Note
It's recommended that for successive pagination calls of this API, you continue to
the use the same parameter/value pairs as used in the original call, e.g., if you
used IdentityType=Domain
in the the original call and received a
NextToken
in the response, you should continue providing the
IdentityType=Domain
parameter for further NextToken
calls; however, if you didn't provide the IdentityType
parameter in the
original call, then continue to not provide it for successive pagination calls.
Using this protocol will ensure consistent results.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- IdentityType
-
The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities are listed.
Type: String
Valid Values:
EmailAddress | Domain
Required: No
- MaxItems
-
The maximum number of identities per page. Possible values are 1-1000 inclusive.
Type: Integer
Required: No
- NextToken
-
The token to use for pagination.
Type: String
Required: No
Response Elements
The following elements are returned by the service.
- Identities.member.N
-
A list of identities.
Type: Array of strings
- NextToken
-
The token used for pagination.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: