@datafire/amazonaws_sms_voice NPM

@datafire/amazonaws_sms_voice

Client library for Amazon Pinpoint SMS and Voice Service

Installation and Usage

npm install --save @datafire/amazonaws_sms_voice

let amazonaws_sms_voice = require('@datafire/amazonaws_sms_voice').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Pinpoint SMS and Voice Messaging public facing APIs

Actions

ListConfigurationSets

amazonaws_sms_voice.ListConfigurationSets({}, context)

Input

input object
- NextToken string
- PageSize string

Output

output ListConfigurationSetsResponse

CreateConfigurationSet

amazonaws_sms_voice.CreateConfigurationSet({}, context)

Input

input object
- ConfigurationSetName string: The name that you want to give the configuration set.

Output

output CreateConfigurationSetResponse

DeleteConfigurationSet

amazonaws_sms_voice.DeleteConfigurationSet({
  "ConfigurationSetName": ""
}, context)

Input

input object
- ConfigurationSetName required string

Output

output DeleteConfigurationSetResponse

GetConfigurationSetEventDestinations

amazonaws_sms_voice.GetConfigurationSetEventDestinations({
  "ConfigurationSetName": ""
}, context)

Input

input object
- ConfigurationSetName required string

Output

output GetConfigurationSetEventDestinationsResponse

CreateConfigurationSetEventDestination

amazonaws_sms_voice.CreateConfigurationSetEventDestination({
  "ConfigurationSetName": ""
}, context)

Input

input object
- ConfigurationSetName required string
- EventDestination object: An object that defines a single event destination.
  - CloudWatchLogsDestination CloudWatchLogsDestination
  - Enabled
  - KinesisFirehoseDestination KinesisFirehoseDestination
  - MatchingEventTypes EventTypes
  - SnsDestination SnsDestination
- EventDestinationName string: A name that identifies the event destination.

Output

output CreateConfigurationSetEventDestinationResponse

DeleteConfigurationSetEventDestination

amazonaws_sms_voice.DeleteConfigurationSetEventDestination({
  "ConfigurationSetName": "",
  "EventDestinationName": ""
}, context)

Input

input object
- ConfigurationSetName required string
- EventDestinationName required string

Output

output DeleteConfigurationSetEventDestinationResponse

UpdateConfigurationSetEventDestination

amazonaws_sms_voice.UpdateConfigurationSetEventDestination({
  "ConfigurationSetName": "",
  "EventDestinationName": ""
}, context)

Input

input object
- ConfigurationSetName required string
- EventDestinationName required string
- EventDestination object: An object that defines a single event destination.
  - CloudWatchLogsDestination CloudWatchLogsDestination
  - Enabled
  - KinesisFirehoseDestination KinesisFirehoseDestination
  - MatchingEventTypes EventTypes
  - SnsDestination SnsDestination

Output

output UpdateConfigurationSetEventDestinationResponse

SendVoiceMessage

amazonaws_sms_voice.SendVoiceMessage({}, context)

Input

input object
- CallerId string: The phone number that appears on recipients' devices when they receive the message.
- ConfigurationSetName string: The name of the configuration set that you want to use to send the message.
- Content object: An object that contains a voice message and information about the recipient that you want to send it to.
  - CallInstructionsMessage CallInstructionsMessageType
  - PlainTextMessage PlainTextMessageType
  - SSMLMessage SSMLMessageType
- DestinationPhoneNumber string: The phone number that you want to send the voice message to.
- OriginationPhoneNumber string: The phone number that Amazon Pinpoint should use to send the voice message. This isn't necessarily the phone number that appears on recipients' devices when they receive the message, because you can specify a CallerId parameter in the request.

Output

output SendVoiceMessageResponse

Definitions

AlreadyExistsException

BadRequestException

Boolean

Boolean boolean

CallInstructionsMessageType

CallInstructionsMessageType object: An object that defines a message that contains text formatted using Amazon Pinpoint Voice Instructions markup.
- Text

CloudWatchLogsDestination

CloudWatchLogsDestination object: An object that contains information about an event destination that sends data to Amazon CloudWatch Logs.
- IamRoleArn
- LogGroupArn

ConfigurationSets

ConfigurationSets array: An array that contains all of the configuration sets in your Amazon Pinpoint account in the current AWS Region.
- items WordCharactersWithDelimiters

CreateConfigurationSetEventDestinationRequest

CreateConfigurationSetEventDestinationRequest object: Create a new event destination in a configuration set.
- EventDestination EventDestinationDefinition
- EventDestinationName

CreateConfigurationSetEventDestinationResponse

CreateConfigurationSetEventDestinationResponse object: An empty object that indicates that the event destination was created successfully.

CreateConfigurationSetRequest

CreateConfigurationSetRequest object: A request to create a new configuration set.
- ConfigurationSetName

CreateConfigurationSetResponse

CreateConfigurationSetResponse object: An empty object that indicates that the configuration set was successfully created.

DeleteConfigurationSetEventDestinationRequest

DeleteConfigurationSetEventDestinationRequest object

DeleteConfigurationSetEventDestinationResponse

DeleteConfigurationSetEventDestinationResponse object: An empty object that indicates that the event destination was deleted successfully.

DeleteConfigurationSetRequest

DeleteConfigurationSetRequest object

DeleteConfigurationSetResponse

DeleteConfigurationSetResponse object: An empty object that indicates that the configuration set was deleted successfully.

EventDestination

EventDestination object: An object that defines an event destination.
- CloudWatchLogsDestination CloudWatchLogsDestination
- Enabled
- KinesisFirehoseDestination KinesisFirehoseDestination
- MatchingEventTypes EventTypes
- Name
- SnsDestination SnsDestination

EventDestinationDefinition

EventDestinationDefinition object: An object that defines a single event destination.
- CloudWatchLogsDestination CloudWatchLogsDestination
- Enabled
- KinesisFirehoseDestination KinesisFirehoseDestination
- MatchingEventTypes EventTypes
- SnsDestination SnsDestination

EventDestinations

EventDestinations array: An array of EventDestination objects. Each EventDestination object includes ARNs and other information that define an event destination.
- items EventDestination

EventType

EventType string (values: INITIATED_CALL, RINGING, ANSWERED, COMPLETED_CALL, BUSY, FAILED, NO_ANSWER): The types of events that are sent to the event destination.

EventTypes

EventTypes array: An array of EventDestination objects. Each EventDestination object includes ARNs and other information that define an event destination.
- items EventType

GetConfigurationSetEventDestinationsRequest

GetConfigurationSetEventDestinationsRequest object

GetConfigurationSetEventDestinationsResponse

GetConfigurationSetEventDestinationsResponse object: An object that contains information about an event destination.
- EventDestinations EventDestinations

InternalServiceErrorException

KinesisFirehoseDestination

KinesisFirehoseDestination object: An object that contains information about an event destination that sends data to Amazon Kinesis Data Firehose.
- DeliveryStreamArn
- IamRoleArn

LimitExceededException

ListConfigurationSetsRequest

ListConfigurationSetsRequest object

ListConfigurationSetsResponse

ListConfigurationSetsResponse object: An object that contains information about the configuration sets for your account in the current region.
- ConfigurationSets
  - items WordCharactersWithDelimiters
- NextToken

NextTokenString

NextTokenString string

NonEmptyString

NonEmptyString string

NotFoundException

PlainTextMessageType

PlainTextMessageType object: An object that defines a message that contains unformatted text.
- LanguageCode
- Text
- VoiceId

SSMLMessageType

SSMLMessageType object: An object that defines a message that contains SSML-formatted text.
- LanguageCode
- Text
- VoiceId

SendVoiceMessageRequest

SendVoiceMessageRequest object: SendVoiceMessageRequest
- CallerId
- ConfigurationSetName
- Content VoiceMessageContent
- DestinationPhoneNumber
- OriginationPhoneNumber

SendVoiceMessageResponse

SendVoiceMessageResponse object: An object that that contains the Message ID of a Voice message that was sent successfully.
- MessageId

SnsDestination

SnsDestination object: An object that contains information about an event destination that sends data to Amazon SNS.
- TopicArn

String

String string

TooManyRequestsException

UpdateConfigurationSetEventDestinationRequest

UpdateConfigurationSetEventDestinationRequest object: UpdateConfigurationSetEventDestinationRequest
- EventDestination EventDestinationDefinition

UpdateConfigurationSetEventDestinationResponse

UpdateConfigurationSetEventDestinationResponse object: An empty object that indicates that the event destination was updated successfully.

VoiceMessageContent

VoiceMessageContent object: An object that contains a voice message and information about the recipient that you want to send it to.
- CallInstructionsMessage CallInstructionsMessageType
- PlainTextMessage PlainTextMessageType
- SSMLMessage SSMLMessageType

WordCharactersWithDelimiters

WordCharactersWithDelimiters string

__string

__string string

datafire aws-sdk

@infinitebrahmanuniverse/nolb-_datafire_am @everything-registry/sub-chunk-220

5.0.0

5 years ago