Skip to content

create_multiplex

create_multiplex(
    *,
    config_overrides: Optional[MediaLiveClientConfig] = None,
    availability_zones: Optional[__listOf__string] = None,
    multiplex_settings: Optional[MultiplexSettings] = None,
    name: Optional[__string] = None,
    request_id: Optional[__string] = None,
    tags: Optional[Tags] = None,
) -> CreateMultiplexResponse

Create a new multiplex.

Parameters:

  • availability_zones (Optional[__listOf__string], default: None ) –

    A list of availability zones for the multiplex. You must specify exactly two.

  • multiplex_settings (Optional[MultiplexSettings], default: None ) –

    Configuration for a multiplex event.

  • name (Optional[__string], default: None ) –

    Name of multiplex.

  • request_id (Optional[__string], default: None ) –

    Unique request ID. This prevents retries from creating multiple resources.

  • tags (Optional[Tags], default: None ) –

    A collection of key-value pairs.

Raises:

Source code in docs_src/capo_medialive/_services/media_live.py
def create_multiplex(
    self,
    *,
    config_overrides: Optional[MediaLiveClientConfig] = None,
    availability_zones: Optional[
        "capo_medialive.types.__list_of__string.__listOf__string"
    ] = None,
    multiplex_settings: Optional[
        "capo_medialive.types.multiplex_settings.MultiplexSettings"
    ] = None,
    name: Optional["capo_medialive.types.__string.__string"] = None,
    request_id: Optional["capo_medialive.types.__string.__string"] = None,
    tags: Optional["capo_medialive.types.tags.Tags"] = None,
) -> "capo_medialive.types.create_multiplex_response.CreateMultiplexResponse":
    """Create a new multiplex.

    Args:
        availability_zones: A list of availability zones for the multiplex. You must specify exactly two.
        multiplex_settings: Configuration for a multiplex event.
        name: Name of multiplex.
        request_id: Unique request ID. This prevents retries from creating multiple resources.
        tags: A collection of key-value pairs.

    Raises:
        capo_medialive.errors.bad_gateway_exception.BadGatewayException: Placeholder documentation for BadGatewayException
        capo_medialive.errors.bad_request_exception.BadRequestException: Placeholder documentation for BadRequestException
        capo_medialive.errors.conflict_exception.ConflictException: Placeholder documentation for ConflictException
        capo_medialive.errors.forbidden_exception.ForbiddenException: Placeholder documentation for ForbiddenException
        capo_medialive.errors.gateway_timeout_exception.GatewayTimeoutException: Placeholder documentation for GatewayTimeoutException
        capo_medialive.errors.internal_server_error_exception.InternalServerErrorException: Placeholder documentation for InternalServerErrorException
        capo_medialive.errors.too_many_requests_exception.TooManyRequestsException: Placeholder documentation for TooManyRequestsException
        capo_medialive.errors.unprocessable_entity_exception.UnprocessableEntityException: Placeholder documentation for UnprocessableEntityException
        capo_medialive.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_medialive.types.create_multiplex_request.CreateMultiplexRequest]",
    ) -> OperationResponse[
        "capo_medialive.types.create_multiplex_response.CreateMultiplexResponse"
    ]:
        import capo_medialive._operations.media_live.create_multiplex

        output, http_response = (
            capo_medialive._operations.media_live.create_multiplex.create_multiplex(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateMultiplex")
    )
    input_: capo_medialive.types.create_multiplex_request.CreateMultiplexRequest = {}
    if availability_zones is not None:
        input_["availability_zones"] = availability_zones
    if multiplex_settings is not None:
        input_["multiplex_settings"] = multiplex_settings
    if name is not None:
        input_["name"] = name
    if request_id is None:
        request_id = str(uuid.uuid4())
    input_["request_id"] = request_id
    if tags is not None:
        input_["tags"] = tags

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output