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.
Parameters:
Raises:
Source code in docs_src/capo_chime_sdk_media_pipelines/_services/async_chime_sdk_media_pipelines.py
| async def create_media_pipeline_kinesis_video_stream_pool(
self,
stream_configuration: "capo_chime_sdk_media_pipelines.types.kinesis_video_stream_configuration.KinesisVideoStreamConfiguration",
pool_name: "capo_chime_sdk_media_pipelines.types.kinesis_video_stream_pool_name.KinesisVideoStreamPoolName",
*,
config_overrides: Optional[AsyncChimeSDKMediaPipelinesClientConfig] = None,
client_request_token: Optional[
"capo_chime_sdk_media_pipelines.types.client_request_token.ClientRequestToken"
] = None,
tags: Optional["capo_chime_sdk_media_pipelines.types.tag_list.TagList"] = None,
) -> "capo_chime_sdk_media_pipelines.types.create_media_pipeline_kinesis_video_stream_pool_response.CreateMediaPipelineKinesisVideoStreamPoolResponse":
"""<p>Creates an Amazon Kinesis Video Stream pool for use with media stream pipelines.</p> <note> <p>If a meeting uses an opt-in Region as its <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html#chimesdk-meeting-chime_CreateMeeting-request-MediaRegion">MediaRegion</a>, the KVS stream must be in that same Region. For example, if a meeting uses the <code>af-south-1</code> Region, the KVS stream must also be in <code>af-south-1</code>. 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 <code>ca-central-1</code>, the KVS stream can be in <code>eu-west-2</code>, <code>us-east-1</code>, <code>af-south-1</code>, or any other Region that the Amazon Chime SDK supports.</p> <p>To learn which AWS Region a meeting uses, call the <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_GetMeeting.html">GetMeeting</a> API and use the <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html#chimesdk-meeting-chime_CreateMeeting-request-MediaRegion">MediaRegion</a> parameter from the response.</p> <p>For more information about opt-in Regions, refer to <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/sdk-available-regions.html">Available Regions</a> in the <i>Amazon Chime SDK Developer Guide</i>, and <a href="https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#rande-manage-enable.html">Specify which AWS Regions your account can use</a>, in the <i>AWS Account Management Reference Guide</i>.</p> </note>
Args:
stream_configuration: <p>The configuration settings for the stream.</p>
pool_name: <p>The name of the pool.</p>
client_request_token: <p>The token assigned to the client making the request.</p>
tags: <p>The tags assigned to the stream pool.</p>
Raises:
capo_chime_sdk_media_pipelines.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
capo_chime_sdk_media_pipelines.errors.conflict_exception.ConflictException: <p>The request could not be processed because of conflict in the current state of the resource.</p>
capo_chime_sdk_media_pipelines.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
capo_chime_sdk_media_pipelines.errors.resource_limit_exceeded_exception.ResourceLimitExceededException: <p>The request exceeds the resource limit.</p>
capo_chime_sdk_media_pipelines.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
capo_chime_sdk_media_pipelines.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
capo_chime_sdk_media_pipelines.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
capo_chime_sdk_media_pipelines.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
capo_chime_sdk_media_pipelines.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_chime_sdk_media_pipelines.types.create_media_pipeline_kinesis_video_stream_pool_request.CreateMediaPipelineKinesisVideoStreamPoolRequest]",
) -> AsyncOperationResponse[
"capo_chime_sdk_media_pipelines.types.create_media_pipeline_kinesis_video_stream_pool_response.CreateMediaPipelineKinesisVideoStreamPoolResponse"
]:
import capo_chime_sdk_media_pipelines._operations.chime_sdk_media_pipelines_service.create_media_pipeline_kinesis_video_stream_pool
(
output,
http_response,
) = await capo_chime_sdk_media_pipelines._operations.chime_sdk_media_pipelines_service.create_media_pipeline_kinesis_video_stream_pool.async_create_media_pipeline_kinesis_video_stream_pool(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
def _redact_input(
input_: "capo_chime_sdk_media_pipelines.types.create_media_pipeline_kinesis_video_stream_pool_request.CreateMediaPipelineKinesisVideoStreamPoolRequest",
) -> dict[str, Any]:
import capo_chime_sdk_media_pipelines.types.create_media_pipeline_kinesis_video_stream_pool_request
return capo_chime_sdk_media_pipelines.types.create_media_pipeline_kinesis_video_stream_pool_request.redact_sensitive(
input_
)
def _redact_output(
output: "capo_chime_sdk_media_pipelines.types.create_media_pipeline_kinesis_video_stream_pool_response.CreateMediaPipelineKinesisVideoStreamPoolResponse",
) -> dict[str, Any]:
import capo_chime_sdk_media_pipelines.types.create_media_pipeline_kinesis_video_stream_pool_response
return capo_chime_sdk_media_pipelines.types.create_media_pipeline_kinesis_video_stream_pool_response.redact_sensitive(
output
)
interceptors_, options_ = self.operation_options(
config_overrides,
OperationLogging(
"CreateMediaPipelineKinesisVideoStreamPool",
redact_input=_redact_input,
redact_output=_redact_output,
),
)
input_: capo_chime_sdk_media_pipelines.types.create_media_pipeline_kinesis_video_stream_pool_request.CreateMediaPipelineKinesisVideoStreamPoolRequest = {
"stream_configuration": stream_configuration,
"pool_name": pool_name,
}
if client_request_token is None:
client_request_token = str(uuid.uuid4())
input_["client_request_token"] = client_request_token
if tags is not None:
input_["tags"] = tags
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|