Skip to content

update_router_input

update_router_input(
    arn: RouterInputArn,
    *,
    config_overrides: Optional[MediaConnectClientConfig] = None,
    name: Optional[str] = None,
    configuration: Optional[RouterInputConfiguration] = None,
    maximum_bitrate: Optional[int] = None,
    routing_scope: Optional[RoutingScope] = None,
    tier: Optional[RouterInputTier] = None,
    transit_encryption: Optional[RouterInputTransitEncryption] = None,
    maintenance_configuration: Optional[MaintenanceConfiguration] = None,
    content_quality_analysis_configuration: Optional[
        RouterContentQualityAnalysisConfiguration
    ] = None,
) -> UpdateRouterInputResponse

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

Parameters:

  • arn (RouterInputArn) –

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

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

    The updated name for the router input.

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

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

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

    The updated maximum bitrate for the router input.

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

    Specifies whether the router input can be assigned to outputs in different Regions. REGIONAL (default) - can be assigned only to outputs in the same Region. GLOBAL - can be assigned to outputs in any Region.

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

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

    • INPUT_20 – 20 Mbps

    • INPUT_50 – 50 Mbps

    • INPUT_100 – 100 Mbps

    • INPUT_250 – 250 Mbps

    • INPUT_500 – 500 Mbps

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

  • transit_encryption (Optional[RouterInputTransitEncryption], default: None ) –

    The updated transit encryption settings for the router input.

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

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

  • content_quality_analysis_configuration (Optional[RouterContentQualityAnalysisConfiguration], default: None ) –

    The content quality analysis configuration for the router input.

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_input(
    self,
    arn: "capo_mediaconnect.types.router_input_arn.RouterInputArn",
    *,
    config_overrides: Optional[MediaConnectClientConfig] = None,
    name: Optional[str] = None,
    configuration: Optional[
        "capo_mediaconnect.types.router_input_configuration.RouterInputConfiguration"
    ] = None,
    maximum_bitrate: Optional[int] = None,
    routing_scope: Optional[
        "capo_mediaconnect.types.routing_scope.RoutingScope"
    ] = None,
    tier: Optional[
        "capo_mediaconnect.types.router_input_tier.RouterInputTier"
    ] = None,
    transit_encryption: Optional[
        "capo_mediaconnect.types.router_input_transit_encryption.RouterInputTransitEncryption"
    ] = None,
    maintenance_configuration: Optional[
        "capo_mediaconnect.types.maintenance_configuration.MaintenanceConfiguration"
    ] = None,
    content_quality_analysis_configuration: Optional[
        "capo_mediaconnect.types.router_content_quality_analysis_configuration.RouterContentQualityAnalysisConfiguration"
    ] = None,
) -> (
    "capo_mediaconnect.types.update_router_input_response.UpdateRouterInputResponse"
):
    """<p>Updates the configuration of an existing router input in AWS Elemental MediaConnect.</p>

    Args:
        arn: <p>The Amazon Resource Name (ARN) of the router input that you want to update.</p>
        name: <p>The updated name for the router input.</p>
        configuration: <p>The updated configuration settings for the router input. Changing the type of the configuration is not supported.</p>
        maximum_bitrate: <p>The updated maximum bitrate for the router input.</p>
        routing_scope: <p>Specifies whether the router input can be assigned to outputs in different Regions. REGIONAL (default) - can be assigned only to outputs in the same Region. GLOBAL - can be assigned to outputs in any Region.</p>
        tier: <p>The updated tier level for the router input. The tier sets the maximum bitrate, in Mbps, for the router input. Valid values include the following:</p> <ul> <li> <p> <code>INPUT_20</code> – 20 Mbps</p> </li> <li> <p> <code>INPUT_50</code> – 50 Mbps</p> </li> <li> <p> <code>INPUT_100</code> – 100 Mbps</p> </li> <li> <p> <code>INPUT_250</code> – 250 Mbps</p> </li> <li> <p> <code>INPUT_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>
        transit_encryption: <p>The updated transit encryption settings for the router input.</p>
        maintenance_configuration: <p>The updated maintenance configuration settings for the router input, including any changes to preferred maintenance windows and schedules.</p>
        content_quality_analysis_configuration: <p>The content quality analysis configuration for the router input.</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_input_request.UpdateRouterInputRequest]",
    ) -> OperationResponse[
        "capo_mediaconnect.types.update_router_input_response.UpdateRouterInputResponse"
    ]:
        import capo_mediaconnect._operations.media_connect.update_router_input

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateRouterInput")
    )
    input_: capo_mediaconnect.types.update_router_input_request.UpdateRouterInputRequest = {
        "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 transit_encryption is not None:
        input_["transit_encryption"] = transit_encryption
    if maintenance_configuration is not None:
        input_["maintenance_configuration"] = maintenance_configuration
    if content_quality_analysis_configuration is not None:
        input_["content_quality_analysis_configuration"] = (
            content_quality_analysis_configuration
        )

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