[ aws . chime-sdk-media-pipelines ]

create-media-pipeline-kinesis-video-stream-pool

Description

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 .

See also: AWS API Documentation

Synopsis

  create-media-pipeline-kinesis-video-stream-pool
--stream-configuration <value>
--pool-name <value>
[--client-request-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--stream-configuration (structure)

The configuration settings for the stream.

Region -> (string)

The Amazon Web Services Region of the video stream.

DataRetentionInHours -> (integer)

The amount of time that data is retained.

Shorthand Syntax:

Region=string,DataRetentionInHours=integer

JSON Syntax:

{
  "Region": "string",
  "DataRetentionInHours": integer
}

--pool-name (string)

The name of the pool.

--client-request-token (string)

The token assigned to the client making the request.

--tags (list)

The tags assigned to the stream pool.

(structure)

A key/value pair that grants users access to meeting resources.

Key -> (string)

The key half of a tag.

Value -> (string)

The value half of a tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

KinesisVideoStreamPoolConfiguration -> (structure)

The configuration for applying the streams to the pool.

PoolArn -> (string)

The ARN of the video stream pool configuration.

PoolName -> (string)

The name of the video stream pool configuration.

PoolId -> (string)

The ID of the video stream pool in the configuration.

PoolStatus -> (string)

The status of the video stream pool in the configuration.

PoolSize -> (integer)

The size of the video stream pool in the configuration.

StreamConfiguration -> (structure)

The Kinesis video stream pool configuration object.

Region -> (string)

The Amazon Web Services Region of the video stream.

DataRetentionInHours -> (integer)

The amount of time that data is retained.

CreatedTimestamp -> (timestamp)

The time at which the configuration was created.

UpdatedTimestamp -> (timestamp)

The time at which the configuration was updated.