[ aws . pinpoint-sms-voice-v2 ]
delete-configuration-set¶
Description¶
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
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
delete-configuration-set
--configuration-set-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--configuration-set-name (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.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Output¶
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.
(structure)
Contains information about an event destination.
Event destinations are associated with configuration sets, which enable you to publish message sending events to Amazon CloudWatch, Amazon 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.
(string)
CloudWatchLogsDestination -> (structure)
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 -> (structure)
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 -> (structure)
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 -> (timestamp)
The time that the deleted configuration set was created in UNIX epoch time format.