DeleteConfigurationSet - AWS End User Messaging SMS

DeleteConfigurationSet

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.

Request Syntax

{ "ConfigurationSetName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ConfigurationSetName

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [A-Za-z0-9_:/-]+

Required: Yes

Response Syntax

{ "ConfigurationSetArn": "string", "ConfigurationSetName": "string", "CreatedTimestamp": number, "DefaultMessageType": "string", "DefaultSenderId": "string", "EventDestinations": [ { "CloudWatchLogsDestination": { "IamRoleArn": "string", "LogGroupArn": "string" }, "Enabled": boolean, "EventDestinationName": "string", "KinesisFirehoseDestination": { "DeliveryStreamArn": "string", "IamRoleArn": "string" }, "MatchingEventTypes": [ "string" ], "SnsDestination": { "TopicArn": "string" } } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ConfigurationSetArn

The Amazon Resource Name (ARN) of the deleted configuration set.

Type: String

ConfigurationSetName

The name of the deleted configuration set.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_-]+

CreatedTimestamp

The time that the deleted configuration set was created in UNIX epoch time format.

Type: Timestamp

DefaultMessageType

The default message type of the configuration set that was deleted.

Type: String

Valid Values: TRANSACTIONAL | PROMOTIONAL

DefaultSenderId

The default Sender ID of the configuration set that was deleted.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 11.

Pattern: [A-Za-z0-9_-]+

EventDestinations

An array of any EventDestination objects that were associated with the deleted configuration set.

Type: Array of EventDestination objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because you don't have sufficient permissions to access the resource.

HTTP Status Code: 400

InternalServerException

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

HTTP Status Code: 500

ResourceNotFoundException

A requested resource couldn't be found.

HTTP Status Code: 400

ThrottlingException

An error that occurred because too many requests were sent during a certain amount of time.

HTTP Status Code: 400

ValidationException

A validation exception for a field.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: