This document contains reference information for the Amazon Pinpoint Email API, version 1.0. This document is best used in conjunction with the Amazon Pinpoint Developer Guide.
The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Regions and Endpoints in the Amazon Web Services General Reference.
In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-pinpoint-email-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`PinpointEmailClient`) and the commands you need, for example `CreateConfigurationSetCommand`:\n\n```javascript\n//JavaScript\nconst {\n PinpointEmailClient\n} = require(\"@aws-sdk/client-pinpoint-email-browser/PinpointEmailClient\");\nconst {\n CreateConfigurationSetCommand\n} = require(\"@aws-sdk/client-pinpoint-email-browser/commands/CreateConfigurationSetCommand\");\n```\n\n```javascript\n//TypeScript\nimport { PinpointEmailClient } from \"@aws-sdk/client-pinpoint-email-browser/PinpointEmailClient\";\nimport { CreateConfigurationSetCommand } from \"@aws-sdk/client-pinpoint-email-browser/commands/CreateConfigurationSetCommand\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst pinpointEmail = new PinpointEmailClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n ConfigurationSetName: /**a string value*/,\n};\nconst createConfigurationSetCommand = new CreateConfigurationSetCommand(params);\npinpointEmail.send(createConfigurationSetCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await pinpointEmail.send(createConfigurationSetCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\npinpointEmail.send(createConfigurationSetCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/@aws-sdk/client-pinpoint-email-browser/PinpointEmail\";\nconst pinpointEmail = new AWS.PinpointEmail({ region: \"region\" });\npinpointEmail.createConfigurationSet(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await pinpointEmail.send(createConfigurationSetCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come 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)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-pinpoint-email-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\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[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-pinpoint-email-browser has been renamed to @aws-sdk/client-pinpoint-email. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Pinpoint Email Service","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.5","@aws-sdk/json-parser":"^0.1.0-preview.5","@aws-sdk/core-handler":"^0.1.0-preview.5","@aws-sdk/json-builder":"^0.1.0-preview.5","@aws-sdk/signature-v4":"^0.1.0-preview.7","@aws-sdk/protocol-rest":"^0.1.0-preview.7","@aws-sdk/config-resolver":"^0.1.0-preview.5","@aws-sdk/middleware-stack":"^0.1.0-preview.6","@aws-sdk/retry-middleware":"^0.1.0-preview.5","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.5","@aws-sdk/signing-middleware":"^0.1.0-preview.7","@aws-sdk/url-parser-browser":"^0.1.0-preview.5","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.5","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.6","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.6","@aws-sdk/stream-collector-browser":"^0.1.0-preview.5","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.5","@aws-sdk/middleware-header-default":"^0.1.0-preview.5"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-pinpoint-email-browser_0.1.0-preview.3_1568908565983_0.23071945595536425","host":"s3://npm-registry-packages"}},"0.1.0-preview.4":{"name":"@aws-sdk/client-pinpoint-email-browser","version":"0.1.0-preview.4","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-pinpoint-email-browser@0.1.0-preview.4","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"12884a4c045a8b0b6b4f1e1e35d6aea29fa76816","tarball":"https://registry.npmjs.org/@aws-sdk/client-pinpoint-email-browser/-/client-pinpoint-email-browser-0.1.0-preview.4.tgz","fileCount":1250,"integrity":"sha512-mqeFeZ/f2v73Ky8WCI/T7+eE58VTDefrz3DkkJ8r7A1xU01ibpcqF1fgpXUhJH+irsVBpBUS9fx8/Sdn21Nu5w==","signatures":[{"sig":"MEUCIAaL5quRCmb3iPa+h3oV8XQ9TgWrn5XbG7/d90Z6hzMZAiEAtJTDV7bY7tqwLop0KHHSu3F1axKSEGM5yy7O15ebbrY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":743285,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJduM9RCRA9TVsSAnZWagAAnMoP/0NtTRmYbb91y23/O3m3\nTaK3gP5fbPudbHPmhkQNNlH3gY1WORNTnfS2s2SiFFaEMavx84ecs0+vYPpX\n6yfsEbg07gjcxe4UR7S3jBpw+BX/wDDQkY/5amkJEGwTniZ3UvMoOEhcBTAY\n4WC42KMD1MS3OT86hzhcNQ+oMaTeUuBinkbAotavktb31Sinq3vW1tbzMTN7\ncDFl+NvhwpmNZEuALc8CsGfuogxieiqoNg7vW3ylCDUDd3jFYwRamfiLjwlh\ncHbcHBrwjWDrB0V0DdFcZfyC23x4UUB+cMVsE9lu93EqDKPxRD99NDr9qDEc\n+57ZuJoehhe88MDqxL0vx3tcDziulXIi/JrKSUcBNBv+TaxYA3JRjQ9HH5kw\nm+6c5xnhGIBCHSsdLWptj0AfYsmBrUvPh/0jUzd/AoDSe105W8XDPRevnIEk\n9OgoxRHwIMtwJdt0l+6m2pAaFoJe0GTcuZia181Qs1uhNAfQjNd5AfhU4qeK\n3gjiFu8pTDMw+dZRmF73OO8agB5S6nhQ1F0zEct14ptTnaRmEcGX58KRxnMi\nvXu/JVBZbdexib2PkSpvGPpycOT+zw0DiUVull9Wy8+iTprvRfT8ZuXwUsG5\nUlGYtw8iTmhrkm1bydsQBvMZkboqSuhVE93D6muL4DtuxKgVZ089Gs9neZ7e\nlVV8\r\n=2Pef\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-pinpoint-email-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-pinpoint-email-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-pinpoint-email-browser)\n\n## Description\n\nThis document contains reference information for the Amazon Pinpoint Email API, version 1.0. This document is best used in conjunction with the Amazon Pinpoint Developer Guide.
The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Regions and Endpoints in the Amazon Web Services General Reference.
In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-pinpoint-email-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`PinpointEmailClient`) and the commands you need, for example `CreateConfigurationSetCommand`:\n\n```javascript\n//JavaScript\nconst {\n PinpointEmailClient,\n CreateConfigurationSetCommand\n} = require(\"@aws-sdk/client-pinpoint-email-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n PinpointEmailClient,\n CreateConfigurationSetCommand\n} from \"@aws-sdk/client-pinpoint-email-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst pinpointEmail = new PinpointEmailClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n ConfigurationSetName: /**a string value*/,\n};\nconst createConfigurationSetCommand = new CreateConfigurationSetCommand(params);\npinpointEmail.send(createConfigurationSetCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await pinpointEmail.send(createConfigurationSetCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\npinpointEmail.send(createConfigurationSetCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-pinpoint-email-browser\";\nconst pinpointEmail = new AWS.PinpointEmail({ region: \"region\" });\npinpointEmail.createConfigurationSet(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await pinpointEmail.send(createConfigurationSetCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come 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)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-pinpoint-email-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\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[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-pinpoint-email-browser has been renamed to @aws-sdk/client-pinpoint-email. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Pinpoint Email Service","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.6","@aws-sdk/json-parser":"^0.1.0-preview.6","@aws-sdk/core-handler":"^0.1.0-preview.6","@aws-sdk/json-builder":"^0.1.0-preview.6","@aws-sdk/signature-v4":"^0.1.0-preview.8","@aws-sdk/protocol-rest":"^0.1.0-preview.8","@aws-sdk/config-resolver":"^0.1.0-preview.6","@aws-sdk/middleware-stack":"^0.1.0-preview.7","@aws-sdk/retry-middleware":"^0.1.0-preview.6","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.6","@aws-sdk/signing-middleware":"^0.1.0-preview.8","@aws-sdk/url-parser-browser":"^0.1.0-preview.6","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.6","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.7","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.7","@aws-sdk/stream-collector-browser":"^0.1.0-preview.6","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.6","@aws-sdk/middleware-header-default":"^0.1.0-preview.6"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-pinpoint-email-browser_0.1.0-preview.4_1572392785566_0.2935114960633496","host":"s3://npm-registry-packages"}},"0.1.0-preview.5":{"name":"@aws-sdk/client-pinpoint-email-browser","version":"0.1.0-preview.5","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-pinpoint-email-browser@0.1.0-preview.5","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"1ae5445d882b59dc44045b4db8b173b359dc4bc3","tarball":"https://registry.npmjs.org/@aws-sdk/client-pinpoint-email-browser/-/client-pinpoint-email-browser-0.1.0-preview.5.tgz","fileCount":1250,"integrity":"sha512-T5S3FN4066I4F3QQKjfSr54Sk2WXMuzOWiujskj2AEb31Uof0ai0I6bYbJgbGQQ1OX/K0Zk01meky+Jy6KFEqA==","signatures":[{"sig":"MEYCIQCiBEUCmEgR/4iJQ/BivybjCYy0f0Zwbf3Fc5w4LCxGtQIhAOQn8M3WJd2/Kzc4vk1rNHIuTlFbl/KzaxSaUwTBNX/Y","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":743529,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdueJCCRA9TVsSAnZWagAAt1oQAI2MAiZofgtKiy4yvEeu\nzPaZpclp7hHvfJ2YzEKLKLTj+am6TL3kO5N5orwUcI17F1oGcIccGPvxVec8\noy/TECh0aKBc8S74eMS5nYK+ffbVLrkQjTgffyrVGxDX1996LRYsBM6uaW9D\nz94wrZSw2beUiZ7OBH7jPCJMC0m9D6nuPW08tErPCVyUDZqH3R2UeeqOe0aP\nyHwbVE+hEDXbEC4mk6FIh+4c/hCwV3wFCZRu9JVNXlmlpxj6G9FtKtKfuVuC\n+ds0E7GkYVSPj6/vReYzm+1OkTVyH7H6Vp+OXICfP/iP4X8ZzNyeqSOo3BtO\nhiJXmaA32CEBdprDlm+lM06u/bMLQOMmxAxbS915yINxgvjrtFcoQQXWfxXG\nOtnEYPyAHXeN2VO6YMzqSm+EiTnuumoiD9y4mvnZoDVH8n9p1yJ5vMaTDwbu\nToU8gRln3kOBIrsirvUa+SpbMAN3ft4KHqxFtGpzKRaezqGtHwcSoQsAk0af\nMphoyzxBS/mBq+xBzyokkyjunvX2dAiEQSD8XnF2QjDHTQ4gbu8Ut2PHdBOf\njjaM/F1LzhvucZfNevxkCO/1I9PcBMr35aRvTvBbQg1dKaiQLpKLLRmAiDMS\nfSOOuDh1daHyUvEutwelBL6ZL1HP01GLKW/078XfohGxFzf5anyXw7FHrgTv\nJGok\r\n=zy9g\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-pinpoint-email-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-pinpoint-email-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-pinpoint-email-browser)\n\n## Description\n\nThis document contains reference information for the Amazon Pinpoint Email API, version 1.0. This document is best used in conjunction with the Amazon Pinpoint Developer Guide.
The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Regions and Endpoints in the Amazon Web Services General Reference.
In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-pinpoint-email-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`PinpointEmailClient`) and the commands you need, for example `CreateConfigurationSetCommand`:\n\n```javascript\n//JavaScript\nconst {\n PinpointEmailClient,\n CreateConfigurationSetCommand\n} = require(\"@aws-sdk/client-pinpoint-email-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n PinpointEmailClient,\n CreateConfigurationSetCommand\n} from \"@aws-sdk/client-pinpoint-email-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst pinpointEmail = new PinpointEmailClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n ConfigurationSetName: /**a string value*/,\n};\nconst createConfigurationSetCommand = new CreateConfigurationSetCommand(params);\npinpointEmail.send(createConfigurationSetCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await pinpointEmail.send(createConfigurationSetCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\npinpointEmail.send(createConfigurationSetCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-pinpoint-email-browser\";\nconst pinpointEmail = new AWS.PinpointEmail({ region: \"region\" });\npinpointEmail.createConfigurationSet(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await pinpointEmail.send(createConfigurationSetCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come 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)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-pinpoint-email-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\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[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-pinpoint-email-browser has been renamed to @aws-sdk/client-pinpoint-email. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Pinpoint Email Service","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@aws-sdk/json-parser":"^0.1.0-preview.7","@aws-sdk/core-handler":"^0.1.0-preview.7","@aws-sdk/json-builder":"^0.1.0-preview.7","@aws-sdk/signature-v4":"^0.1.0-preview.9","@aws-sdk/protocol-rest":"^0.1.0-preview.9","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.8","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.7","@aws-sdk/signing-middleware":"^0.1.0-preview.9","@aws-sdk/url-parser-browser":"^0.1.0-preview.7","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.8","@aws-sdk/stream-collector-browser":"^0.1.0-preview.7","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.7","@aws-sdk/middleware-header-default":"^0.1.0-preview.7"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-pinpoint-email-browser_0.1.0-preview.5_1572463170434_0.14361297214835145","host":"s3://npm-registry-packages"}},"0.1.0-preview.6":{"name":"@aws-sdk/client-pinpoint-email-browser","version":"0.1.0-preview.6","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-pinpoint-email-browser@0.1.0-preview.6","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"70c174c06cdf4c4aaf91ca461d1140d8bd8f90fb","tarball":"https://registry.npmjs.org/@aws-sdk/client-pinpoint-email-browser/-/client-pinpoint-email-browser-0.1.0-preview.6.tgz","fileCount":1250,"integrity":"sha512-J1B5YSfADxjNTg+TDZfiXh4TZ5BhDIinvRVO3WPbGzxpsmKmEzYiLUPFvIXf7GCZJaVZlpqlHYi+atcQPSkKnw==","signatures":[{"sig":"MEQCIDomP941sB9cnEAziZvpaByrcTSN28c8+kUhrb7dbmx6AiBPVdD+zc/yUouf5K+PdhNumZUbOyjGoPLOJ1jk+eWj4A==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":743800,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd1FObCRA9TVsSAnZWagAASaEP/0fH19AYexq2VMjeIPM4\nwEm8fuztw+iSgbAeos30RoFfkjHkrsV3rPTN+2ZxhLGttX99Tc5ehYs1ks+3\nLVXsxiOe89X8XK5OGmbOQNlZyXifMJUg/iRWeqF80GCQtKEiWKhKfGOCUrAg\nY4b1JwOW8OC/NH33HnGkMyBPlQwKaG4c/X9GRuPhaLcA83f/XR+hzAq8gU94\ng/5/BAvznj2y6kkGqGtuRA6DuCdY02RSoJGZd+I+a/kFIWyICryKWdMd2xED\nidrKe+yCAa2BEz5IcyMoC568yvpwIt+byEpyd/UJqkBCRHXcER5ieMiDrwTP\nf/LtzNXsVQORsypV9Fqm6H2aXz8yacOd+lKcVvVjom+7IqRDl7YlOQcy+Rv0\nXzITQWOjMhWyOTlZJjjwe127K/5xht9hAADyT1UbqI8RZWfRyMQpP/YO7u8J\n/72TpGhb+OXr/b/4ddIMbh6lheSPYMwVdmfu+AjEe4qrPn+COUwFAXioX6uF\nQIVrsg5Xhfmz0LaI/Um+EcvSmWKr7GYxiSyikvn76LoXAre1AxoQYjyfxyou\n6YmDB4CfHoLwsJcEnk++7zfzn7pZlWV3M1fslPmzNyPuBO1jFVGRsLhh7mVG\nPOoe4i/PvBWetPCctEYfQhOzhAZA8sHA5CfjpzeG/OFT64l1s3TB+Zrr1UMH\nM6NQ\r\n=EGh3\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-pinpoint-email-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-pinpoint-email-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-pinpoint-email-browser)\n\n## Description\n\nThis document contains reference information for the Amazon Pinpoint Email API, version 1.0. This document is best used in conjunction with the Amazon Pinpoint Developer Guide.
The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Regions and Endpoints in the Amazon Web Services General Reference.
In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-pinpoint-email-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`PinpointEmailClient`) and the commands you need, for example `CreateConfigurationSetCommand`:\n\n```javascript\n//JavaScript\nconst {\n PinpointEmailClient,\n CreateConfigurationSetCommand\n} = require(\"@aws-sdk/client-pinpoint-email-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n PinpointEmailClient,\n CreateConfigurationSetCommand\n} from \"@aws-sdk/client-pinpoint-email-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst pinpointEmail = new PinpointEmailClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n ConfigurationSetName: /**a string value*/,\n};\nconst createConfigurationSetCommand = new CreateConfigurationSetCommand(params);\npinpointEmail.send(createConfigurationSetCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await pinpointEmail.send(createConfigurationSetCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\npinpointEmail.send(createConfigurationSetCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-pinpoint-email-browser\";\nconst pinpointEmail = new AWS.PinpointEmail({ region: \"region\" });\npinpointEmail.createConfigurationSet(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await pinpointEmail.send(createConfigurationSetCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come 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)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-pinpoint-email-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\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[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-pinpoint-email-browser has been renamed to @aws-sdk/client-pinpoint-email. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Pinpoint Email Service","directories":{},"_nodeVersion":"10.16.3","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@aws-sdk/json-parser":"^0.1.0-preview.7","@aws-sdk/core-handler":"^0.1.0-preview.7","@aws-sdk/json-builder":"^0.1.0-preview.7","@aws-sdk/signature-v4":"^0.1.0-preview.10","@aws-sdk/protocol-rest":"^0.1.0-preview.10","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.9","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.8","@aws-sdk/signing-middleware":"^0.1.0-preview.10","@aws-sdk/url-parser-browser":"^0.1.0-preview.7","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.9","@aws-sdk/stream-collector-browser":"^0.1.0-preview.7","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.7","@aws-sdk/middleware-header-default":"^0.1.0-preview.7"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-pinpoint-email-browser_0.1.0-preview.6_1574196123078_0.21996314059860111","host":"s3://npm-registry-packages"}}},"time":{"created":"2019-09-09T17:43:46.425Z","modified":"2025-03-27T18:45:32.928Z","0.1.0-preview.2":"2019-09-09T17:43:46.835Z","0.1.0-preview.3":"2019-09-19T15:56:06.367Z","0.1.0-preview.4":"2019-10-29T23:46:25.728Z","0.1.0-preview.5":"2019-10-30T19:19:30.617Z","0.1.0-preview.6":"2019-11-19T20:42:03.228Z"},"author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","description":"Browser SDK for Amazon Pinpoint Email Service","maintainers":[{"email":"osa-3p@amazon.com","name":"amzn-oss"},{"email":"aws-sdk-js-automation@amazon.com","name":"aws-sdk-bot"}],"readme":"","readmeFilename":""}