KinesisVideoStreamConfiguration - Amazon Chime SDK

KinesisVideoStreamConfiguration

The configuration of an Kinesis video stream.

Note

If a meeting uses an opt-in Region as its MediaRegion, the KVS stream must be in that same Region. For example, if a meeting uses the af-south-1 Region, the KVS stream must also be in af-south-1. However, if the meeting uses a Region that AWS turns on by default, the KVS stream can be in any available Region, including an opt-in Region. For example, if the meeting uses ca-central-1, the KVS stream can be in eu-west-2, us-east-1, af-south-1, or any other Region that the Amazon Chime SDK supports.

To learn which AWS Region a meeting uses, call the GetMeeting API and use the MediaRegion parameter from the response.

For more information about opt-in Regions, refer to Available Regions in the Amazon Chime SDK Developer Guide, and Specify which AWS Regions your account can use, in the AWS Account Management Reference Guide.

Contents

Region

The AWS Region of the video stream.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^([a-z]+-){2,}\d+$

Required: Yes

DataRetentionInHours

The amount of time that data is retained.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: