Welcome to the Amazon Pinpoint Email API Reference. This guide provides\ninformation about the Amazon Pinpoint Email API (version 1.0), including supported\noperations, data types, parameters, and schemas.
\n\nAmazon Pinpoint is an AWS service that you\ncan use to engage with your customers across multiple messaging channels. You can use\nAmazon Pinpoint to send email, SMS text messages, voice messages, and push notifications. The\nAmazon Pinpoint Email API provides programmatic access to options that are unique to the\nemail channel and supplement the options provided by the Amazon Pinpoint API.
\nIf you're new to Amazon Pinpoint, you might find it helpful to also review the Amazon\nPinpoint Developer Guide. The Amazon Pinpoint Developer\nGuide provides tutorials, code samples, and procedures that demonstrate\nhow to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into\nmobile apps and other types of applications. The guide also provides information about\nkey topics such as Amazon Pinpoint integration with other AWS services and the limits that apply\nto using the service.
\nThe Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint\nfor each of these Regions. For a list of all the Regions and endpoints where the API is\ncurrently available, see AWS Service Endpoints in\nthe Amazon Web Services General Reference. To learn more about AWS Regions, see\nManaging AWS\nRegions in the Amazon Web Services General Reference.
\nIn each Region, AWS maintains multiple Availability Zones. These Availability Zones\nare physically isolated from each other, but are united by private, low-latency,\nhigh-throughput, and highly redundant network connections. These Availability Zones\nenable us to provide very high levels of availability and redundancy, while also\nminimizing latency. To learn more about the number of Availability Zones that are\navailable in each Region, see AWS Global Infrastructure.
\n\n## Installing\n\nTo install this package, use the CLI of your favorite package manager:\n\n- `npm install @aws-sdk/client-pinpoint-email`\n- `yarn add @aws-sdk/client-pinpoint-email`\n- `pnpm add @aws-sdk/client-pinpoint-email`\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands.\nTo send a request, you only need to import the `PinpointEmailClient` and\nthe commands you need, for example `ListConfigurationSetsCommand`:\n\n```js\n// ES5 example\nconst { PinpointEmailClient, ListConfigurationSetsCommand } = require(\"@aws-sdk/client-pinpoint-email\");\n```\n\n```ts\n// ES6+ example\nimport { PinpointEmailClient, ListConfigurationSetsCommand } from \"@aws-sdk/client-pinpoint-email\";\n```\n\n### Usage\n\nTo send a request:\n\n- Instantiate a client with configuration (e.g. credentials, region).\n - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.\n - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.\n- Instantiate a command with input parameters.\n- Call the `send` operation on the client, providing the command object as input.\n\n```js\nconst client = new PinpointEmailClient({ region: \"REGION\" });\n\nconst params = { /** input parameters */ };\nconst command = new ListConfigurationSetsCommand(params);\n```\n\n#### Async/await\n\nWe recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)\noperator to wait for the promise returned by send operation as follows:\n\n```js\n// async/await.\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n // error handling.\n} finally {\n // finally.\n}\n```\n\n#### Promises\n\nYou can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).\n\n```js\nclient\n .send(command)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n })\n .finally(() => {\n // finally.\n });\n```\n\n#### Aggregated client\n\nThe aggregated client class is exported from the same package, but without the \"Client\" suffix.\n\n`PinpointEmail` extends `PinpointEmailClient` and additionally supports all operations, waiters, and paginators as methods.\nThis style may be familiar to you from the AWS SDK for JavaScript v2.\n\nIf you are bundling the AWS SDK, we recommend using only the bare-bones client (`PinpointEmailClient`).\nMore details are in the blog post on\n[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).\n\n```ts\nimport { PinpointEmail } from \"@aws-sdk/client-pinpoint-email\";\n\nconst client = new PinpointEmail({ region: \"REGION\" });\n\n// async/await.\ntry {\n const data = await client.listConfigurationSets(params);\n // process data.\n} catch (error) {\n // error handling.\n}\n\n// Promises.\nclient\n .listConfigurationSets(params)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n });\n\n// callbacks (not recommended).\nclient.listConfigurationSets(params, (err, data) => {\n // process err and data.\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information,\nas well as response metadata (e.g. request id).\n\n```js\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n const { requestId, cfId, extendedRequestId } = error.$metadata;\n console.log({ requestId, cfId, extendedRequestId });\n /**\n * The keys within exceptions are also parsed.\n * You can access them by specifying exception names:\n * if (error.name === 'SomeServiceException') {\n * const value = error.specialKeyInException;\n * }\n */\n}\n```\n\nSee also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).\n\n## Getting Help\n\nPlease use these community resources for getting help.\nWe use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.\n\n- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)\n or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).\n- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)\n on AWS Developer Blog.\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`.\n- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3).\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose).\n\nTo test your universal JavaScript code in Node.js, browser and react-native environments,\nvisit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-pinpoint-email` package is updated.\nTo contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients).\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n## Client Commands (Operations List)\n\n