Skip to content

update_router_output

update_router_output(
    arn: RouterOutputArn,
    *,
    config_overrides: Optional[MediaConnectClientConfig] = None,
    name: Optional[str] = None,
    configuration: Optional[RouterOutputConfiguration] = None,
    maximum_bitrate: Optional[int] = None,
    routing_scope: Optional[RoutingScope] = None,
    tier: Optional[RouterOutputTier] = None,
    maintenance_configuration: Optional[MaintenanceConfiguration] = None,
    fabric_configuration: Optional[FabricConfiguration] = None,
) -> UpdateRouterOutputResponse

Updates the configuration of an existing router output in AWS Elemental MediaConnect.

Parameters:

  • arn (RouterOutputArn) –

    The Amazon Resource Name (ARN) of the router output that you want to update.

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

    The updated name for the router output.

  • configuration (Optional[RouterOutputConfiguration], default: None ) –

    The updated configuration settings for the router output. Changing the type of the configuration is not supported.

  • maximum_bitrate (Optional[int], default: None ) –

    The updated maximum bitrate for the router output.

  • routing_scope (Optional[RoutingScope], default: None ) –

    Specifies whether the router output can take inputs that are in different Regions. REGIONAL (default) - can only take inputs from same Region. GLOBAL - can take inputs from any Region.

  • tier (Optional[RouterOutputTier], default: None ) –

    The updated tier level for the router output. The tier sets the maximum bitrate, in Mbps, for the router output. Valid values include the following:

    • OUTPUT_20 – 20 Mbps

    • OUTPUT_50 – 50 Mbps

    • OUTPUT_100 – 100 Mbps

    • OUTPUT_250 – 250 Mbps

    • OUTPUT_500 – 500 Mbps

    The 250 Mbps and 500 Mbps tiers are high-bitrate tiers that support TR-07 (JPEG XS) workflows.

  • maintenance_configuration (Optional[MaintenanceConfiguration], default: None ) –

    The updated maintenance configuration settings for the router output, including any changes to preferred maintenance windows and schedules.

  • fabric_configuration (Optional[FabricConfiguration], default: None ) –

    The updated fabric configuration settings for the router output. You cannot update the fabric configuration while the output has an active route. You must unroute the output before updating the fabric configuration.

Raises:

  • BadRequestException –

    This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.

  • ConflictException –

    The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

  • ForbiddenException –

    You do not have sufficient access to perform this action.

  • InternalServerErrorException –

    The server encountered an internal error and is unable to complete the request.

  • NotFoundException –

    One or more of the resources in the request does not exist in the system.

  • ServiceUnavailableException –

    The service is currently unavailable or busy.

  • TooManyRequestsException –

    The request was denied due to request throttling.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_mediaconnect/_services/media_connect.py
def update_router_output(
    self,
    arn: "capo_mediaconnect.types.router_output_arn.RouterOutputArn",
    *,
    config_overrides: Optional[MediaConnectClientConfig] = None,
    name: Optional[str] = None,
    configuration: Optional[
        "capo_mediaconnect.types.router_output_configuration.RouterOutputConfiguration"
    ] = None,
    maximum_bitrate: Optional[int] = None,
    routing_scope: Optional[
        "capo_mediaconnect.types.routing_scope.RoutingScope"
    ] = None,
    tier: Optional[
        "capo_mediaconnect.types.router_output_tier.RouterOutputTier"
    ] = None,
    maintenance_configuration: Optional[
        "capo_mediaconnect.types.maintenance_configuration.MaintenanceConfiguration"
    ] = None,
    fabric_configuration: Optional[
        "capo_mediaconnect.types.fabric_configuration.FabricConfiguration"
    ] = None,
) -> "capo_mediaconnect.types.update_router_output_response.UpdateRouterOutputResponse":
    """<p>Updates the configuration of an existing router output in AWS Elemental MediaConnect.</p>

    Args:
        arn: <p>The Amazon Resource Name (ARN) of the router output that you want to update.</p>
        name: <p>The updated name for the router output.</p>
        configuration: <p>The updated configuration settings for the router output. Changing the type of the configuration is not supported.</p>
        maximum_bitrate: <p>The updated maximum bitrate for the router output.</p>
        routing_scope: <p>Specifies whether the router output can take inputs that are in different Regions. REGIONAL (default) - can only take inputs from same Region. GLOBAL - can take inputs from any Region.</p>
        tier: <p>The updated tier level for the router output. The tier sets the maximum bitrate, in Mbps, for the router output. Valid values include the following:</p> <ul> <li> <p> <code>OUTPUT_20</code> – 20 Mbps</p> </li> <li> <p> <code>OUTPUT_50</code> – 50 Mbps</p> </li> <li> <p> <code>OUTPUT_100</code> – 100 Mbps</p> </li> <li> <p> <code>OUTPUT_250</code> – 250 Mbps</p> </li> <li> <p> <code>OUTPUT_500</code> – 500 Mbps</p> </li> </ul> <p>The 250 Mbps and 500 Mbps tiers are high-bitrate tiers that support TR-07 (JPEG XS) workflows.</p>
        maintenance_configuration: <p>The updated maintenance configuration settings for the router output, including any changes to preferred maintenance windows and schedules.</p>
        fabric_configuration: <p>The updated fabric configuration settings for the router output. You cannot update the fabric configuration while the output has an active route. You must unroute the output before updating the fabric configuration.</p>

    Raises:
        capo_mediaconnect.errors.bad_request_exception.BadRequestException: <p>This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message. </p>
        capo_mediaconnect.errors.conflict_exception.ConflictException: <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. </p>
        capo_mediaconnect.errors.forbidden_exception.ForbiddenException: <p>You do not have sufficient access to perform this action. </p>
        capo_mediaconnect.errors.internal_server_error_exception.InternalServerErrorException: <p>The server encountered an internal error and is unable to complete the request. </p>
        capo_mediaconnect.errors.not_found_exception.NotFoundException: <p>One or more of the resources in the request does not exist in the system. </p>
        capo_mediaconnect.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable or busy. </p>
        capo_mediaconnect.errors.too_many_requests_exception.TooManyRequestsException: <p>The request was denied due to request throttling. </p>
        capo_mediaconnect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_mediaconnect.types.update_router_output_request.UpdateRouterOutputRequest]",
    ) -> OperationResponse[
        "capo_mediaconnect.types.update_router_output_response.UpdateRouterOutputResponse"
    ]:
        import capo_mediaconnect._operations.media_connect.update_router_output

        output, http_response = (
            capo_mediaconnect._operations.media_connect.update_router_output.update_router_output(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateRouterOutput")
    )
    input_: capo_mediaconnect.types.update_router_output_request.UpdateRouterOutputRequest = {
        "arn": arn
    }
    if name is not None:
        input_["name"] = name
    if configuration is not None:
        input_["configuration"] = configuration
    if maximum_bitrate is not None:
        input_["maximum_bitrate"] = maximum_bitrate
    if routing_scope is not None:
        input_["routing_scope"] = routing_scope
    if tier is not None:
        input_["tier"] = tier
    if maintenance_configuration is not None:
        input_["maintenance_configuration"] = maintenance_configuration
    if fabric_configuration is not None:
        input_["fabric_configuration"] = fabric_configuration

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