media_pipeline_kinesis_video_stream_pools

Creates, updates, deletes, gets or lists a media_pipeline_kinesis_video_stream_pools resource.

Overview

Name	media_pipeline_kinesis_video_stream_pools
Type	Resource
Id	aws.chime_sdk_media_pipelines.media_pipeline_kinesis_video_stream_pools

Fields

The following fields are returned by SELECT queries:

get_media_pipeline_kinesis_video_stream_pool

Name	Datatype	Description
created_timestamp	string (date-time)	The time at which the configuration was created.
pool_arn	string	The ARN of the video stream pool configuration. (pattern: <code>^arn[/:-_.a-zA-Z0-9]+$</code>)
pool_id	string	The ID of the video stream pool in the configuration. (pattern: <code>^[0-9a-zA-Z._-]+</code>)
pool_name	string	The name of the video stream pool configuration. (pattern: <code>^[0-9a-zA-Z._-]+</code>)
pool_size	integer	The size of the video stream pool in the configuration.
pool_status	string	The status of the video stream pool in the configuration. (CREATING, ACTIVE, UPDATING, DELETING, FAILED)
stream_configuration	object	The configuration of an Kinesis video stream. 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.
updated_timestamp	string (date-time)	The time at which the configuration was updated.

list_media_pipeline_kinesis_video_stream_pools

Name	Datatype	Description
kinesis_video_stream_pools	array	The list of video stream pools.
next_token	string	The token used to return the next page of results. (pattern: <code>.*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_media_pipeline_kinesis_video_stream_pool	select	identifier, region		Gets an Kinesis video stream pool.
list_media_pipeline_kinesis_video_stream_pools	select	region	next-token, max-results	Lists the video stream pools in the media pipeline.
create_media_pipeline_kinesis_video_stream_pool	insert	region, StreamConfiguration, PoolName		Creates an Amazon Kinesis Video Stream pool for use with media stream pipelines. 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.
update_media_pipeline_kinesis_video_stream_pool	update	identifier, region		Updates an Amazon Kinesis Video Stream pool in a media pipeline.
delete_media_pipeline_kinesis_video_stream_pool	delete	identifier, region		Deletes an Amazon Kinesis Video Stream pool.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
identifier	string	The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to return in a single call.
next-token	string	The token used to return the next page of results.

SELECT examples

get_media_pipeline_kinesis_video_stream_pool

Gets an Kinesis video stream pool.

SELECT
created_timestamp,
pool_arn,
pool_id,
pool_name,
pool_size,
pool_status,
stream_configuration,
updated_timestamp
FROM aws.chime_sdk_media_pipelines.media_pipeline_kinesis_video_stream_pools
WHERE identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_media_pipeline_kinesis_video_stream_pools

Lists the video stream pools in the media pipeline.

SELECT
kinesis_video_stream_pools,
next_token
FROM aws.chime_sdk_media_pipelines.media_pipeline_kinesis_video_stream_pools
WHERE region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_media_pipeline_kinesis_video_stream_pool

Creates an Amazon Kinesis Video Stream pool for use with media stream pipelines. 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.

INSERT INTO aws.chime_sdk_media_pipelines.media_pipeline_kinesis_video_stream_pools (
StreamConfiguration,
PoolName,
ClientRequestToken,
Tags,
region
)
SELECT 
'{{ StreamConfiguration }}' /* required */,
'{{ PoolName }}' /* required */,
'{{ ClientRequestToken }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
kinesis_video_stream_pool_configuration
;

Manifest

# Description fields are for documentation purposes
- name: media_pipeline_kinesis_video_stream_pools
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the media_pipeline_kinesis_video_stream_pools resource.
  - name: StreamConfiguration
    description: |
      The configuration of an Kinesis video stream. 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.
    value:
      Region: "{{ Region }}"
      DataRetentionInHours: {{ DataRetentionInHours }}
  - name: PoolName
    value: "{{ PoolName }}"
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_media_pipeline_kinesis_video_stream_pool

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

UPDATE aws.chime_sdk_media_pipelines.media_pipeline_kinesis_video_stream_pools
SET 
StreamConfiguration = '{{ StreamConfiguration }}'
WHERE 
identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
kinesis_video_stream_pool_configuration;

DELETE examples

delete_media_pipeline_kinesis_video_stream_pool

Deletes an Amazon Kinesis Video Stream pool.

DELETE FROM aws.chime_sdk_media_pipelines.media_pipeline_kinesis_video_stream_pools
WHERE identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
;