GetVoiceConnectorStreamingConfiguration
Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.
Request Syntax
GET /voice-connectors/voiceConnectorId/streaming-configuration HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- voiceConnectorId
-
The Voice Connector ID.
Pattern:
.*\S.*Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"StreamingConfiguration": {
"DataRetentionInHours": number,
"Disabled": boolean,
"MediaInsightsConfiguration": {
"ConfigurationArn": "string",
"Disabled": boolean
},
"StreamingNotificationTargets": [
{
"NotificationTarget": "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.
- StreamingConfiguration
-
The details of the streaming configuration.
Type: StreamingConfiguration object
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
- ForbiddenException
-
The client is permanently forbidden from making the request.
HTTP Status Code: 403
- NotFoundException
-
The requested resource couldn't be found.
HTTP Status Code: 404
- ServiceFailureException
-
The service encountered an unexpected error.
HTTP Status Code: 500
- ServiceUnavailableException
-
The service is currently unavailable.
HTTP Status Code: 503
- ThrottledClientException
-
The number of customer requests exceeds the request rate limit.
HTTP Status Code: 429
- UnauthorizedClientException
-
The client isn't authorized to request a resource.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
