Amazon Pinpoint SMS and Voice
REST API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

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

Name Type Required Description
ConfigurationSetName String True

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

Responses

Status Code Response Model Description
200 DeleteConfigurationSetResponse

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

400 BadRequestException

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

404 NotFoundException

The requested resource wasn't found.

429 TooManyRequestsException

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

500 InternalServiceErrorException

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 Code Response Model Description
200 None

200 response

Schemas

Response Bodies

Example DeleteConfigurationSetResponse

{ }

Example BadRequestException

{ "Message": "string" }

Example NotFoundException

{ "Message": "string" }

Example TooManyRequestsException

{ "Message": "string" }

Example InternalServiceErrorException

{ "Message": "string" }

Properties

BadRequestException

The input that you provided to the API is invalid.

Property Type Required Description
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 an there is an unexpected issue with the Amazon Pinpoint SMS and Voice API service.

Property Type Required Description
Message

string

False

A description of the error that the API encountered.

NotFoundException

The resource you attempted to access doesn't exist.

Property Type Required Description
Message

string

False

A description of the error that the API encountered.

TooManyRequestsException

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

Property Type Required Description
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