Table of Contents
A low-level client representing Amazon Pinpoint SMS and Voice Service (Pinpoint SMS Voice) Pinpoint SMS and Voice Messaging public facing APIs:
import boto3
client = boto3.client('pinpoint-sms-voice')
These are the available methods:
Check if an operation can be paginated.
Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
See also: AWS API Documentation
Request Syntax
response = client.create_configuration_set(
ConfigurationSetName='string'
)
{}
Response Structure
Exceptions
Create a new event destination in a configuration set.
See also: AWS API Documentation
Request Syntax
response = client.create_configuration_set_event_destination(
ConfigurationSetName='string',
EventDestination={
'CloudWatchLogsDestination': {
'IamRoleArn': 'string',
'LogGroupArn': 'string'
},
'Enabled': True|False,
'KinesisFirehoseDestination': {
'DeliveryStreamArn': 'string',
'IamRoleArn': 'string'
},
'MatchingEventTypes': [
'INITIATED_CALL'|'RINGING'|'ANSWERED'|'COMPLETED_CALL'|'BUSY'|'FAILED'|'NO_ANSWER',
],
'SnsDestination': {
'TopicArn': 'string'
}
},
EventDestinationName='string'
)
An object that defines a single event destination.
dict
Response Syntax
{}
Response Structure
Exceptions
Deletes an existing configuration set.
See also: AWS API Documentation
Request Syntax
response = client.delete_configuration_set(
ConfigurationSetName='string'
)
{}
Response Structure
Exceptions
Deletes an event destination in a configuration set.
See also: AWS API Documentation
Request Syntax
response = client.delete_configuration_set_event_destination(
ConfigurationSetName='string',
EventDestinationName='string'
)
dict
Response Syntax
{}
Response Structure
Exceptions
Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.
See also: AWS API Documentation
Request Syntax
response = client.get_configuration_set_event_destinations(
ConfigurationSetName='string'
)
{
'EventDestinations': [
{
'CloudWatchLogsDestination': {
'IamRoleArn': 'string',
'LogGroupArn': 'string'
},
'Enabled': True|False,
'KinesisFirehoseDestination': {
'DeliveryStreamArn': 'string',
'IamRoleArn': 'string'
},
'MatchingEventTypes': [
'INITIATED_CALL'|'RINGING'|'ANSWERED'|'COMPLETED_CALL'|'BUSY'|'FAILED'|'NO_ANSWER',
],
'Name': 'string',
'SnsDestination': {
'TopicArn': 'string'
}
},
]
}
Response Structure
Exceptions
Create a paginator for an operation.
Returns an object that can wait for some condition.
Create a new voice message and send it to a recipient's phone number.
See also: AWS API Documentation
Request Syntax
response = client.send_voice_message(
CallerId='string',
ConfigurationSetName='string',
Content={
'CallInstructionsMessage': {
'Text': 'string'
},
'PlainTextMessage': {
'LanguageCode': 'string',
'Text': 'string',
'VoiceId': 'string'
},
'SSMLMessage': {
'LanguageCode': 'string',
'Text': 'string',
'VoiceId': 'string'
}
},
DestinationPhoneNumber='string',
OriginationPhoneNumber='string'
)
An object that contains a voice message and information about the recipient that you want to send it to.
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
Exceptions
Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails.
See also: AWS API Documentation
Request Syntax
response = client.update_configuration_set_event_destination(
ConfigurationSetName='string',
EventDestination={
'CloudWatchLogsDestination': {
'IamRoleArn': 'string',
'LogGroupArn': 'string'
},
'Enabled': True|False,
'KinesisFirehoseDestination': {
'DeliveryStreamArn': 'string',
'IamRoleArn': 'string'
},
'MatchingEventTypes': [
'INITIATED_CALL'|'RINGING'|'ANSWERED'|'COMPLETED_CALL'|'BUSY'|'FAILED'|'NO_ANSWER',
],
'SnsDestination': {
'TopicArn': 'string'
}
},
EventDestinationName='string'
)
An object that defines a single event destination.
dict
Response Syntax
{}
Response Structure
Exceptions