AWS.PinpointSMSVoice — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Pinpoint SMS and Voice Messaging public facing APIs

Sending a Request Using PinpointSMSVoice

var pinpointsmsvoice = new AWS.PinpointSMSVoice();
pinpointsmsvoice.createConfigurationSet(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the PinpointSMSVoice object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var pinpointsmsvoice = new AWS.PinpointSMSVoice({apiVersion: '2018-09-05'});

You can also set the API version globally in AWS.config.apiVersions using the pinpointsmsvoice service identifier:

AWS.config.apiVersions = {
  pinpointsmsvoice: '2018-09-05',
  // other service API versions
};

var pinpointsmsvoice = new AWS.PinpointSMSVoice();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.PinpointSMSVoice(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createConfigurationSet(params = {}, callback) ⇒ AWS.Request

Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it.

createConfigurationSetEventDestination(params = {}, callback) ⇒ AWS.Request

Create a new event destination in a configuration set.

deleteConfigurationSet(params = {}, callback) ⇒ AWS.Request

Deletes an existing configuration set.

deleteConfigurationSetEventDestination(params = {}, callback) ⇒ AWS.Request

Deletes an event destination in a configuration set.

getConfigurationSetEventDestinations(params = {}, callback) ⇒ AWS.Request

Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.

listConfigurationSets(params = {}, callback) ⇒ AWS.Request

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

sendVoiceMessage(params = {}, callback) ⇒ AWS.Request

Create a new voice message and send it to a recipient's phone number.

updateConfigurationSetEventDestination(params = {}, callback) ⇒ AWS.Request

Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails.