update_route ¶

def update_route(
    self,
    route_name: "capo_app_mesh.types.resource_name.ResourceName",
    mesh_name: "capo_app_mesh.types.resource_name.ResourceName",
    virtual_router_name: "capo_app_mesh.types.resource_name.ResourceName",
    spec: "capo_app_mesh.types.route_spec.RouteSpec",
    *,
    config_overrides: Optional[AppMeshClientConfig] = None,
    client_token: Optional[str] = None,
    mesh_owner: Optional["capo_app_mesh.types.account_id.AccountId"] = None,
) -> "capo_app_mesh.types.update_route_output.UpdateRouteOutput":
    """<p>Updates an existing route for a specified service mesh and virtual router.</p>

    Args:
        route_name: <p>The name of the route to update.</p>
        mesh_name: <p>The name of the service mesh that the route resides in.</p>
        virtual_router_name: <p>The name of the virtual router that the route is associated with.</p>
        spec: <p>The new route specification to apply. This overwrites the existing data.</p>
        client_token: <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>
        mesh_owner: <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>

    Raises:
        capo_app_mesh.errors.bad_request_exception.BadRequestException: <p>The request syntax was malformed. Check your request syntax and try again.</p>
        capo_app_mesh.errors.conflict_exception.ConflictException: <p>The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.</p>
        capo_app_mesh.errors.forbidden_exception.ForbiddenException: <p>You don't have permissions to perform this action.</p>
        capo_app_mesh.errors.internal_server_error_exception.InternalServerErrorException: <p>The request processing has failed because of an unknown error, exception, or failure.</p>
        capo_app_mesh.errors.limit_exceeded_exception.LimitExceededException: <p>You have exceeded a service limit for your account. For more information, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/service-quotas.html">Service Limits</a> in the <i>App Mesh User Guide</i>.</p>
        capo_app_mesh.errors.not_found_exception.NotFoundException: <p>The specified resource doesn't exist. Check your request syntax and try again.</p>
        capo_app_mesh.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed due to a temporary failure of the service.</p>
        capo_app_mesh.errors.too_many_requests_exception.TooManyRequestsException: <p>The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.</p>
        capo_app_mesh.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_app_mesh.types.update_route_input.UpdateRouteInput]",
    ) -> OperationResponse[
        "capo_app_mesh.types.update_route_output.UpdateRouteOutput"
    ]:
        import capo_app_mesh._operations.app_mesh.update_route

        output, http_response = (
            capo_app_mesh._operations.app_mesh.update_route.update_route(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateRoute")
    )
    input_: capo_app_mesh.types.update_route_input.UpdateRouteInput = {
        "route_name": route_name,
        "mesh_name": mesh_name,
        "virtual_router_name": virtual_router_name,
        "spec": spec,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if mesh_owner is not None:
        input_["mesh_owner"] = mesh_owner

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