Class: AWS.PinpointSMSVoiceV2

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

    The unique identifier for the protect configuration.

  • ConfigurationSetName — (String)

    The name of the ConfigurationSet.

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

    • ProtectConfigurationArn — (String)

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

    • ProtectConfigurationId — (String)

      The unique identifier for the protect configuration.

Returns:

• (AWS.Request) —

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

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 | MEDIA_ALL | MEDIA_PENDING | MEDIA_QUEUED | MEDIA_SUCCESSFUL | MEDIA_DELIVERED | MEDIA_INVALID | MEDIA_INVALID_MESSAGE | MEDIA_UNREACHABLE | MEDIA_CARRIER_UNREACHABLE | MEDIA_BLOCKED | MEDIA_CARRIER_BLOCKED | MEDIA_SPAM | MEDIA_UNKNOWN | MEDIA_TTL_EXPIRED | MEDIA_FILE_INACCESSIBLE | MEDIA_FILE_TYPE_UNSUPPORTED | MEDIA_FILE_SIZE_EXCEEDED,
    /* 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 AWS End User Messaging SMS and Voice logs every event type.

    Note: The TEXT_SENT event type is not supported.
  • 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 Identity and Access Management 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 Data Firehose.

    • IamRoleArn — required — (String)

      The ARN of an Identity and Access Management role that is able to write event data to an Amazon Data 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.

        Note: The TEXT_SENT event type is not supported.
      • 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 Identity and Access Management 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 Data Firehose.

        • IamRoleArn — required — (String)

          The ARN of an Identity and Access Management role that is able to write event data to an Amazon Data 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.

    After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.

  • 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. After the pool is created the MessageType can't be changed.

    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.

    • TwoWayChannelRole — (String)

      An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

    • 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, AWS End User Messaging SMS and Voice 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. Set to false and only origination identities in this pool are used to send messages.

    • 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 = {
  ClientToken: 'STRING_VALUE',
  DeletionProtectionEnabled: true || false,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
pinpointsmsvoicev2.createProtectConfiguration(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: {}) —
  • 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.
  • DeletionProtectionEnabled — (Boolean)

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

  • 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. The data object has the following properties:

    • ProtectConfigurationArn — (String)

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

    • ProtectConfigurationId — (String)

      The unique identifier for the protect configuration.

    • CreatedTimestamp — (Date)

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

    • AccountDefault — (Boolean)

      This is true if the protect configuration is set as your account default protect configuration.

    • DeletionProtectionEnabled — (Boolean)

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

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

    The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

  • Tags — (Array<map>)

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

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

    • RegistrationArn — (String)

      The Amazon Resource Name (ARN) for the registration.

    • RegistrationId — (String)

      The unique identifier for the registration.

    • RegistrationType — (String)

      The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

    • RegistrationStatus — (String)

      The status of the registration.

      • CREATED: Your registration is created but not submitted.

      • SUBMITTED: Your registration has been submitted and is awaiting review.

      • REVIEWING: Your registration has been accepted and is being reviewed.

      • PROVISIONING: Your registration has been approved and your origination identity is being created.

      • COMPLETE: Your registration has been approved and and your origination identity has been created.

      • REQUIRES_UPDATES: You must fix your registration and resubmit it.

      • CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.

      • DELETED: The registration has been deleted.

      Possible values include:
      • "CREATED"
      • "SUBMITTED"
      • "REVIEWING"
      • "PROVISIONING"
      • "COMPLETE"
      • "REQUIRES_UPDATES"
      • "CLOSED"
      • "DELETED"
    • CurrentVersionNumber — (Integer)

      The current version number of the registration.

    • AdditionalAttributes — (map<String>)

      Metadata about a given registration which is specific to that registration type.

    • Tags — (Array<map>)

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

      • 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 registration was created, in UNIX epoch time format.

Returns:

• (AWS.Request) —

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

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

    The unique identifier for the registration.

  • ResourceId — (String)

    The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.

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:

    • RegistrationArn — (String)

      The Amazon Resource Name (ARN) for the registration.

    • RegistrationId — (String)

      The unique identifier for the registration.

    • RegistrationType — (String)

      The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.

    • ResourceId — (String)

      The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.

    • ResourceType — (String)

      The registration type or origination identity type.

    • IsoCountryCode — (String)

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

    • PhoneNumber — (String)

      The phone number associated with the registration in E.164 format.

Returns:

• (AWS.Request) —

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

var params = {
  AttachmentBody: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  AttachmentUrl: 'STRING_VALUE',
  ClientToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
pinpointsmsvoicev2.createRegistrationAttachment(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: {}) —
  • AttachmentBody — (Buffer, Typed Array, Blob, String)

    The registration file to upload. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG.

  • AttachmentUrl — (String)

    A URL to the required registration file. For example, you can provide the S3 object URL.

  • Tags — (Array<map>)

    An array of tags (key and value pairs) to associate with the registration attachment.

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

    • RegistrationAttachmentArn — (String)

      The Amazon Resource Name (ARN) for the registration attachment.

    • RegistrationAttachmentId — (String)

      The unique identifier for the registration attachment.

    • AttachmentStatus — (String)

      The status of the registration attachment.

      • UPLOAD_IN_PROGRESS The attachment is being uploaded.

      • UPLOAD_COMPLETE The attachment has been uploaded.

      • UPLOAD_FAILED The attachment failed to uploaded.

      • DELETED The attachment has been deleted..

      Possible values include:
      • "UPLOAD_IN_PROGRESS"
      • "UPLOAD_COMPLETE"
      • "UPLOAD_FAILED"
      • "DELETED"
    • Tags — (Array<map>)

      An array of tags (key and value pairs) to associate with the registration attachment.

      • 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 registration attachment was created, in UNIX epoch time format.

Returns:

• (AWS.Request) —

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

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

    The unique identifier for the registration.

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:

    • RegistrationArn — (String)

      The Amazon Resource Name (ARN) for the registration.

    • RegistrationId — (String)

      The unique identifier for the registration.

    • VersionNumber — (Integer)

      The new version number of the registration.

    • RegistrationVersionStatus — (String)

      The status of the registration.

      • DRAFT: The initial status of a registration version after it’s created.

      • SUBMITTED: Your registration has been submitted.

      • REVIEWING: Your registration has been accepted and is being reviewed.

      • APPROVED: Your registration has been approved.

      • DISCARDED: You've abandon this version of their registration to start over with a new version.

      • DENIED: You must fix your registration and resubmit it.

      • REVOKED: Your previously approved registration has been revoked.

      • ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.

      Possible values include:
      • "DRAFT"
      • "SUBMITTED"
      • "REVIEWING"
      • "APPROVED"
      • "DISCARDED"
      • "DENIED"
      • "REVOKED"
      • "ARCHIVED"
    • RegistrationVersionStatusHistory — (map)

      A RegistrationVersionStatusHistory object that contains timestamps for the registration.

      • DraftTimestamp — required — (Date)

        The time when the registration was in the draft state, in UNIX epoch time format.

      • SubmittedTimestamp — (Date)

        The time when the registration was in the submitted state, in UNIX epoch time format.

      • ReviewingTimestamp — (Date)

        The time when the registration was in the reviewing state, in UNIX epoch time format.

      • ApprovedTimestamp — (Date)

        The time when the registration was in the approved state, in UNIX epoch time format.

      • DiscardedTimestamp — (Date)

        The time when the registration was in the discarded state, in UNIX epoch time format.

      • DeniedTimestamp — (Date)

        The time when the registration was in the denied state, in UNIX epoch time format.

      • RevokedTimestamp — (Date)

        The time when the registration was in the revoked state, in UNIX epoch time format.

      • ArchivedTimestamp — (Date)

        The time when the registration was in the archived state, 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 */
  ClientToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
pinpointsmsvoicev2.createVerifiedDestinationNumber(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 verified destination phone number, in E.164 format.

  • Tags — (Array<map>)

    An array of tags (key and value pairs) to associate with the destination 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:

    • VerifiedDestinationNumberArn — (String)

      The Amazon Resource Name (ARN) for the verified destination phone number.

    • VerifiedDestinationNumberId — (String)

      The unique identifier for the verified destination phone number.

    • DestinationPhoneNumber — (String)

      The verified destination phone number, in E.164 format.

    • Status — (String)

      The status of the verified destination phone number.

      • PENDING: The phone number hasn't been verified yet.

      • VERIFIED: The phone number is verified and can receive messages.

      Possible values include:
      • "PENDING"
      • "VERIFIED"
    • Tags — (Array<map>)

      An array of tags (key and value pairs) to associate with the destination 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 verified 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 = {
};
pinpointsmsvoicev2.deleteAccountDefaultProtectConfiguration(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:

    • DefaultProtectConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the account default protect configuration.

    • DefaultProtectConfigurationId — (String)

      The unique identifier of the account default protect configuration.

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.

        Note: The TEXT_SENT event type is not supported.
      • 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 Identity and Access Management 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 Data Firehose.

        • IamRoleArn — required — (String)

          The ARN of an Identity and Access Management role that is able to write event data to an Amazon Data 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.

        Note: The TEXT_SENT event type is not supported.
      • 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 Identity and Access Management 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 Data Firehose.

        • IamRoleArn — required — (String)

          The ARN of an Identity and Access Management role that is able to write event data to an Amazon Data 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 = {
};
pinpointsmsvoicev2.deleteMediaMessageSpendLimitOverride(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 = {
  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.

    • TwoWayChannelRole — (String)

      An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

    • 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, AWS End User Messaging SMS and Voice 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 = {
  ProtectConfigurationId: 'STRING_VALUE' /* required */
};
pinpointsmsvoicev2.deleteProtectConfiguration(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: {}) —
  • ProtectConfigurationId — (String)

    The unique identifier for the protect configuration.

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:

    • ProtectConfigurationArn — (String)

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

    • ProtectConfigurationId — (String)

      The unique identifier for the protect configuration.

    • CreatedTimestamp — (Date)

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

    • AccountDefault — (Boolean)

      This is true if the protect configuration is set as your account default protect configuration.

    • DeletionProtectionEnabled — (Boolean)

      The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.

Returns:

• (AWS.Request) —

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

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

    The unique identifier for the registration.

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:

    • RegistrationArn — (String)

      The Amazon Resource Name (ARN) for the registration.

    • RegistrationId — (String)

      The unique identifier for the registration.

    • RegistrationType — (String)

      The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

    • RegistrationStatus — (String)

      The status of the registration.

      • CREATED: Your registration is created but not submitted.

      • SUBMITTED: Your registration has been submitted and is awaiting review.

      • REVIEWING: Your registration has been accepted and is being reviewed.

      • PROVISIONING: Your registration has been approved and your origination identity is being created.

      • COMPLETE: Your registration has been approved and and your origination identity has been created.

      • REQUIRES_UPDATES: You must fix your registration and resubmit it.

      • CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.

      • DELETED: The registration has been deleted.

      Possible values include:
      • "CREATED"
      • "SUBMITTED"
      • "REVIEWING"
      • "PROVISIONING"
      • "COMPLETE"
      • "REQUIRES_UPDATES"
      • "CLOSED"
      • "DELETED"
    • CurrentVersionNumber — (Integer)

      The current version number of the registration.

    • ApprovedVersionNumber — (Integer)

      The version number of the registration that was approved.

    • LatestDeniedVersionNumber — (Integer)

      The latest version number of the registration that was denied.

    • AdditionalAttributes — (map<String>)

      Metadata about a given registration which is specific to that registration type.

    • CreatedTimestamp — (Date)

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

Returns:

• (AWS.Request) —

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

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

    The unique identifier for the registration attachment.

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:

    • RegistrationAttachmentArn — (String)

      The Amazon Resource Name (ARN) for the registration attachment.

    • RegistrationAttachmentId — (String)

      The unique identifier for the registration attachment.

    • AttachmentStatus — (String)

      The status of the registration attachment.

      • UPLOAD_IN_PROGRESS The attachment is being uploaded.

      • UPLOAD_COMPLETE The attachment has been uploaded.

      • UPLOAD_FAILED The attachment failed to uploaded.

      • DELETED The attachment has been deleted..

      Possible values include:
      • "UPLOAD_IN_PROGRESS"
      • "UPLOAD_COMPLETE"
      • "UPLOAD_FAILED"
      • "DELETED"
    • AttachmentUploadErrorReason — (String)

      The error message if the upload failed.

      Possible values include:
      • "INTERNAL_ERROR"
    • CreatedTimestamp — (Date)

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

Returns:

• (AWS.Request) —

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

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

    The unique identifier for the registration.

  • FieldPath — (String)

    The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

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:

    • RegistrationArn — (String)

      The Amazon Resource Name (ARN) for the registration.

    • RegistrationId — (String)

      The unique identifier for the registration.

    • VersionNumber — (Integer)

      The version number of the registration.

    • FieldPath — (String)

      The path to the registration form field.

    • SelectChoices — (Array<String>)

      An array of values for the form field.

    • TextValue — (String)

      The text data for a free form field.

    • RegistrationAttachmentId — (String)

      The unique identifier for the registration attachment.

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

    The unique identifier for the verified destination phone number.

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:

    • VerifiedDestinationNumberArn — (String)

      The Amazon Resource Name (ARN) for the verified destination phone number.

    • VerifiedDestinationNumberId — (String)

      The unique identifier for the verified destination phone number.

    • DestinationPhoneNumber — (String)

      The verified destination phone number, in E.164 format.

    • CreatedTimestamp — (Date)

      The time when the destination 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 = {
};
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"
        • "DEFAULT_PROTECT_CONFIGURATION_ID"
      • 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"
        • "SENDER_IDS"
        • "REGISTRATIONS"
        • "REGISTRATION_ATTACHMENTS"
        • "VERIFIED_DESTINATION_NUMBERS"
      • 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 | protect-configuration-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"
      • "protect-configuration-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.

          Note: The TEXT_SENT event type is not supported.
        • 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 Identity and Access Management 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 Data Firehose.

          • IamRoleArn — required — (String)

            The ARN of an Identity and Access Management role that is able to write event data to an Amazon Data 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.

      • ProtectConfigurationId — (String)

        The unique identifier for the protect configuration.

    • 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 | two-way-channel-arn, /* 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"
      • "two-way-channel-arn"
    • 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"
        • "SIMULATOR"
      • 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.

      • TwoWayChannelRole — (String)

        An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

      • 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, AWS End User Messaging SMS and Voice 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.

      • RegistrationId — (String)

        The unique identifier for the registration.

      • 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 | two-way-channel-arn, /* 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"
      • "two-way-channel-arn"
    • 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.

      • TwoWayChannelRole — (String)

        An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

      • 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, AWS End User Messaging SMS and Voice 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 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: account-default | deletion-protection-enabled, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ProtectConfigurationIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
pinpointsmsvoicev2.describeProtectConfigurations(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: {}) —
  • ProtectConfigurationIds — (Array<String>)

    An array of protect configuration identifiers to search for.

  • Filters — (Array<map>)

    An array of ProtectConfigurationFilter objects to filter the results.

    • Name — required — (String)

      The name of the attribute to filter on.

      Possible values include:
      • "account-default"
      • "deletion-protection-enabled"
    • 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:

    • ProtectConfigurations — (Array<map>)

      An array of ProtectConfigurationInformation objects that contain the details for the request.

      • ProtectConfigurationArn — required — (String)

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

      • ProtectConfigurationId — required — (String)

        The unique identifier for the protect configuration.

      • CreatedTimestamp — required — (Date)

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

      • AccountDefault — required — (Boolean)

        This is true if the protect configuration is set as your account default protect configuration.

      • DeletionProtectionEnabled — required — (Boolean)

        The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.

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

Returns:

• (AWS.Request) —

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

var params = {
  Filters: [
    {
      Name: attachment-status, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  RegistrationAttachmentIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
pinpointsmsvoicev2.describeRegistrationAttachments(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: {}) —
  • RegistrationAttachmentIds — (Array<String>)

    The unique identifier of registration attachments to find. This is an array of RegistrationAttachmentId.

  • Filters — (Array<map>)

    An array of RegistrationAttachmentFilter objects to filter the results.

    • Name — required — (String)

      The name of the attribute to filter on.

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

      An array of values to filter on.

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

    • RegistrationAttachments — (Array<map>)

      An array of RegistrationAttachments objects that contain the details for the requested registration attachments.

      • RegistrationAttachmentArn — required — (String)

        The Amazon Resource Name (ARN) for the registration attachment.

      • RegistrationAttachmentId — required — (String)

        The unique identifier for the registration attachment.

      • AttachmentStatus — required — (String)

        The status of the registration attachment.

        • UPLOAD_IN_PROGRESS The attachment is being uploaded.

        • UPLOAD_COMPLETE The attachment has been uploaded.

        • UPLOAD_FAILED The attachment failed to uploaded.

        • DELETED The attachment has been deleted..

        Possible values include:
        • "UPLOAD_IN_PROGRESS"
        • "UPLOAD_COMPLETE"
        • "UPLOAD_FAILED"
        • "DELETED"
      • AttachmentUploadErrorReason — (String)

        A description of why the upload didn't successfully complete.

        Possible values include:
        • "INTERNAL_ERROR"
      • CreatedTimestamp — required — (Date)

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

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

Returns:

• (AWS.Request) —

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

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

    The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

  • SectionPath — (String)

    The path to the section of the registration.

  • FieldPaths — (Array<String>)

    An array of paths to the registration form field.

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

    • RegistrationType — (String)

      The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

    • RegistrationFieldDefinitions — (Array<map>)

      An array of RegistrationFieldDefinitions objects that contain the details for the requested fields.

      • SectionPath — required — (String)

        The section path of the field.

      • FieldPath — required — (String)

        The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

      • FieldType — required — (String)

        The type of field.

        Possible values include:
        • "SELECT"
        • "TEXT"
        • "ATTACHMENT"
      • FieldRequirement — required — (String)

        Specifies if the field for the registration form is required, conditional or optional.

        Possible values include:
        • "REQUIRED"
        • "CONDITIONAL"
        • "OPTIONAL"
      • SelectValidation — (map)

        The validation rules for a select field.

        • MinChoices — required — (Integer)

          The minimum number of choices for the select.

        • MaxChoices — required — (Integer)

          The maximum number of choices for the select.

        • Options — required — (Array<String>)

          An array of strings for the possible selection options.

      • TextValidation — (map)

        The validation rules for a text field.

        • MinLength — required — (Integer)

          The minimum number of characters for the text field.

        • MaxLength — required — (Integer)

          The maximum number of characters for the text field.

        • Pattern — required — (String)

          The regular expression used to validate the text field.

      • DisplayHints — required — (map)

        An array of RegistrationFieldDisplayHints objects for the field.

        • Title — required — (String)

          The title of the display hint.

        • ShortDescription — required — (String)

          A short description of the display hint.

        • LongDescription — (String)

          A full description of the display hint.

        • DocumentationTitle — (String)

          The title of the document the display hint is associated with.

        • DocumentationLink — (String)

          The link to the document the display hint is associated with.

        • SelectOptionDescriptions — (Array<map>)

          An array of SelectOptionDescription objects.

          • Option — required — (String)

            The value of the option.

          • Title — (String)

            The title of the select option.

          • Description — (String)

            A description of the option meaning.

        • TextValidationDescription — (String)

          The validation rules for the text field.

        • ExampleTextValue — (String)

          Example text of what the value of a field should contain.

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

Returns:

• (AWS.Request) —

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

var params = {
  RegistrationId: 'STRING_VALUE', /* required */
  FieldPaths: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SectionPath: 'STRING_VALUE',
  VersionNumber: 'NUMBER_VALUE'
};
pinpointsmsvoicev2.describeRegistrationFieldValues(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: {}) —
  • RegistrationId — (String)

    The unique identifier for the registration.

  • VersionNumber — (Integer)

    The version number of the registration.

  • SectionPath — (String)

    The path to the section of the registration.

  • FieldPaths — (Array<String>)

    An array of paths to the registration form field.

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

    • RegistrationArn — (String)

      The Amazon Resource Name (ARN) for the registration.

    • RegistrationId — (String)

      The unique identifier for the registration.

    • VersionNumber — (Integer)

      The current version of the registration.

    • RegistrationFieldValues — (Array<map>)

      An array of RegistrationFieldValues objects that contain the values for the requested registration.

      • FieldPath — required — (String)

        The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

      • SelectChoices — (Array<String>)

        An array of values for the form field.

      • TextValue — (String)

        The text data for a free form field.

      • RegistrationAttachmentId — (String)

        The unique identifier for the registration attachment.

      • DeniedReason — (String)

        A description of why the registration was denied.

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

Returns:

• (AWS.Request) —

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

var params = {
  Filters: [
    {
      Name: registration-type | registration-status, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  RegistrationIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
pinpointsmsvoicev2.describeRegistrations(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: {}) —
  • RegistrationIds — (Array<String>)

    An array of unique identifiers for each registration.

  • Filters — (Array<map>)

    An array of RegistrationFilter objects to filter the results.

    • Name — required — (String)

      The name of the attribute to filter on.

      Possible values include:
      • "registration-type"
      • "registration-status"
    • Values — required — (Array<String>)

      An array of values to filter on.

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

    • Registrations — (Array<map>)

      An array of RegistrationInformation objects.

      • RegistrationArn — required — (String)

        The Amazon Resource Name (ARN) for the registration.

      • RegistrationId — required — (String)

        The unique identifier for the registration.

      • RegistrationType — required — (String)

        The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

      • RegistrationStatus — required — (String)

        The status of the registration.

        • CREATED: Your registration is created but not submitted.

        • SUBMITTED: Your registration has been submitted and is awaiting review.

        • REVIEWING: Your registration has been accepted and is being reviewed.

        • PROVISIONING: Your registration has been approved and your origination identity is being created.

        • COMPLETE: Your registration has been approved and and your origination identity has been created.

        • REQUIRES_UPDATES: You must fix your registration and resubmit it.

        • CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.

        • DELETED: The registration has been deleted.

        Possible values include:
        • "CREATED"
        • "SUBMITTED"
        • "REVIEWING"
        • "PROVISIONING"
        • "COMPLETE"
        • "REQUIRES_UPDATES"
        • "CLOSED"
        • "DELETED"
      • CurrentVersionNumber — required — (Integer)

        The current version number of the registration.

      • ApprovedVersionNumber — (Integer)

        The version number of the registration that was approved.

      • LatestDeniedVersionNumber — (Integer)

        The latest version number of the registration that was denied.

      • AdditionalAttributes — (map<String>)

        Metadata about a given registration which is specific to that registration type.

      • CreatedTimestamp — required — (Date)

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

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

Returns:

• (AWS.Request) —

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

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

    The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

  • SectionPaths — (Array<String>)

    An array of paths for the registration form section.

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

    • RegistrationType — (String)

      The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

    • RegistrationSectionDefinitions — (Array<map>)

      An array of RegistrationSectionDefinition objects.

      • SectionPath — required — (String)

        The path to the section of the registration.

      • DisplayHints — required — (map)

        The path to the section of the registration.

        • Title — required — (String)

          The title of the display hint.

        • ShortDescription — required — (String)

          A short description of the display hint.

        • LongDescription — (String)

          A full description of the display hint.

        • DocumentationTitle — (String)

          The title of the document the display hint is associated with.

        • DocumentationLink — (String)

          The link to the document the display hint is associated with.

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

Returns:

• (AWS.Request) —

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

var params = {
  Filters: [
    {
      Name: supported-association-resource-type | supported-association-iso-country-code, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  RegistrationTypes: [
    'STRING_VALUE',
    /* more items */
  ]
};
pinpointsmsvoicev2.describeRegistrationTypeDefinitions(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: {}) —
  • RegistrationTypes — (Array<String>)

    The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

  • Filters — (Array<map>)

    An array of RegistrationFilter objects to filter the results.

    • Name — required — (String)

      The name of the attribute to filter on.

      Possible values include:
      • "supported-association-resource-type"
      • "supported-association-iso-country-code"
    • Values — required — (Array<String>)

      An array of values to filter on.

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

    • RegistrationTypeDefinitions — (Array<map>)

      The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

      • RegistrationType — required — (String)

        The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

      • SupportedAssociations — (Array<map>)

        The supported association behavior for the registration type.

        • ResourceType — required — (String)

          Defines the behavior of when an origination identity and registration can be associated with each other.

        • IsoCountryCode — (String)

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

        • AssociationBehavior — required — (String)

          The association behavior.

          • ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.

          • ASSOCIATE_ON_APPROVAL This applies to all short code registrations. The short code will be automatically provisioned once the registration is approved.

          • ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.

          Possible values include:
          • "ASSOCIATE_BEFORE_SUBMIT"
          • "ASSOCIATE_ON_APPROVAL"
          • "ASSOCIATE_AFTER_COMPLETE"
        • DisassociationBehavior — required — (String)

          The disassociation behavior.

          • DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be disassociated from the registration before the registration can be closed.

          • DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted.

          • DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all origination identities will be disasscoiated.

          Possible values include:
          • "DISASSOCIATE_ALL_CLOSES_REGISTRATION"
          • "DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION"
          • "DELETE_REGISTRATION_DISASSOCIATES"
      • DisplayHints — required — (map)

        Provides help information on the registration.

        • Title — required — (String)

          The title of the display hint.

        • ShortDescription — (String)

          A short description of the display hint.

        • LongDescription — (String)

          A full description of the display hint.

        • DocumentationTitle — (String)

          The title of the document the display hint is associated with.

        • DocumentationLink — (String)

          The link to the document the display hint is associated with.

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