URI HTTP methods Schemas Properties See also

Configuration Sets

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

HTTP methods

GET

Operation ID: ListConfigurationSets

Retrieves a list of configuration sets that are associated with your account in the current AWS Region.

Query parameters
Name	Type	Required	Description
`PageSize`	String	False	Used to specify the number of items that should be returned in the response.
`NextToken`	String	False	A token returned from a previous call to the API that indicates the position in the list of results.

Responses
Status code	Response model	Description
`200`	`ListConfigurationSetsResponse`	An object that contains information about the configuration sets for your account in the current AWS Region.
`400`	`BadRequestException`	The request contained syntax that the API couldn't interpret. Modify the request and try again.
`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.

POST

Operation ID: CreateConfigurationSet

Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.

Responses
Status code	Response model	Description
`200`	`CreateConfigurationSetResponse`	An empty object that indicates that the configuration set was successfully created.
`400`	`BadRequestException`	The request contained syntax that the API couldn't interpret. Modify the request and try again.
`409`	`AlreadyExistsException`	The resource you tried to create already exists.
`412`	`LimitExceededException`	You've tried to create a number of resources that exceeds the maximum number of resources for your account. For more information, see Amazon Pinpoint Quotas in the Amazon Pinpoint Developer Guide.
`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	Indicates that the API successfully received the request.

Schemas

Request bodies


{
  "ConfigurationSetName": "string"
}

Response bodies


{
  "NextToken": "string",
  "ConfigurationSets": [
    "string"
  ]
}

{
}


{
  "Message": "string"
}


{
  "Message": "string"
}


{
  "Message": "string"
}


{
  "Message": "string"
}


{
  "Message": "string"
}

Properties

AlreadyExistsException

The resource that you specified in your request already exists.

Property	Type	Required	Description
`Message`	string	False	A description of the error that the API encountered.

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.

CreateConfigurationSetRequest

A request to create a new configuration set.

Property	Type	Required	Description
`ConfigurationSetName`	string	True	The name that you want to give the configuration set.

CreateConfigurationSetResponse

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

InternalServiceErrorException

This error occurs when 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.

LimitExceededException

There are too many instances of the specified resource type.

Property	Type	Required	Description
`Message`	string	False	A description of the error that the API encountered.

ListConfigurationSetsResponse

An object that contains information about configuration sets.

Property	Type	Required	Description
`ConfigurationSets`	Array of type string	False	An object that contains a list of configuration sets for your account in the current AWS Region.
`NextToken`	string	False	A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.

TooManyRequestsException

This error occurs when 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.