Class: AWS.PinpointSMSVoiceV2

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
pinpointsmsvoicev2.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 to use for the new configuration set.

  • Tags — (Array<map>)

    An array of key and value pair tags that's associated with the new configuration set.

    • Key — required — (String)

      The key identifier, or name, of the tag.

    • Value — required — (String)

      The string value associated with the key of the tag.

  • ClientToken — (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

    If a token is not provided, the SDK will use a version 4 UUID.

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:

    • ConfigurationSetArn — (String)

      The Amazon Resource Name (ARN) of the newly created configuration set.

    • ConfigurationSetName — (String)

      The name of the new configuration set.

    • Tags — (Array<map>)

      An array of key and value pair tags that's associated with the configuration set.

      • Key — required — (String)

        The key identifier, or name, of the tag.

      • Value — required — (String)

        The string value associated with the key of the tag.

    • CreatedTimestamp — (Date)

      The time when the configuration set was created, in UNIX epoch time format.

Returns:

• (AWS.Request) —

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

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  EventDestinationName: 'STRING_VALUE', /* required */
  MatchingEventTypes: [ /* required */
    ALL | TEXT_ALL | TEXT_SENT | TEXT_PENDING | TEXT_QUEUED | TEXT_SUCCESSFUL | TEXT_DELIVERED | TEXT_INVALID | TEXT_INVALID_MESSAGE | TEXT_UNREACHABLE | TEXT_CARRIER_UNREACHABLE | TEXT_BLOCKED | TEXT_CARRIER_BLOCKED | TEXT_SPAM | TEXT_UNKNOWN | TEXT_TTL_EXPIRED | VOICE_ALL | VOICE_INITIATED | VOICE_RINGING | VOICE_ANSWERED | VOICE_COMPLETED | VOICE_BUSY | VOICE_NO_ANSWER | VOICE_FAILED | VOICE_TTL_EXPIRED,
    /* more items */
  ],
  ClientToken: 'STRING_VALUE',
  CloudWatchLogsDestination: {
    IamRoleArn: 'STRING_VALUE', /* required */
    LogGroupArn: 'STRING_VALUE' /* required */
  },
  KinesisFirehoseDestination: {
    DeliveryStreamArn: 'STRING_VALUE', /* required */
    IamRoleArn: 'STRING_VALUE' /* required */
  },
  SnsDestination: {
    TopicArn: 'STRING_VALUE' /* required */
  }
};
pinpointsmsvoicev2.createEventDestination(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)

    Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

  • EventDestinationName — (String)

    The name that identifies the event destination.

  • MatchingEventTypes — (Array<String>)

    An array of event types that determine which events to log. If "ALL" is used, then Amazon Pinpoint logs every event type.

  • CloudWatchLogsDestination — (map)

    An object that contains information about an event destination for logging to Amazon CloudWatch logs.

    • IamRoleArn — required — (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 — required — (String)

      The name of the Amazon CloudWatch log group that you want to record events in.

  • KinesisFirehoseDestination — (map)

    An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

    • IamRoleArn — required — (String)

      The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.

    • DeliveryStreamArn — required — (String)

      The Amazon Resource Name (ARN) of the delivery stream.

  • SnsDestination — (map)

    An object that contains information about an event destination for logging to Amazon SNS.

    • TopicArn — required — (String)

      The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

  • ClientToken — (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

    If a token is not provided, the SDK will use a version 4 UUID.

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:

    • ConfigurationSetArn — (String)

      The ARN of the configuration set.

    • ConfigurationSetName — (String)

      The name of the configuration set.

    • EventDestination — (map)

      The details of the destination where events are logged.

      • EventDestinationName — required — (String)

        The name of the EventDestination.

      • Enabled — required — (Boolean)

        When set to true events will be logged.

      • MatchingEventTypes — required — (Array<String>)

        An array of event types that determine which events to log.

      • CloudWatchLogsDestination — (map)

        An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.

        • IamRoleArn — required — (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 — required — (String)

          The name of the Amazon CloudWatch log group that you want to record events in.

      • KinesisFirehoseDestination — (map)

        An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

        • IamRoleArn — required — (String)

          The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.

        • DeliveryStreamArn — required — (String)

          The Amazon Resource Name (ARN) of the delivery stream.

      • SnsDestination — (map)

        An object that contains information about an event destination that sends logging events to Amazon SNS.

        • TopicArn — required — (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.

var params = {
  OptOutListName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
pinpointsmsvoicev2.createOptOutList(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: {}) —
  • OptOutListName — (String)

    The name of the new OptOutList.

  • Tags — (Array<map>)

    An array of tags (key and value pairs) to associate with the new OptOutList.

    • Key — required — (String)

      The key identifier, or name, of the tag.

    • Value — required — (String)

      The string value associated with the key of the tag.

  • ClientToken — (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

    If a token is not provided, the SDK will use a version 4 UUID.

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:

    • OptOutListArn — (String)

      The Amazon Resource Name (ARN) for the OptOutList.

    • OptOutListName — (String)

      The name of the new OptOutList.

    • Tags — (Array<map>)

      An array of tags (key and value pairs) associated with the new OptOutList.

      • Key — required — (String)

        The key identifier, or name, of the tag.

      • Value — required — (String)

        The string value associated with the key of the tag.

    • CreatedTimestamp — (Date)

      The time when the pool was created, in UNIX epoch time format.

Returns:

• (AWS.Request) —

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

var params = {
  IsoCountryCode: 'STRING_VALUE', /* required */
  MessageType: TRANSACTIONAL | PROMOTIONAL, /* required */
  OriginationIdentity: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DeletionProtectionEnabled: true || false,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
pinpointsmsvoicev2.createPool(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: {}) —
  • OriginationIdentity — (String)

    The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

  • IsoCountryCode — (String)

    The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.

  • MessageType — (String)

    The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

    Possible values include:
    • "TRANSACTIONAL"
    • "PROMOTIONAL"
  • DeletionProtectionEnabled — (Boolean)

    By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.

  • Tags — (Array<map>)

    An array of tags (key and value pairs) associated with the pool.

    • Key — required — (String)

      The key identifier, or name, of the tag.

    • Value — required — (String)

      The string value associated with the key of the tag.

  • ClientToken — (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

    If a token is not provided, the SDK will use a version 4 UUID.

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:

    • PoolArn — (String)

      The Amazon Resource Name (ARN) for the pool.

    • PoolId — (String)

      The unique identifier for the pool.

    • Status — (String)

      The current status of the pool.

      • CREATING: The pool is currently being created and isn't yet available for use.

      • ACTIVE: The pool is active and available for use.

      • DELETING: The pool is being deleted.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "DELETING"
    • MessageType — (String)

      The type of message for the pool to use.

      Possible values include:
      • "TRANSACTIONAL"
      • "PROMOTIONAL"
    • TwoWayEnabled — (Boolean)

      By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    • TwoWayChannelArn — (String)

      The Amazon Resource Name (ARN) of the two way channel.

    • SelfManagedOptOutsEnabled — (Boolean)

      By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

    • OptOutListName — (String)

      The name of the OptOutList associated with the pool.

    • SharedRoutesEnabled — (Boolean)

      Indicates whether shared routes are enabled for the pool.

    • DeletionProtectionEnabled — (Boolean)

      When set to true deletion protection is enabled. By default this is set to false.

    • Tags — (Array<map>)

      An array of tags (key and value pairs) associated with the pool.

      • Key — required — (String)

        The key identifier, or name, of the tag.

      • Value — required — (String)

        The string value associated with the key of the tag.

    • CreatedTimestamp — (Date)

      The time when the pool was created, in UNIX epoch time format.

Returns:

• (AWS.Request) —

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

var params = {
  ConfigurationSetName: 'STRING_VALUE' /* required */
};
pinpointsmsvoicev2.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)

    The name of the configuration set or the configuration set ARN that you want to delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

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:

    • ConfigurationSetArn — (String)

      The Amazon Resource Name (ARN) of the deleted configuration set.

    • ConfigurationSetName — (String)

      The name of the deleted configuration set.

    • EventDestinations — (Array<map>)

      An array of any EventDestination objects that were associated with the deleted configuration set.

      • EventDestinationName — required — (String)

        The name of the EventDestination.

      • Enabled — required — (Boolean)

        When set to true events will be logged.

      • MatchingEventTypes — required — (Array<String>)

        An array of event types that determine which events to log.

      • CloudWatchLogsDestination — (map)

        An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.

        • IamRoleArn — required — (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 — required — (String)

          The name of the Amazon CloudWatch log group that you want to record events in.

      • KinesisFirehoseDestination — (map)

        An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

        • IamRoleArn — required — (String)

          The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.

        • DeliveryStreamArn — required — (String)

          The Amazon Resource Name (ARN) of the delivery stream.

      • SnsDestination — (map)

        An object that contains information about an event destination that sends logging events to Amazon SNS.

        • TopicArn — required — (String)

          The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

    • DefaultMessageType — (String)

      The default message type of the configuration set that was deleted.

      Possible values include:
      • "TRANSACTIONAL"
      • "PROMOTIONAL"
    • DefaultSenderId — (String)

      The default Sender ID of the configuration set that was deleted.

    • CreatedTimestamp — (Date)

      The time that the deleted configuration set was created in UNIX epoch time format.

Returns:

• (AWS.Request) —

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

var params = {
  ConfigurationSetName: 'STRING_VALUE' /* required */
};
pinpointsmsvoicev2.deleteDefaultMessageType(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 of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default message type from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

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:

    • ConfigurationSetArn — (String)

      The Amazon Resource Name (ARN) of the configuration set.

    • ConfigurationSetName — (String)

      The name of the configuration set.

    • MessageType — (String)

      The current message type for the configuration set.

      Possible values include:
      • "TRANSACTIONAL"
      • "PROMOTIONAL"

Returns:

• (AWS.Request) —

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

var params = {
  ConfigurationSetName: 'STRING_VALUE' /* required */
};
pinpointsmsvoicev2.deleteDefaultSenderId(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 of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

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:

    • ConfigurationSetArn — (String)

      The Amazon Resource Name (ARN) of the configuration set.

    • ConfigurationSetName — (String)

      The name of the configuration set.

    • SenderId — (String)

      The current sender ID for the configuration set.

Returns:

• (AWS.Request) —

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

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  EventDestinationName: 'STRING_VALUE' /* required */
};
pinpointsmsvoicev2.deleteEventDestination(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 of the configuration set or the configuration set's Amazon Resource Name (ARN) to remove the event destination from. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

  • EventDestinationName — (String)

    The name of the event destination to delete.

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:

    • ConfigurationSetArn — (String)

      The Amazon Resource Name (ARN) of the configuration set.

    • ConfigurationSetName — (String)

      The name of the configuration set the event destination was deleted from.

    • EventDestination — (map)

      The event destination object that was deleted.

      • EventDestinationName — required — (String)

        The name of the EventDestination.

      • Enabled — required — (Boolean)

        When set to true events will be logged.

      • MatchingEventTypes — required — (Array<String>)

        An array of event types that determine which events to log.

      • CloudWatchLogsDestination — (map)

        An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.

        • IamRoleArn — required — (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 — required — (String)

          The name of the Amazon CloudWatch log group that you want to record events in.

      • KinesisFirehoseDestination — (map)

        An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

        • IamRoleArn — required — (String)

          The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.

        • DeliveryStreamArn — required — (String)

          The Amazon Resource Name (ARN) of the delivery stream.

      • SnsDestination — (map)

        An object that contains information about an event destination that sends logging events to Amazon SNS.

        • TopicArn — required — (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.

var params = {
  Keyword: 'STRING_VALUE', /* required */
  OriginationIdentity: 'STRING_VALUE' /* required */
};
pinpointsmsvoicev2.deleteKeyword(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: {}) —
  • OriginationIdentity — (String)

    The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn.

  • Keyword — (String)

    The keyword to delete.

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:

    • OriginationIdentityArn — (String)

      The PhoneNumberArn or PoolArn that the keyword was associated with.

    • OriginationIdentity — (String)

      The PhoneNumberId or PoolId that the keyword was associated with.

    • Keyword — (String)

      The keyword that was deleted.

    • KeywordMessage — (String)

      The message that was associated with the deleted keyword.

    • KeywordAction — (String)

      The action that was associated with the deleted keyword.

      Possible values include:
      • "AUTOMATIC_RESPONSE"
      • "OPT_OUT"
      • "OPT_IN"

Returns:

• (AWS.Request) —

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

var params = {
  OptOutListName: 'STRING_VALUE', /* required */
  OptedOutNumber: 'STRING_VALUE' /* required */
};
pinpointsmsvoicev2.deleteOptedOutNumber(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: {}) —
  • OptOutListName — (String)

    The OptOutListName or OptOutListArn to remove the phone number from.

  • OptedOutNumber — (String)

    The phone number, in E.164 format, to remove from the OptOutList.

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:

    • OptOutListArn — (String)

      The OptOutListArn that the phone number was removed from.

    • OptOutListName — (String)

      The OptOutListName that the phone number was removed from.

    • OptedOutNumber — (String)

      The phone number that was removed from the OptOutList.

    • OptedOutTimestamp — (Date)

      The time that the number was removed at, in UNIX epoch time format.

    • EndUserOptedOut — (Boolean)

      This is true if it was the end user who requested their phone number be removed.

Returns:

• (AWS.Request) —

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

var params = {
  OptOutListName: 'STRING_VALUE' /* required */
};
pinpointsmsvoicev2.deleteOptOutList(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: {}) —
  • OptOutListName — (String)

    The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

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:

    • OptOutListArn — (String)

      The Amazon Resource Name (ARN) of the OptOutList that was removed.

    • OptOutListName — (String)

      The name of the OptOutList that was removed.

    • CreatedTimestamp — (Date)

      The time when the OptOutList was created, in UNIX epoch time format.

Returns:

• (AWS.Request) —

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

var params = {
  PoolId: 'STRING_VALUE' /* required */
};
pinpointsmsvoicev2.deletePool(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: {}) —
  • PoolId — (String)

    The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .

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:

    • PoolArn — (String)

      The Amazon Resource Name (ARN) of the pool that was deleted.

    • PoolId — (String)

      The PoolId of the pool that was deleted.

    • Status — (String)

      The current status of the pool.

      • CREATING: The pool is currently being created and isn't yet available for use.

      • ACTIVE: The pool is active and available for use.

      • DELETING: The pool is being deleted.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "DELETING"
    • MessageType — (String)

      The message type that was associated with the deleted pool.

      Possible values include:
      • "TRANSACTIONAL"
      • "PROMOTIONAL"
    • TwoWayEnabled — (Boolean)

      By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    • TwoWayChannelArn — (String)

      The Amazon Resource Name (ARN) of the TwoWayChannel.

    • SelfManagedOptOutsEnabled — (Boolean)

      By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

    • OptOutListName — (String)

      The name of the OptOutList that was associated with the deleted pool.

    • SharedRoutesEnabled — (Boolean)

      Indicates whether shared routes are enabled for the pool.

    • CreatedTimestamp — (Date)

      The time when the pool was created, in UNIX epoch time format.

Returns:

• (AWS.Request) —

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

var params = {
};
pinpointsmsvoicev2.deleteTextMessageSpendLimitOverride(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: {})

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:

    • MonthlyLimit — (Integer)

      The current monthly limit, in US dollars.

Returns:

• (AWS.Request) —

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

var params = {
};
pinpointsmsvoicev2.deleteVoiceMessageSpendLimitOverride(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: {})

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:

    • MonthlyLimit — (Integer)

      The current monthly limit, in US dollars.

Returns:

• (AWS.Request) —

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

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
pinpointsmsvoicev2.describeAccountAttributes(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)

    The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

  • MaxResults — (Integer)

    The maximum number of results to return per each 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:

    • AccountAttributes — (Array<map>)

      An array of AccountAttributes objects.

      • Name — required — (String)

        The name of the account attribute.

        Possible values include:
        • "ACCOUNT_TIER"
      • Value — required — (String)

        The value associated with the account attribute name.

    • NextToken — (String)

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Returns:

• (AWS.Request) —

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

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
pinpointsmsvoicev2.describeAccountLimits(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)

    The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

  • MaxResults — (Integer)

    The maximum number of results to return per each 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:

    • AccountLimits — (Array<map>)

      An array of AccountLimit objects that show the current spend limits.

      • Name — required — (String)

        The name of the attribute to apply the account limit to.

        Possible values include:
        • "PHONE_NUMBERS"
        • "POOLS"
        • "CONFIGURATION_SETS"
        • "OPT_OUT_LISTS"
      • Used — required — (Integer)

        The current amount that has been spent, in US dollars.

      • Max — required — (Integer)

        The Amazon Web Services set limit for that resource type, in US dollars.

    • NextToken — (String)

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Returns:

• (AWS.Request) —

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

var params = {
  ConfigurationSetNames: [
    'STRING_VALUE',
    /* more items */
  ],
  Filters: [
    {
      Name: event-destination-name | matching-event-types | default-message-type | default-sender-id, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
pinpointsmsvoicev2.describeConfigurationSets(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: {}) —
  • ConfigurationSetNames — (Array<String>)

    An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.

  • Filters — (Array<map>)

    An array of filters to apply to the results that are returned.

    • Name — required — (String)

      The name of the attribute to filter on.

      Possible values include:
      • "event-destination-name"
      • "matching-event-types"
      • "default-message-type"
      • "default-sender-id"
    • Values — required — (Array<String>)

      An array values to filter for.

  • NextToken — (String)

    The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

  • MaxResults — (Integer)

    The maximum number of results to return per each 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:

    • ConfigurationSets — (Array<map>)

      An array of ConfigurationSets objects.

      • ConfigurationSetArn — required — (String)

        The Resource Name (ARN) of the ConfigurationSet.

      • ConfigurationSetName — required — (String)

        The name of the ConfigurationSet.

      • EventDestinations — required — (Array<map>)

        An array of EventDestination objects that describe any events to log and where to log them.

        • EventDestinationName — required — (String)

          The name of the EventDestination.

        • Enabled — required — (Boolean)

          When set to true events will be logged.

        • MatchingEventTypes — required — (Array<String>)

          An array of event types that determine which events to log.

        • CloudWatchLogsDestination — (map)

          An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.

          • IamRoleArn — required — (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 — required — (String)

            The name of the Amazon CloudWatch log group that you want to record events in.

        • KinesisFirehoseDestination — (map)

          An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

          • IamRoleArn — required — (String)

            The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.

          • DeliveryStreamArn — required — (String)

            The Amazon Resource Name (ARN) of the delivery stream.

        • SnsDestination — (map)

          An object that contains information about an event destination that sends logging events to Amazon SNS.

          • TopicArn — required — (String)

            The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

      • DefaultMessageType — (String)

        The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

        Possible values include:
        • "TRANSACTIONAL"
        • "PROMOTIONAL"
      • DefaultSenderId — (String)

        The default sender ID used by the ConfigurationSet.

      • CreatedTimestamp — required — (Date)

        The time when the ConfigurationSet was created, in UNIX epoch time format.

    • NextToken — (String)

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Returns:

• (AWS.Request) —

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

var params = {
  OriginationIdentity: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: keyword-action, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Keywords: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
pinpointsmsvoicev2.describeKeywords(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: {}) —
  • OriginationIdentity — (String)

    The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

  • Keywords — (Array<String>)

    An array of keywords to search for.

  • Filters — (Array<map>)

    An array of keyword filters to filter the results.

    • Name — required — (String)

      The name of the attribute to filter on.

      Possible values include:
      • "keyword-action"
    • Values — required — (Array<String>)

      An array values to filter for.

  • NextToken — (String)

    The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

  • MaxResults — (Integer)

    The maximum number of results to return per each 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:

    • OriginationIdentityArn — (String)

      The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.

    • OriginationIdentity — (String)

      The PhoneNumberId or PoolId that is associated with the OriginationIdentity.

    • Keywords — (Array<map>)

      An array of KeywordInformation objects that contain the results.

      • Keyword — required — (String)

        The keyword as a string.

      • KeywordMessage — required — (String)

        A custom message that can be used with the keyword.

      • KeywordAction — required — (String)

        The action to perform for the keyword.

        Possible values include:
        • "AUTOMATIC_RESPONSE"
        • "OPT_OUT"
        • "OPT_IN"
    • NextToken — (String)

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Returns:

• (AWS.Request) —

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

var params = {
  OptOutListName: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: end-user-opted-out, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  OptedOutNumbers: [
    'STRING_VALUE',
    /* more items */
  ]
};
pinpointsmsvoicev2.describeOptedOutNumbers(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: {}) —
  • OptOutListName — (String)

    The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

  • OptedOutNumbers — (Array<String>)

    An array of phone numbers to search for in the OptOutList.

  • Filters — (Array<map>)

    An array of OptedOutFilter objects to filter the results on.

    • Name — required — (String)

      The name of the attribute to filter on.

      Possible values include:
      • "end-user-opted-out"
    • Values — required — (Array<String>)

      An array of values to filter for.

  • NextToken — (String)

    The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

  • MaxResults — (Integer)

    The maximum number of results to return per each 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:

    • OptOutListArn — (String)

      The Amazon Resource Name (ARN) of the OptOutList.

    • OptOutListName — (String)

      The name of the OptOutList.

    • OptedOutNumbers — (Array<map>)

      An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

      • OptedOutNumber — required — (String)

        The phone number that is opted out.

      • OptedOutTimestamp — required — (Date)

        The time that the op tout occurred, in UNIX epoch time format.

      • EndUserOptedOut — required — (Boolean)

        This is set to true if it was the end recipient that opted out.

    • NextToken — (String)

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Returns:

• (AWS.Request) —

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

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  OptOutListNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
pinpointsmsvoicev2.describeOptOutLists(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: {}) —
  • OptOutListNames — (Array<String>)

    The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

  • NextToken — (String)

    The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

  • MaxResults — (Integer)

    The maximum number of results to return per each 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:

    • OptOutLists — (Array<map>)

      An array of OptOutListInformation objects that contain the details for the requested OptOutLists.

      • OptOutListArn — required — (String)

        The Amazon Resource Name (ARN) of the OptOutList.

      • OptOutListName — required — (String)

        The name of the OptOutList.

      • CreatedTimestamp — required — (Date)

        The time when the OutOutList was created, in UNIX epoch time format.

    • NextToken — (String)

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Returns:

• (AWS.Request) —

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

var params = {
  Filters: [
    {
      Name: status | iso-country-code | message-type | number-capability | number-type | two-way-enabled | self-managed-opt-outs-enabled | opt-out-list-name | deletion-protection-enabled, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PhoneNumberIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
pinpointsmsvoicev2.describePhoneNumbers(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: {}) —
  • PhoneNumberIds — (Array<String>)

    The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

  • Filters — (Array<map>)

    An array of PhoneNumberFilter objects to filter the results.

    • Name — required — (String)

      The name of the attribute to filter on.

      Possible values include:
      • "status"
      • "iso-country-code"
      • "message-type"
      • "number-capability"
      • "number-type"
      • "two-way-enabled"
      • "self-managed-opt-outs-enabled"
      • "opt-out-list-name"
      • "deletion-protection-enabled"
    • Values — required — (Array<String>)

      An array values to filter for.

  • NextToken — (String)

    The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

  • MaxResults — (Integer)

    The maximum number of results to return per each 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:

    • PhoneNumbers — (Array<map>)

      An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.

      • PhoneNumberArn — required — (String)

        The Amazon Resource Name (ARN) associated with the phone number.

      • PhoneNumberId — (String)

        The unique identifier for the phone number.

      • PhoneNumber — required — (String)

        The phone number in E.164 format.

      • Status — required — (String)

        The current status of the phone number.

        Possible values include:
        • "PENDING"
        • "ACTIVE"
        • "ASSOCIATING"
        • "DISASSOCIATING"
        • "DELETED"
      • IsoCountryCode — required — (String)

        The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

      • MessageType — required — (String)

        The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

        Possible values include:
        • "TRANSACTIONAL"
        • "PROMOTIONAL"
      • NumberCapabilities — required — (Array<String>)

        Describes if the origination identity can be used for text messages, voice calls or both.

      • NumberType — required — (String)

        The type of phone number.

        Possible values include:
        • "SHORT_CODE"
        • "LONG_CODE"
        • "TOLL_FREE"
        • "TEN_DLC"
      • MonthlyLeasingPrice — required — (String)

        The price, in US dollars, to lease the phone number.

      • TwoWayEnabled — required — (Boolean)

        By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

      • TwoWayChannelArn — (String)

        The Amazon Resource Name (ARN) of the two way channel.

      • SelfManagedOptOutsEnabled — required — (Boolean)

        When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs

      • OptOutListName — required — (String)

        The name of the OptOutList associated with the phone number.

      • DeletionProtectionEnabled — required — (Boolean)

        When set to true the phone number can't be deleted.

      • PoolId — (String)

        The unique identifier of the pool associated with the phone number.

      • CreatedTimestamp — required — (Date)

        The time when the phone number was created, in UNIX epoch time format.

    • NextToken — (String)

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Returns:

• (AWS.Request) —

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

var params = {
  Filters: [
    {
      Name: status | message-type | two-way-enabled | self-managed-opt-outs-enabled | opt-out-list-name | shared-routes-enabled | deletion-protection-enabled, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PoolIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
pinpointsmsvoicev2.describePools(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: {}) —
  • PoolIds — (Array<String>)

    The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.

  • Filters — (Array<map>)

    An array of PoolFilter objects to filter the results.

    • Name — required — (String)

      The name of the attribute to filter on.

      Possible values include:
      • "status"
      • "message-type"
      • "two-way-enabled"
      • "self-managed-opt-outs-enabled"
      • "opt-out-list-name"
      • "shared-routes-enabled"
      • "deletion-protection-enabled"
    • Values — required — (Array<String>)

      An array values to filter for.

  • NextToken — (String)

    The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

  • MaxResults — (Integer)

    The maximum number of results to return per each 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:

    • Pools — (Array<map>)

      An array of PoolInformation objects that contain the details for the requested pools.

      • PoolArn — required — (String)

        The Amazon Resource Name (ARN) for the pool.

      • PoolId — required — (String)

        The unique identifier for the pool.

      • Status — required — (String)

        The current status of the pool.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
      • MessageType — required — (String)

        The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

        Possible values include:
        • "TRANSACTIONAL"
        • "PROMOTIONAL"
      • TwoWayEnabled — required — (Boolean)

        When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

      • TwoWayChannelArn — (String)

        The Amazon Resource Name (ARN) of the two way channel.

      • SelfManagedOptOutsEnabled — required — (Boolean)

        When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. For more information see Self-managed opt-outs

      • OptOutListName — required — (String)

        The name of the OptOutList associated with the pool.

      • SharedRoutesEnabled — required — (Boolean)

        Allows you to enable shared routes on your pool.

        By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other Amazon Pinpoint users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.

      • DeletionProtectionEnabled — required — (Boolean)

        When set to true the pool can't be deleted.

      • CreatedTimestamp — required — (Date)

        The time when the pool was created, in UNIX epoch time format.

    • NextToken — (String)

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Returns:

• (AWS.Request) —

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

var params = {
  Filters: [
    {
      Name: sender-id | iso-country-code | message-type, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SenderIds: [
    {
      IsoCountryCode: 'STRING_VALUE', /* required */
      SenderId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
pinpointsmsvoicev2.describeSenderIds(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: {}) —
  • SenderIds — (Array<map>)

    An array of SenderIdAndCountry objects to search for.

    • SenderId — required — (String)

      The unique identifier of the sender.

    • IsoCountryCode — required — (String)

      The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

  • Filters — (Array<map>)

    An array of SenderIdFilter objects to filter the results.

    • Name — required — (String)

      The name of the attribute to filter on.

      Possible values include:
      • "sender-id"
      • "iso-country-code"
      • "message-type"
    • Values — required — (Array<String>)

      An array of values to filter for.

  • NextToken — (String)

    The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

  • MaxResults — (Integer)

    The maximum number of results to return per each 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:

    • SenderIds — (Array<map>)

      An array of SernderIdInformation objects that contain the details for the requested SenderIds.

      • SenderIdArn — required — (String)

        The Amazon Resource Name (ARN) associated with the SenderId.

      • SenderId — required — (String)

        The alphanumeric sender ID in a specific country that you'd like to describe.

      • IsoCountryCode — required — (String)

        The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

      • MessageTypes — required — (Array<String>)

        The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

      • MonthlyLeasingPrice — required — (String)

        The monthly leasing price, in US dollars.

    • NextToken — (String)

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Returns:

• (AWS.Request) —

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

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
pinpointsmsvoicev2.describeSpendLimits(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)

    The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

  • MaxResults — (Integer)

    The maximum number of results to return per each 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:

    • SpendLimits — (Array<map>)

      An array of SpendLimit objects that contain the details for the requested spend limits.

      • Name — required — (String)

        The name for the SpendLimit.

        Possible values include:
        • "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT"
        • "VOICE_MESSAGE_MONTHLY_SPEND_LIMIT"
      • EnforcedLimit — required — (Integer)

        The maximum amount of money, in US dollars, that you want to be able to spend sending messages each month. This value has to be less than or equal to the amount in MaxLimit. To use this custom limit, Overridden must be set to true.

      • MaxLimit — required — (Integer)

        The maximum amount of money that you are able to spend to send messages each month, in US dollars.

      • Overridden — required — (Boolean)

        When set to True, the value that has been specified in the EnforcedLimit is used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars.

    • NextToken — (String)

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Returns:

• (AWS.Request) —

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

var params = {
  IsoCountryCode: 'STRING_VALUE', /* required */
  OriginationIdentity: 'STRING_VALUE', /* required */
  PoolId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
pinpointsmsvoicev2.disassociateOriginationIdentity(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: {}) —
  • PoolId — (String)

    The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.

  • OriginationIdentity — (String)

    The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for SenderId and SenderIdArn.

  • IsoCountryCode — (String)

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

  • ClientToken — (String)

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

    If a token is not provided, the SDK will use a version 4 UUID.

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:

    • PoolArn — (String)

      The Amazon Resource Name (ARN) of the pool.

    • PoolId — (String)

      The PoolId of the pool no longer associated with the origination identity.

    • OriginationIdentityArn — (String)

      The PhoneNumberArn or SenderIdArn of the origination identity.

    • OriginationIdentity — (String)

      The PhoneNumberId or SenderId of the origination identity.

    • IsoCountryCode — (String)

      The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Returns:

• (AWS.Request) —

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

var params = {
  PoolId: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: iso-country-code | number-capability, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
pinpointsmsvoicev2.listPoolOriginationIdentities(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: {}) —
  • PoolId — (String)

    The unique identifier for the pool. This value can be either the PoolId or PoolArn.

  • Filters — (Array<map>)

    An array of PoolOriginationIdentitiesFilter objects to filter the results..

    • Name — required — (String)

      The name of the attribute to filter on.

      Possible values include:
      • "iso-country-code"
      • "number-capability"
    • Values — required — (Array<String>)

      An array values to filter for.

  • NextToken — (String)

    The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

  • MaxResults — (Integer)

    The maximum number of results to return per each 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:

    • PoolArn — (String)

      The Amazon Resource Name (ARN) for the pool.

    • PoolId — (String)

      The unique PoolId of the pool.

    • OriginationIdentities — (Array<map>)

      An array of any OriginationIdentityMetadata objects.

      • OriginationIdentityArn — required — (String)

        The Amazon Resource Name (ARN) associated with the origination identity.

      • OriginationIdentity — required — (String)

        The unique identifier of the origination identity.

      • IsoCountryCode — required — (String)

        The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

      • NumberCapabilities — required — (Array<String>)

        Describes if the origination identity can be used for text messages, voice calls or both.

    • NextToken — (String)

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
pinpointsmsvoicev2.listTagsForResource(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: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the resource to query for.

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:

    • ResourceArn — (String)

      The ARN of the resource.

    • Tags — (Array<map>)

      An array of key and value pair tags that are associated with the resource.

      • Key — required — (String)

        The key identifier, or name, of the tag.

      • Value — required — (String)

        The string value associated with the key of the tag.

Returns:

• (AWS.Request) —

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

var params = {
  Keyword: 'STRING_VALUE', /* required */
  KeywordMessage: 'STRING_VALUE', /* required */
  OriginationIdentity: 'STRING_VALUE', /* required */
  KeywordAction: AUTOMATIC_RESPONSE | OPT_OUT | OPT_IN
};
pinpointsmsvoicev2.putKeyword(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: {}) —
  • OriginationIdentity — (String)

    The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

  • Keyword — (String)

    The new keyword to add.

  • KeywordMessage — (String)

    The message associated with the keyword.

    • AUTOMATIC_RESPONSE: A message is sent to the recipient.

    • OPT_OUT: Keeps the recipient from receiving future messages.

    • OPT_IN: The recipient wants to receive future messages.

  • KeywordAction — (String)

    The action to perform for the new keyword when it is received.

    Possible values include:
    • "AUTOMATIC_RESPONSE"
    • "OPT_OUT"
    • "OPT_IN"

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:

    • OriginationIdentityArn — (String)

      The PhoneNumberArn or PoolArn that the keyword was associated with.

    • OriginationIdentity — (String)

      The PhoneNumberId or PoolId that the keyword was associated with.

    • Keyword — (String)

      The keyword that was added.

    • KeywordMessage — (String)

      The message associated with the keyword.

    • KeywordAction — (String)

      The action to perform when the keyword is used.

      Possible values include:
      • "AUTOMATIC_RESPONSE"
      • "OPT_OUT"
      • "OPT_IN"

Returns:

• (AWS.Request) —

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

var params = {
  OptOutListName: 'STRING_VALUE', /* required */
  OptedOutNumber: 'STRING_VALUE' /* required */
};
pinpointsmsvoicev2.putOptedOutNumber(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: {}) —
  • OptOutListName — (String)

    The OptOutListName or OptOutListArn to add the phone number to.

  • OptedOutNumber — (String)

    The phone number to add to the OptOutList in E.164 format.

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:

    • OptOutListArn — (String)

      The OptOutListArn that the phone number was removed from.

    • OptOutListName — (String)

      The OptOutListName that the phone number was removed from.

    • OptedOutNumber — (String)

      The phone number that was added to the OptOutList.

    • OptedOutTimestamp — (Date)

      The time that the phone number was added to the OptOutList, in UNIX epoch time format.

    • EndUserOptedOut — (Boolean)

      This is true if it was the end user who requested their phone number be removed.

Returns:

• (AWS.Request) —

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

var params = {
  PhoneNumberId: 'STRING_VALUE' /* required */
};
pinpointsmsvoicev2.releasePhoneNumber(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: {}) —
  • PhoneNumberId — (String)

    The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.

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:

    • PhoneNumberArn — (String)

      The PhoneNumberArn of the phone number that was released.

    • PhoneNumberId — (String)

      The PhoneNumberId of the phone number that was released.

    • PhoneNumber — (String)

      The phone number that was released.

    • Status — (String)

      The current status of the request.

      Possible values include:
      • "PENDING"
      • "ACTIVE"
      • "ASSOCIATING"
      • "DISASSOCIATING"
      • "DELETED"
    • IsoCountryCode — (String)

      The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

    • MessageType — (String)

      The message type that was associated with the phone number.

      Possible values include:
      • "TRANSACTIONAL"
      • "PROMOTIONAL"
    • NumberCapabilities — (Array<String>)

      Specifies if the number could be used for text messages, voice, or both.

    • NumberType — (String)

      The type of number that was released.

      Possible values include:
      • "SHORT_CODE"
      • "LONG_CODE"
      • "TOLL_FREE"
      • "TEN_DLC"
    • MonthlyLeasingPrice — (String)

      The monthly price of the phone number, in US dollars.

    • TwoWayEnabled — (Boolean)

      By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    • TwoWayChannelArn — (String)

      The Amazon Resource Name (ARN) of the TwoWayChannel.

    • SelfManagedOptOutsEnabled — (Boolean)

      By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

    • OptOutListName — (String)

      The name of the OptOutList that was associated with the phone number.

    • CreatedTimestamp — (Date)

      The time when the phone number was created, in UNIX epoch time format.

Returns:

• (AWS.Request) —

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

var params = {
  IsoCountryCode: 'STRING_VALUE', /* required */
  MessageType: TRANSACTIONAL | PROMOTIONAL, /* required */
  NumberCapabilities: [ /* required */
    SMS | VOICE,
    /* more items */
  ],
  NumberType: LONG_CODE | TOLL_FREE | TEN_DLC, /* required */
  ClientToken: 'STRING_VALUE',
  DeletionProtectionEnabled: true || false,
  OptOutListName: 'STRING_VALUE',
  PoolId: 'STRING_VALUE',
  RegistrationId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
pinpointsmsvoicev2.requestPhoneNumber(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: {}) —
  • IsoCountryCode — (String)

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

  • MessageType — (String)

    The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

    Possible values include:
    • "TRANSACTIONAL"
    • "PROMOTIONAL"
  • NumberCapabilities — (Array<String>)

    Indicates if the phone number will be used for text messages, voice messages, or both.

  • NumberType — (String)

    The type of phone number to request.

    Possible values include:
    • "LONG_CODE"
    • "TOLL_FREE"
    • "TEN_DLC"
  • OptOutListName — (String)

    The name of the OptOutList to associate with the phone number. You can use the OutOutListName or OptPutListArn.

  • PoolId — (String)

    The pool to associated with the phone number. You can use the PoolId or PoolArn.

  • RegistrationId — (String)

    Use this field to attach your phone number for an external registration process.

  • DeletionProtectionEnabled — (Boolean)

    By default this is set to false. When set to true the phone number can't be deleted.

  • Tags — (Array<map>)

    An array of tags (key and value pairs) associate with the requested phone number.

    • Key — required — (String)

      The key identifier, or name, of the tag.

    • Value — required — (String)

      The string value associated with the key of the tag.

  • ClientToken — (String)

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

    If a token is not provided, the SDK will use a version 4 UUID.

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:

    • PhoneNumberArn — (String)

      The Amazon Resource Name (ARN) of the requested phone number.

    • PhoneNumberId — (String)

      The unique identifier of the new phone number.

    • PhoneNumber — (String)

      The new phone number that was requested.

    • Status — (String)

      The current status of the request.

      Possible values include:
      • "PENDING"
      • "ACTIVE"
      • "ASSOCIATING"
      • "DISASSOCIATING"
      • "DELETED"
    • IsoCountryCode — (String)

      The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

    • MessageType — (String)

      The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

      Possible values include:
      • "TRANSACTIONAL"
      • "PROMOTIONAL"
    • NumberCapabilities — (Array<String>)

      Indicates if the phone number will be used for text messages, voice messages or both.

    • NumberType — (String)

      The type of number that was released.

      Possible values include:
      • "LONG_CODE"
      • "TOLL_FREE"
      • "TEN_DLC"
    • MonthlyLeasingPrice — (String)

      The monthly price, in US dollars, to lease the phone number.

    • TwoWayEnabled — (Boolean)

      By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    • TwoWayChannelArn — (String)

      The ARN used to identify the two way channel.

    • SelfManagedOptOutsEnabled — (Boolean)

      By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

    • OptOutListName — (String)

      The name of the OptOutList that is associated with the requested phone number.

    • DeletionProtectionEnabled — (Boolean)

      By default this is set to false. When set to true the phone number can't be deleted.

    • PoolId — (String)

      The unique identifier of the pool associated with the phone number

    • Tags — (Array<map>)

      An array of key and value pair tags that are associated with the phone number.

      • Key — required — (String)

        The key identifier, or name, of the tag.

      • Value — required — (String)

        The string value associated with the key of the tag.

    • CreatedTimestamp — (Date)

      The time when the phone number was created, in UNIX epoch time format.

Returns:

• (AWS.Request) —

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

var params = {
  DestinationPhoneNumber: 'STRING_VALUE', /* required */
  ConfigurationSetName: 'STRING_VALUE',
  Context: {
    '<ContextKey>': 'STRING_VALUE',
    /* '<ContextKey>': ... */
  },
  DestinationCountryParameters: {
    '<DestinationCountryParameterKey>': 'STRING_VALUE',
    /* '<DestinationCountryParameterKey>': ... */
  },
  DryRun: true || false,
  Keyword: 'STRING_VALUE',
  MaxPrice: 'STRING_VALUE',
  MessageBody: 'STRING_VALUE',
  MessageType: TRANSACTIONAL | PROMOTIONAL,
  OriginationIdentity: 'STRING_VALUE',
  TimeToLive: 'NUMBER_VALUE'
};
pinpointsmsvoicev2.sendTextMessage(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: {}) —
  • DestinationPhoneNumber — (String)

    The destination phone number in E.164 format.

  • OriginationIdentity — (String)

    The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

  • MessageBody — (String)

    The body of the text message.

  • MessageType — (String)

    The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

    Possible values include:
    • "TRANSACTIONAL"
    • "PROMOTIONAL"
  • Keyword — (String)

    When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.

  • ConfigurationSetName — (String)

    The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

  • MaxPrice — (String)

    The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.

  • TimeToLive — (Integer)

    How long the text message is valid for. By default this is 72 hours.

  • Context — (map<String>)

    You can specify custom data in this field. If you do, that data is logged to the event destination.

  • DestinationCountryParameters — (map<String>)

    This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.

  • DryRun — (Boolean)

    When set to true, the message is checked and validated, but isn't sent to the end recipient.

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)

      The unique identifier for the message.

Returns:

• (AWS.Request) —

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

var params = {
  DestinationPhoneNumber: 'STRING_VALUE', /* required */
  OriginationIdentity: 'STRING_VALUE', /* required */
  ConfigurationSetName: 'STRING_VALUE',
  Context: {
    '<ContextKey>': 'STRING_VALUE',
    /* '<ContextKey>': ... */
  },
  DryRun: true || false,
  MaxPricePerMinute: 'STRING_VALUE',
  MessageBody: 'STRING_VALUE',
  MessageBodyTextType: TEXT | SSML,
  TimeToLive: 'NUMBER_VALUE',
  VoiceId: AMY | ASTRID | BIANCA | BRIAN | CAMILA | CARLA | CARMEN | CELINE | CHANTAL | CONCHITA | CRISTIANO | DORA | EMMA | ENRIQUE | EWA | FILIZ | GERAINT | GIORGIO | GWYNETH | HANS | INES | IVY | JACEK | JAN | JOANNA | JOEY | JUSTIN | KARL | KENDRA | KIMBERLY | LEA | LIV | LOTTE | LUCIA | LUPE | MADS | MAJA | MARLENE | MATHIEU | MATTHEW | MAXIM | MIA | MIGUEL | MIZUKI | NAJA | NICOLE | PENELOPE | RAVEENA | RICARDO | RUBEN | RUSSELL | SALLI | SEOYEON | TAKUMI | TATYANA | VICKI | VITORIA | ZEINA | ZHIYU
};
pinpointsmsvoicev2.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: {}) —
  • DestinationPhoneNumber — (String)

    The destination phone number in E.164 format.

  • OriginationIdentity — (String)

    The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.

  • MessageBody — (String)

    The text to convert to a voice message.

  • MessageBodyTextType — (String)

    Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).

    • TEXT: This is the default value. When used the maximum character limit is 3000.

    • SSML: When used the maximum character limit is 6000 including SSML tagging.

    Possible values include:
    • "TEXT"
    • "SSML"
  • VoiceId — (String)

    The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".

    Possible values include:
    • "AMY"
    • "ASTRID"
    • "BIANCA"
    • "BRIAN"
    • "CAMILA"
    • "CARLA"
    • "CARMEN"
    • "CELINE"
    • "CHANTAL"
    • "CONCHITA"
    • "CRISTIANO"
    • "DORA"
    • "EMMA"
    • "ENRIQUE"
    • "EWA"
    • "FILIZ"
    • "GERAINT"
    • "GIORGIO"
    • "GWYNETH"
    • "HANS"
    • "INES"
    • "IVY"
    • "JACEK"
    • "JAN"
    • "JOANNA"
    • "JOEY"
    • "JUSTIN"
    • "KARL"
    • "KENDRA"
    • "KIMBERLY"
    • "LEA"
    • "LIV"
    • "LOTTE"
    • "LUCIA"
    • "LUPE"
    • "MADS"
    • "MAJA"
    • "MARLENE"
    • "MATHIEU"
    • "MATTHEW"
    • "MAXIM"
    • "MIA"
    • "MIGUEL"
    • "MIZUKI"
    • "NAJA"
    • "NICOLE"
    • "PENELOPE"
    • "RAVEENA"
    • "RICARDO"
    • "RUBEN"
    • "RUSSELL"
    • "SALLI"
    • "SEOYEON"
    • "TAKUMI"
    • "TATYANA"
    • "VICKI"
    • "VITORIA"
    • "ZEINA"
    • "ZHIYU"
  • ConfigurationSetName — (String)

    The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

  • MaxPricePerMinute — (String)

    The maximum amount to spend per voice message, in US dollars.

  • TimeToLive — (Integer)

    How long the voice message is valid for. By default this is 72 hours.

  • Context — (map<String>)

    You can specify custom data in this field. If you do, that data is logged to the event destination.

  • DryRun — (Boolean)

    When set to true, the message is checked and validated, but isn't sent to the end recipient.

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)

      The unique identifier for the message.

Returns:

• (AWS.Request) —

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

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  MessageType: TRANSACTIONAL | PROMOTIONAL /* required */
};
pinpointsmsvoicev2.setDefaultMessageType(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 configuration set to update with a new default message type. This field can be the ConsigurationSetName or ConfigurationSetArn.

  • MessageType — (String)

    The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

    Possible values include:
    • "TRANSACTIONAL"
    • "PROMOTIONAL"

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:

    • ConfigurationSetArn — (String)

      The Amazon Resource Name (ARN) of the updated configuration set.

    • ConfigurationSetName — (String)

      The name of the configuration set that was updated.

    • MessageType — (String)

      The new default message type of the configuration set.

      Possible values include:
      • "TRANSACTIONAL"
      • "PROMOTIONAL"

Returns:

• (AWS.Request) —

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

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  SenderId: 'STRING_VALUE' /* required */
};
pinpointsmsvoicev2.setDefaultSenderId(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 configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.

  • SenderId — (String)

    The current sender ID for the configuration set. When sending a text message to a destination country which supports SenderIds, the default sender ID on the configuration set specified on SendTextMessage will be used if no dedicated origination phone numbers or registered SenderIds are available in your account, instead of a generic sender ID, such as 'NOTICE'.

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:

    • ConfigurationSetArn — (String)

      The Amazon Resource Name (ARN) of the updated configuration set.

    • ConfigurationSetName — (String)

      The name of the configuration set that was updated.

    • SenderId — (String)

      The default sender ID to set for the ConfigurationSet.

Returns:

• (AWS.Request) —

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

var params = {
  MonthlyLimit: 'NUMBER_VALUE' /* required */
};
pinpointsmsvoicev2.setTextMessageSpendLimitOverride(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: {}) —
  • MonthlyLimit — (Integer)

    The new monthly limit to enforce on text messages.

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:

    • MonthlyLimit — (Integer)

      The current monthly limit to enforce on sending text messages.

Returns:

• (AWS.Request) —

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

var params = {
  MonthlyLimit: 'NUMBER_VALUE' /* required */
};
pinpointsmsvoicev2.setVoiceMessageSpendLimitOverride(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: {}) —
  • MonthlyLimit — (Integer)

    The new monthly limit to enforce on voice messages.

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:

    • MonthlyLimit — (Integer)

      The current monthly limit to enforce on sending voice messages.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
pinpointsmsvoicev2.tagResource(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: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the resource.

  • Tags — (Array<map>)

    An array of key and value pair tags that are associated with the resource.

    • Key — required — (String)

      The key identifier, or name, of the tag.

    • Value — required — (String)

      The string value associated with the key of the tag.

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.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
pinpointsmsvoicev2.untagResource(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: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the resource.

  • TagKeys — (Array<String>)

    An array of tag key values to unassociate with the resource.

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.

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  EventDestinationName: 'STRING_VALUE', /* required */
  CloudWatchLogsDestination: {
    IamRoleArn: 'STRING_VALUE', /* required */
    LogGroupArn: 'STRING_VALUE' /* required */
  },
  Enabled: true || false,
  KinesisFirehoseDestination: {
    DeliveryStreamArn: 'STRING_VALUE', /* required */
    IamRoleArn: 'STRING_VALUE' /* required */
  },
  MatchingEventTypes: [
    ALL | TEXT_ALL | TEXT_SENT | TEXT_PENDING | TEXT_QUEUED | TEXT_SUCCESSFUL | TEXT_DELIVERED | TEXT_INVALID | TEXT_INVALID_MESSAGE | TEXT_UNREACHABLE | TEXT_CARRIER_UNREACHABLE | TEXT_BLOCKED | TEXT_CARRIER_BLOCKED | TEXT_SPAM | TEXT_UNKNOWN | TEXT_TTL_EXPIRED | VOICE_ALL | VOICE_INITIATED | VOICE_RINGING | VOICE_ANSWERED | VOICE_COMPLETED | VOICE_BUSY | VOICE_NO_ANSWER | VOICE_FAILED | VOICE_TTL_EXPIRED,
    /* more items */
  ],
  SnsDestination: {
    TopicArn: 'STRING_VALUE' /* required */
  }
};
pinpointsmsvoicev2.updateEventDestination(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 configuration set to update with the new event destination. Valid values for this can be the ConfigurationSetName or ConfigurationSetArn.

  • EventDestinationName — (String)

    The name to use for the event destination.

  • Enabled — (Boolean)

    When set to true logging is enabled.

  • MatchingEventTypes — (Array<String>)

    An array of event types that determine which events to log.

  • CloudWatchLogsDestination — (map)

    An object that contains information about an event destination that sends data to CloudWatch Logs.

    • IamRoleArn — required — (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 — required — (String)

      The name of the Amazon CloudWatch log group that you want to record events in.

  • KinesisFirehoseDestination — (map)

    An object that contains information about an event destination for logging to Kinesis Data Firehose.

    • IamRoleArn — required — (String)

      The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.

    • DeliveryStreamArn — required — (String)

      The Amazon Resource Name (ARN) of the delivery stream.

  • SnsDestination — (map)

    An object that contains information about an event destination that sends data to Amazon SNS.

    • TopicArn — required — (String)

      The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.

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:

    • ConfigurationSetArn — (String)

      The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.

    • ConfigurationSetName — (String)

      The name of the configuration set.

    • EventDestination — (map)

      An EventDestination object containing the details of where events will be logged.

      • EventDestinationName — required — (String)

        The name of the EventDestination.

      • Enabled — required — (Boolean)

        When set to true events will be logged.

      • MatchingEventTypes — required — (Array<String>)

        An array of event types that determine which events to log.

      • CloudWatchLogsDestination — (map)

        An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.

        • IamRoleArn — required — (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 — required — (String)

          The name of the Amazon CloudWatch log group that you want to record events in.

      • KinesisFirehoseDestination — (map)

        An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.

        • IamRoleArn — required — (String)

          The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.

        • DeliveryStreamArn — required — (String)

          The Amazon Resource Name (ARN) of the delivery stream.

      • SnsDestination — (map)

        An object that contains information about an event destination that sends logging events to Amazon SNS.

        • TopicArn — required — (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.

var params = {
  PhoneNumberId: 'STRING_VALUE', /* required */
  DeletionProtectionEnabled: true || false,
  OptOutListName: 'STRING_VALUE',
  SelfManagedOptOutsEnabled: true || false,
  TwoWayChannelArn: 'STRING_VALUE',
  TwoWayEnabled: true || false
};
pinpointsmsvoicev2.updatePhoneNumber(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: {}) —
  • PhoneNumberId — (String)

    The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.

  • TwoWayEnabled — (Boolean)

    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

  • TwoWayChannelArn — (String)

    The Amazon Resource Name (ARN) of the two way channel.

  • SelfManagedOptOutsEnabled — (Boolean)

    By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

  • OptOutListName — (String)

    The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.

  • DeletionProtectionEnabled — (Boolean)

    By default this is set to false. When set to true the phone number can't be deleted.

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:

    • PhoneNumberArn — (String)

      The Amazon Resource Name (ARN) of the updated phone number.

    • PhoneNumberId — (String)

      The unique identifier of the phone number.

    • PhoneNumber — (String)

      The phone number that was updated.

    • Status — (String)

      The current status of the request.

      Possible values include:
      • "PENDING"
      • "ACTIVE"
      • "ASSOCIATING"
      • "DISASSOCIATING"
      • "DELETED"
    • IsoCountryCode — (String)

      The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

    • MessageType — (String)

      The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

      Possible values include:
      • "TRANSACTIONAL"
      • "PROMOTIONAL"
    • NumberCapabilities — (Array<String>)

      Specifies if the number could be used for text messages, voice or both.

    • NumberType — (String)

      The type of number that was requested.

      Possible values include:
      • "SHORT_CODE"
      • "LONG_CODE"
      • "TOLL_FREE"
      • "TEN_DLC"
    • MonthlyLeasingPrice — (String)

      The monthly leasing price of the phone number, in US dollars.

    • TwoWayEnabled — (Boolean)

      By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    • TwoWayChannelArn — (String)

      The Amazon Resource Name (ARN) of the two way channel.

    • SelfManagedOptOutsEnabled — (Boolean)

      This is true if self managed opt-out are enabled.

    • OptOutListName — (String)

      The name of the OptOutList associated with the phone number.

    • DeletionProtectionEnabled — (Boolean)

      When set to true the phone number can't be deleted.

    • CreatedTimestamp — (Date)

      The time when the phone number was created, in UNIX epoch time format.

Returns:

• (AWS.Request) —

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

var params = {
  PoolId: 'STRING_VALUE', /* required */
  DeletionProtectionEnabled: true || false,
  OptOutListName: 'STRING_VALUE',
  SelfManagedOptOutsEnabled: true || false,
  SharedRoutesEnabled: true || false,
  TwoWayChannelArn: 'STRING_VALUE',
  TwoWayEnabled: true || false
};
pinpointsmsvoicev2.updatePool(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: {}) —
  • PoolId — (String)

    The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.

  • TwoWayEnabled — (Boolean)

    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

  • TwoWayChannelArn — (String)

    The Amazon Resource Name (ARN) of the two way channel.

  • SelfManagedOptOutsEnabled — (Boolean)

    By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

  • OptOutListName — (String)

    The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.

  • SharedRoutesEnabled — (Boolean)

    Indicates whether shared routes are enabled for the pool.

  • DeletionProtectionEnabled — (Boolean)

    When set to true the pool can't be deleted.

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:

    • PoolArn — (String)

      The ARN of the pool.

    • PoolId — (String)

      The unique identifier of the pool.

    • Status — (String)

      The current status of the pool update request.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "DELETING"
    • MessageType — (String)

      The type of message for the pool to use.

      Possible values include:
      • "TRANSACTIONAL"
      • "PROMOTIONAL"
    • TwoWayEnabled — (Boolean)

      By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    • TwoWayChannelArn — (String)

      The Amazon Resource Name (ARN) of the two way channel.

    • SelfManagedOptOutsEnabled — (Boolean)

      When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

    • OptOutListName — (String)

      The name of the OptOutList associated with the pool.

    • SharedRoutesEnabled — (Boolean)

      Indicates whether shared routes are enabled for the pool.

    • DeletionProtectionEnabled — (Boolean)

      When set to true the pool can't be deleted.

    • CreatedTimestamp — (Date)

      The time when the pool was created, in UNIX epoch time format.

Returns:

• (AWS.Request) —

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

Parameters:

• state (String) —

  the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

• params (map) (defaults to: {}) —

  a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

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

  Callback containing error and data information. See the respective resource state for the expected error or data information.

  If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

• (AWS.Request) —

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