Configuration Set - Amazon Pinpoint SMS and Voice

Configuration Set

A configuration set is a set of rules that you apply to the voice messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice messages. For example, when a message is successfully delivered, you can log that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

When you send a voice message, you have to specify one (and only one) configuration set.

URI

/v1/sms-voice/configuration-sets/ConfigurationSetName

HTTP methods

DELETE

Operation ID: DeleteConfigurationSet

Deletes an existing configuration set.

Path parameters
NameTypeRequiredDescription
ConfigurationSetNameStringTrue

The name of the configuration set that you want to delete.

Responses
Status codeResponse modelDescription
200DeleteConfigurationSetResponse

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

400BadRequestException

The request contained syntax that the API couldn't interpret. Modify the request and try again.

404NotFoundException

The requested resource wasn't found.

429TooManyRequestsException

You've issued too many requests to the resource. Wait a few minutes, and then try again.

500InternalServiceErrorException

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.

OPTIONS

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Response bodies

{ }
{ "Message": "string" }
{ "Message": "string" }
{ "Message": "string" }
{ "Message": "string" }

Properties

BadRequestException

The input that you provided to the API is invalid.

PropertyTypeRequiredDescription
Message

string

False

A description of the error that the API encountered.

DeleteConfigurationSetResponse

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

InternalServiceErrorException

This error occurs when there is an unexpected issue with the Amazon Pinpoint SMS and Voice API service.

PropertyTypeRequiredDescription
Message

string

False

A description of the error that the API encountered.

NotFoundException

The resource you attempted to access doesn't exist.

PropertyTypeRequiredDescription
Message

string

False

A description of the error that the API encountered.

TooManyRequestsException

This error occurs when there is an unexpected issue with the Amazon Pinpoint SMS and Voice API service.

PropertyTypeRequiredDescription
Message

string

False

A description of the error that the API encountered.

See also

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

DeleteConfigurationSet