Class: AWS.PinpointSMSVoice

Inherits:
AWS.Service show all
Identifier:
pinpointsmsvoice
API Version:
2018-09-05
Defined in:
(unknown)

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();

Version:

  • 2018-09-05

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a PinpointSMSVoice object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.PinpointSMSVoice.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.PinpointSMSVoice.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.PinpointSMSVoice.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    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.

Service Reference:

Examples:

Calling the createConfigurationSet operation

var params = {
  ConfigurationSetName: 'STRING_VALUE'
};
pinpointsmsvoice.createConfigurationSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConfigurationSetName — (String) The name that you want to give the configuration set.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Create a new event destination in a configuration set.

Examples:

Calling the createConfigurationSetEventDestination operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  EventDestination: {
    CloudWatchLogsDestination: {
      IamRoleArn: 'STRING_VALUE',
      LogGroupArn: 'STRING_VALUE'
    },
    Enabled: true || false,
    KinesisFirehoseDestination: {
      DeliveryStreamArn: 'STRING_VALUE',
      IamRoleArn: 'STRING_VALUE'
    },
    MatchingEventTypes: [
      INITIATED_CALL | RINGING | ANSWERED | COMPLETED_CALL | BUSY | FAILED | NO_ANSWER,
      /* more items */
    ],
    SnsDestination: {
      TopicArn: 'STRING_VALUE'
    }
  },
  EventDestinationName: 'STRING_VALUE'
};
pinpointsmsvoice.createConfigurationSetEventDestination(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConfigurationSetName — (String) ConfigurationSetName
    • EventDestination — (map) An object that defines a single event destination.
      • CloudWatchLogsDestination — (map) An object that contains information about an event destination that sends data to Amazon CloudWatch Logs.
        • IamRoleArn — (String) The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination.
        • LogGroupArn — (String) The name of the Amazon CloudWatch Log Group that you want to record events in.
      • Enabled — (Boolean) Indicates whether or not the event destination is enabled. If the event destination is enabled, then Amazon Pinpoint sends response data to the specified event destination.
      • KinesisFirehoseDestination — (map) An object that contains information about an event destination that sends data to Amazon Kinesis Data Firehose.
        • DeliveryStreamArn — (String) The Amazon Resource Name (ARN) of an IAM role that can write data to an Amazon Kinesis Data Firehose stream.
        • IamRoleArn — (String) The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose destination that you want to use in the event destination.
      • MatchingEventTypes — (Array<String>) An array of EventDestination objects. Each EventDestination object includes ARNs and other information that define an event destination.
      • SnsDestination — (map) An object that contains information about an event destination that sends data to Amazon SNS.
        • TopicArn — (String) The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
    • EventDestinationName — (String) A name that identifies the event destination.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes an existing configuration set.

Service Reference:

Examples:

Calling the deleteConfigurationSet operation

var params = {
  ConfigurationSetName: 'STRING_VALUE' /* required */
};
pinpointsmsvoice.deleteConfigurationSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConfigurationSetName — (String) ConfigurationSetName

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes an event destination in a configuration set.

Examples:

Calling the deleteConfigurationSetEventDestination operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  EventDestinationName: 'STRING_VALUE' /* required */
};
pinpointsmsvoice.deleteConfigurationSetEventDestination(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConfigurationSetName — (String) ConfigurationSetName
    • EventDestinationName — (String) EventDestinationName

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Examples:

Calling the getConfigurationSetEventDestinations operation

var params = {
  ConfigurationSetName: 'STRING_VALUE' /* required */
};
pinpointsmsvoice.getConfigurationSetEventDestinations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConfigurationSetName — (String) ConfigurationSetName

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EventDestinations — (Array<map>) An array of EventDestination objects. Each EventDestination object includes ARNs and other information that define an event destination.
        • CloudWatchLogsDestination — (map) An object that contains information about an event destination that sends data to Amazon CloudWatch Logs.
          • IamRoleArn — (String) The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination.
          • LogGroupArn — (String) The name of the Amazon CloudWatch Log Group that you want to record events in.
        • Enabled — (Boolean) Indicates whether or not the event destination is enabled. If the event destination is enabled, then Amazon Pinpoint sends response data to the specified event destination.
        • KinesisFirehoseDestination — (map) An object that contains information about an event destination that sends data to Amazon Kinesis Data Firehose.
          • DeliveryStreamArn — (String) The Amazon Resource Name (ARN) of an IAM role that can write data to an Amazon Kinesis Data Firehose stream.
          • IamRoleArn — (String) The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose destination that you want to use in the event destination.
        • MatchingEventTypes — (Array<String>) An array of EventDestination objects. Each EventDestination object includes ARNs and other information that define an event destination.
        • Name — (String) A name that identifies the event destination configuration.
        • SnsDestination — (map) An object that contains information about an event destination that sends data to Amazon SNS.
          • TopicArn — (String) The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the listConfigurationSets operation

var params = {
  NextToken: 'STRING_VALUE',
  PageSize: 'STRING_VALUE'
};
pinpointsmsvoice.listConfigurationSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String) A token returned from a previous call to the API that indicates the position in the list of results.
    • PageSize — (String) Used to specify the number of items that should be returned in the response.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConfigurationSets — (Array<String>) An object that contains a list of configuration sets for your account in the current region.
      • NextToken — (String) A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the sendVoiceMessage operation

var params = {
  CallerId: 'STRING_VALUE',
  ConfigurationSetName: 'STRING_VALUE',
  Content: {
    CallInstructionsMessage: {
      Text: 'STRING_VALUE'
    },
    PlainTextMessage: {
      LanguageCode: 'STRING_VALUE',
      Text: 'STRING_VALUE',
      VoiceId: 'STRING_VALUE'
    },
    SSMLMessage: {
      LanguageCode: 'STRING_VALUE',
      Text: 'STRING_VALUE',
      VoiceId: 'STRING_VALUE'
    }
  },
  DestinationPhoneNumber: 'STRING_VALUE',
  OriginationPhoneNumber: 'STRING_VALUE'
};
pinpointsmsvoice.sendVoiceMessage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CallerId — (String) The phone number that appears on recipients' devices when they receive the message.
    • ConfigurationSetName — (String) The name of the configuration set that you want to use to send the message.
    • Content — (map) An object that contains a voice message and information about the recipient that you want to send it to.
      • CallInstructionsMessage — (map) An object that defines a message that contains text formatted using Amazon Pinpoint Voice Instructions markup.
        • Text — (String) The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide.
      • PlainTextMessage — (map) An object that defines a message that contains unformatted text.
        • LanguageCode — (String) The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide.
        • Text — (String) The plain (not SSML-formatted) text to deliver to the recipient.
        • VoiceId — (String) The name of the voice that you want to use to deliver the message. For a complete list of supported voices, see the Amazon Polly Developer Guide.
      • SSMLMessage — (map) An object that defines a message that contains SSML-formatted text.
        • LanguageCode — (String) The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide.
        • Text — (String) The SSML-formatted text to deliver to the recipient.
        • VoiceId — (String) The name of the voice that you want to use to deliver the message. For a complete list of supported voices, see the Amazon Polly Developer Guide.
    • DestinationPhoneNumber — (String) The phone number that you want to send the voice message to.
    • OriginationPhoneNumber — (String) The phone number that Amazon Pinpoint should use to send the voice message. This isn't necessarily the phone number that appears on recipients' devices when they receive the message, because you can specify a CallerId parameter in the request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MessageId — (String) A unique identifier for the voice message.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Examples:

Calling the updateConfigurationSetEventDestination operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  EventDestinationName: 'STRING_VALUE', /* required */
  EventDestination: {
    CloudWatchLogsDestination: {
      IamRoleArn: 'STRING_VALUE',
      LogGroupArn: 'STRING_VALUE'
    },
    Enabled: true || false,
    KinesisFirehoseDestination: {
      DeliveryStreamArn: 'STRING_VALUE',
      IamRoleArn: 'STRING_VALUE'
    },
    MatchingEventTypes: [
      INITIATED_CALL | RINGING | ANSWERED | COMPLETED_CALL | BUSY | FAILED | NO_ANSWER,
      /* more items */
    ],
    SnsDestination: {
      TopicArn: 'STRING_VALUE'
    }
  }
};
pinpointsmsvoice.updateConfigurationSetEventDestination(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConfigurationSetName — (String) ConfigurationSetName
    • EventDestination — (map) An object that defines a single event destination.
      • CloudWatchLogsDestination — (map) An object that contains information about an event destination that sends data to Amazon CloudWatch Logs.
        • IamRoleArn — (String) The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination.
        • LogGroupArn — (String) The name of the Amazon CloudWatch Log Group that you want to record events in.
      • Enabled — (Boolean) Indicates whether or not the event destination is enabled. If the event destination is enabled, then Amazon Pinpoint sends response data to the specified event destination.
      • KinesisFirehoseDestination — (map) An object that contains information about an event destination that sends data to Amazon Kinesis Data Firehose.
        • DeliveryStreamArn — (String) The Amazon Resource Name (ARN) of an IAM role that can write data to an Amazon Kinesis Data Firehose stream.
        • IamRoleArn — (String) The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose destination that you want to use in the event destination.
      • MatchingEventTypes — (Array<String>) An array of EventDestination objects. Each EventDestination object includes ARNs and other information that define an event destination.
      • SnsDestination — (map) An object that contains information about an event destination that sends data to Amazon SNS.
        • TopicArn — (String) The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
    • EventDestinationName — (String) EventDestinationName

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.