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

UpdateMediaPipelineKinesisVideoStreamPool

Updates an Amazon Kinesis Video Stream pool in a media pipeline.

Request Syntax


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

{
   "StreamConfiguration": { 
      "DataRetentionInHours": number
   }
}

URI Request Parameters

The request uses the following URI parameters.

identifier

The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.

Length Constraints: Maximum length of 1024.

Pattern: .*\S.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

StreamConfiguration

The configuration settings for the video stream.

Type: KinesisVideoStreamConfigurationUpdate object

Required: No

Response Syntax


HTTP/1.1 200
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 200 response.

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

KinesisVideoStreamPoolConfiguration

The video stream pool configuration object.

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.

RequestId: The request ID associated with the call responsible for the exception.

HTTP Status Code: 400

ConflictException

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

RequestId: The request ID associated with the call responsible for the exception.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

RequestId: The request id associated with the call responsible for the exception.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

RequestId: The request ID associated with the call responsible for the exception.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

RequestId: The request ID associated with the call responsible for the exception.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

RequestId: The request ID associated with the call responsible for the exception.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

RequestId: The request ID associated with the call responsible for the exception.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

RequestId: The request ID associated with the call responsible for the exception.

HTTP Status Code: 401