PinpointSMSVoiceV2 / Client / delete_configuration_set
delete_configuration_set#
- PinpointSMSVoiceV2.Client.delete_configuration_set(**kwargs)#
Deletes an existing configuration set.
A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.
See also: AWS API Documentation
Request Syntax
response = client.delete_configuration_set( ConfigurationSetName='string' )
- Parameters:
ConfigurationSetName (string) –
[REQUIRED]
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.
- Return type:
dict
- Returns:
Response Syntax
{ 'ConfigurationSetArn': 'string', 'ConfigurationSetName': 'string', 'EventDestinations': [ { 'EventDestinationName': 'string', 'Enabled': True|False, 'MatchingEventTypes': [ 'ALL'|'TEXT_ALL'|'TEXT_SENT'|'TEXT_PENDING'|'TEXT_QUEUED'|'TEXT_SUCCESSFUL'|'TEXT_DELIVERED'|'TEXT_INVALID'|'TEXT_INVALID_MESSAGE'|'TEXT_UNREACHABLE'|'TEXT_CARRIER_UNREACHABLE'|'TEXT_BLOCKED'|'TEXT_CARRIER_BLOCKED'|'TEXT_SPAM'|'TEXT_UNKNOWN'|'TEXT_TTL_EXPIRED'|'VOICE_ALL'|'VOICE_INITIATED'|'VOICE_RINGING'|'VOICE_ANSWERED'|'VOICE_COMPLETED'|'VOICE_BUSY'|'VOICE_NO_ANSWER'|'VOICE_FAILED'|'VOICE_TTL_EXPIRED', ], 'CloudWatchLogsDestination': { 'IamRoleArn': 'string', 'LogGroupArn': 'string' }, 'KinesisFirehoseDestination': { 'IamRoleArn': 'string', 'DeliveryStreamArn': 'string' }, 'SnsDestination': { 'TopicArn': 'string' } }, ], 'DefaultMessageType': 'TRANSACTIONAL'|'PROMOTIONAL', 'DefaultSenderId': 'string', 'CreatedTimestamp': datetime(2015, 1, 1) }
Response Structure
(dict) –
ConfigurationSetArn (string) –
The Amazon Resource Name (ARN) of the deleted configuration set.
ConfigurationSetName (string) –
The name of the deleted configuration set.
EventDestinations (list) –
An array of any EventDestination objects that were associated with the deleted configuration set.
(dict) –
Contains information about an event destination.
Event destinations are associated with configuration sets, which enable you to publish message sending events to CloudWatch, Kinesis Data Firehose,or Amazon SNS.
EventDestinationName (string) –
The name of the EventDestination.
Enabled (boolean) –
When set to true events will be logged.
MatchingEventTypes (list) –
An array of event types that determine which events to log.
Note
The
TEXT_SENT
event type is not supported.(string) –
CloudWatchLogsDestination (dict) –
An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
IamRoleArn (string) –
The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination.
LogGroupArn (string) –
The name of the Amazon CloudWatch log group that you want to record events in.
KinesisFirehoseDestination (dict) –
An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
IamRoleArn (string) –
The ARN of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon Firehose destination.
DeliveryStreamArn (string) –
The Amazon Resource Name (ARN) of the delivery stream.
SnsDestination (dict) –
An object that contains information about an event destination that sends logging events to Amazon SNS.
TopicArn (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.
DefaultSenderId (string) –
The default Sender ID of the configuration set that was deleted.
CreatedTimestamp (datetime) –
The time that the deleted configuration set was created in UNIX epoch time format.
Exceptions
PinpointSMSVoiceV2.Client.exceptions.ThrottlingException
PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException
PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException
PinpointSMSVoiceV2.Client.exceptions.ValidationException
PinpointSMSVoiceV2.Client.exceptions.InternalServerException