Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateMediaPipelineKinesisVideoStreamPool

Creates an Amazon Kinesis Video Stream pool for use with media stream pipelines.

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.

Request Syntax


POST /media-pipeline-kinesis-video-stream-pools HTTP/1.1
Content-type: application/json

{
   "ClientRequestToken": "string",
   "PoolName": "string",
   "StreamConfiguration": { 
      "DataRetentionInHours": number,
      "Region": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientRequestToken

The token assigned to the client making the request.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [-_a-zA-Z0-9]*

Required: No

PoolName

The name of the pool.

Type: String

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

Pattern: ^[0-9a-zA-Z._-]+

Required: Yes

StreamConfiguration

The configuration settings for the stream.

Type: KinesisVideoStreamConfiguration object

Required: Yes

Tags

The tags assigned to the stream pool.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "KinesisVideoStreamPoolConfiguration": { 
      "CreatedTimestamp": "string",
      "PoolArn": "string",
      "PoolId": "string",
      "PoolName": "string",
      "PoolSize": number,
      "PoolStatus": "string",
      "StreamConfiguration": { 
         "DataRetentionInHours": number,
         "Region": "string"
      },
      "UpdatedTimestamp": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

KinesisVideoStreamPoolConfiguration

The configuration for applying the streams to the pool.

Note

Type: KinesisVideoStreamPoolConfiguration 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

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

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