Method: Aws::ChimeSDKMediaPipelines::Client#update_media_pipeline_kinesis_video_stream_pool

Defined in:

lib/aws-sdk-chimesdkmediapipelines/client.rb

#update_media_pipeline_kinesis_video_stream_pool(params = {}) ⇒ Types::UpdateMediaPipelineKinesisVideoStreamPoolResponse

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

Examples:

Request syntax with placeholder values

resp = client.update_media_pipeline_kinesis_video_stream_pool({
  identifier: "NonEmptyString", # required
  stream_configuration: {
    data_retention_in_hours: 1,
  },
})

Response structure

resp.kinesis_video_stream_pool_configuration.pool_arn #=> String
resp.kinesis_video_stream_pool_configuration.pool_name #=> String
resp.kinesis_video_stream_pool_configuration.pool_id #=> String
resp.kinesis_video_stream_pool_configuration.pool_status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.kinesis_video_stream_pool_configuration.pool_size #=> Integer
resp.kinesis_video_stream_pool_configuration.stream_configuration.region #=> String
resp.kinesis_video_stream_pool_configuration.stream_configuration.data_retention_in_hours #=> Integer
resp.kinesis_video_stream_pool_configuration.created_timestamp #=> Time
resp.kinesis_video_stream_pool_configuration.updated_timestamp #=> Time

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :identifier (required, String) —

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

• :stream_configuration (Types::KinesisVideoStreamConfigurationUpdate) —

  The configuration settings for the video stream.

Returns:

• (Types::UpdateMediaPipelineKinesisVideoStreamPoolResponse) —

  Returns a response object which responds to the following methods:

  • #kinesis_video_stream_pool_configuration => Types::KinesisVideoStreamPoolConfiguration

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 2602

def update_media_pipeline_kinesis_video_stream_pool(params = {}, options = {})
  req = build_request(:update_media_pipeline_kinesis_video_stream_pool, params)
  req.send_request(options)
end