Lists all speakers in a specified domain.
Request Syntax
{
"DomainId": "string",
"MaxResults": number,
"NextToken": "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.
- DomainId
-
The identifier of the domain.
Type: String
Length Constraints: Fixed length of 22.
Pattern:
[a-zA-Z0-9]{22}Required: Yes
- MaxResults
-
The maximum number of results that are returned per call. You can use
NextTokento obtain more pages of results. The default is 100; the maximum allowed page size is also 100.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
If
NextTokenis returned, there are more results available. The value ofNextTokenis a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
\p{ASCII}{0,8192}Required: No
Response Syntax
{
"NextToken": "string",
"SpeakerSummaries": [
{
"CreatedAt": number,
"CustomerSpeakerId": "string",
"DomainId": "string",
"GeneratedSpeakerId": "string",
"LastAccessedAt": number,
"Status": "string",
"UpdatedAt": number
}
]
}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.
- NextToken
-
If
NextTokenis returned, there are more results available. The value ofNextTokenis a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.Type: String
Length Constraints: Minimum length of 1.
- SpeakerSummaries
-
A list containing details about each speaker in the AWS account.
Type: Array of SpeakerSummary objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action. Check the error message and try again.
HTTP Status Code: 400
- InternalServerException
-
The request failed due to an unknown error on the server side.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource cannot be found. Check the
ResourceTypeand error message for more details.HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
HTTP Status Code: 400
- ValidationException
-
The request failed one or more validations; check the error message for more details.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
