@aws-sdk/client-pinpoint-email-node v0.1.0-preview.2

@aws-sdk/client-pinpoint-email-node

Description

Amazon Pinpoint Email Service 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.

Installing

To install the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-pinpoint-email-node

Getting Started

Import

The 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:

//JavaScript
const {
  PinpointEmailClient
} = require("@aws-sdk/client-pinpoint-email-node/PinpointEmailClient");
const {
  CreateConfigurationSetCommand
} = require("@aws-sdk/client-pinpoint-email-node/commands/CreateConfigurationSetCommand");

//TypeScript
import { PinpointEmailClient } from "@aws-sdk/client-pinpoint-email-node/PinpointEmailClient";
import { CreateConfigurationSetCommand } from "@aws-sdk/client-pinpoint-email-node/commands/CreateConfigurationSetCommand";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
• Initiate command with input parameters.
• Call send operation on client with command object as input.
• If you are using a custom http handler, you may call destroy() to close open connections.

const pinpointEmail = new PinpointEmailClient({region: 'region'});
//clients can be shared by different commands
const params = {
  ConfigurationSetName: /**a string value*/,
};
const createConfigurationSetCommand = new CreateConfigurationSetCommand(params);
pinpointEmail.send(createConfigurationSetCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await pinpointEmail.send(createConfigurationSetCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
pinpointEmail.send(createConfigurationSetCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-pinpoint-email-node/PinpointEmail";
const pinpointEmail = new AWS.PinpointEmail({ region: "region" });
pinpointEmail.createConfigurationSet(params, (err, data) => {
  //do something
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await pinpointEmail.send(createConfigurationSetCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.extendedRequestId}`
  );
  /*
The keys within exceptions are also parsed. You can access them by specifying exception names:
    if(error.name === 'SomeServiceException') {
        const value = error.specialKeyInException;
    }
*/
}

Getting Help

Please 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.

• Ask a question on StackOverflow and tag it with aws-sdk-js
• Come join the AWS JavaScript community on gitter
• If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-pinpoint-email-node' package is updated. To contribute to SDK you can checkout our code generator package.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.