The Amazon Chime SDK Identity, Media Pipelines, Meetings, and Messaging APIs are now published on the new Amazon Chime SDK API Reference. For more information, see the Amazon Chime SDK API Reference.
PutVoiceConnectorStreamingConfiguration
Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.
Important
This API is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorStreamingConfiguration, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Request Syntax
PUT /voice-connectors/voiceConnectorId
/streaming-configuration HTTP/1.1
Content-type: application/json
{
"StreamingConfiguration": {
"DataRetentionInHours": number
,
"Disabled": boolean
,
"StreamingNotificationTargets": [
{
"NotificationTarget": "string
"
}
]
}
}
URI Request Parameters
The request uses the following URI parameters.
- voiceConnectorId
-
The Amazon Chime Voice Connector ID.
Pattern:
.*\S.*
Required: Yes
Request Body
The request accepts the following data in JSON format.
- StreamingConfiguration
-
The streaming configuration details to add.
Type: StreamingConfiguration object
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"StreamingConfiguration": {
"DataRetentionInHours": number,
"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 updated streaming configuration details.
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
-
One or more of the resources in the request does not exist in the system.
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 client exceeded its request rate limit.
HTTP Status Code: 429
- UnauthorizedClientException
-
The client is not currently authorized to make the request.
HTTP Status Code: 401
Examples
In the following example or examples, the Authorization header contents(
AUTHPARAMS
) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see
Signature Version 4 Signing Process in the AWS General Reference.
You only need to learn how to sign HTTP requests if you intend to manually create them. When
you use the AWS Command Line Interface (AWS
CLI)
Example
This example adds a streaming configuration for the specified Amazon Chime Voice Connector.
Sample Request
PUT /voice-connectors/abcdef1ghij2klmno3pqr4/streaming-configuration HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T161659Z Authorization: AUTHPARAMS Content-Length: 75 {"StreamingConfiguration": {"DataRetentionInHours": 24, "Disabled": false}}
Sample Response
HTTP/1.1 200 OK x-amzn-RequestId: 9ac21e90-1aae-40f2-b4c4-4e7be37b8a97 Content-Type: application/json Content-Length: 71 Date: Wed, 18 Sep 2019 16:16:59 GMT Connection: keep-alive {"StreamingConfiguration":{"DataRetentionInHours":24,"Disabled":false}}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: