Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class ListIdentitiesCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { SESClient, ListIdentitiesCommand } from "@aws-sdk/client-ses"; // ES Modules import
// const { SESClient, ListIdentitiesCommand } = require("@aws-sdk/client-ses"); // CommonJS import
const client = new SESClient(config);
const input = { // ListIdentitiesRequest
IdentityType: "STRING_VALUE",
NextToken: "STRING_VALUE",
MaxItems: Number("int"),
};
const command = new ListIdentitiesCommand(input);
const response = await client.send(command);
// { // ListIdentitiesResponse
// Identities: [ // IdentityList // required
// "STRING_VALUE",
// ],
// NextToken: "STRING_VALUE",
// };

Param

ListIdentitiesCommandInput

Returns

ListIdentitiesCommandOutput

See

Throws

SESServiceException

Base exception class for all service exceptions from SES service.

Example

ListIdentities

// The following example lists the email address identities that have been submitted for verification with Amazon SES:
const input = {
"IdentityType": "EmailAddress",
"MaxItems": 123,
"NextToken": ""
};
const command = new ListIdentitiesCommand(input);
const response = await client.send(command);
/* response ==
{
"Identities": [
"user@example.com"
],
"NextToken": ""
}
*/
// example id: listidentities-1469048638493

Hierarchy

Constructors

Properties

middlewareStack: MiddlewareStack<ListIdentitiesCommandInput, ListIdentitiesCommandOutput>

Methods