describe_route `async` ¶

describe_route(
    route_name: ResourceName,
    mesh_name: ResourceName,
    virtual_router_name: ResourceName,
    *,
    config_overrides: Optional[AsyncAppMeshClientConfig] = None,
    mesh_owner: Optional[AccountId] = None,
) -> DescribeRouteOutput

Describes an existing route.

Parameters:

route_name (ResourceName) –

The name of the route to describe.
mesh_name (ResourceName) –

The name of the service mesh that the route resides in.
mesh_owner (Optional[AccountId], default: None ) –

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 Working with shared meshes.
virtual_router_name (ResourceName) –

The name of the virtual router that the route is associated with.

Raises:

BadRequestException –

The request syntax was malformed. Check your request syntax and try again.
ForbiddenException –

You don't have permissions to perform this action.
InternalServerErrorException –

The request processing has failed because of an unknown error, exception, or failure.
NotFoundException –

The specified resource doesn't exist. Check your request syntax and try again.
ServiceUnavailableException –

The request has failed due to a temporary failure of the service.
TooManyRequestsException –

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.
UnknownServiceError –

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

Source code in docs_src/capo_app_mesh/_services/async_app_mesh.py

async def describe_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",
    *,
    config_overrides: Optional[AsyncAppMeshClientConfig] = None,
    mesh_owner: Optional["capo_app_mesh.types.account_id.AccountId"] = None,
) -> "capo_app_mesh.types.describe_route_output.DescribeRouteOutput":
    """<p>Describes an existing route.</p>

    Args:
        route_name: <p>The name of the route to describe.</p>
        mesh_name: <p>The name of the service mesh that the route resides in.</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>
        virtual_router_name: <p>The name of the virtual router that the route is associated with.</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.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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_app_mesh.types.describe_route_input.DescribeRouteInput]",
    ) -> AsyncOperationResponse[
        "capo_app_mesh.types.describe_route_output.DescribeRouteOutput"
    ]:
        import capo_app_mesh._operations.app_mesh.describe_route

        (
            output,
            http_response,
        ) = await capo_app_mesh._operations.app_mesh.describe_route.async_describe_route(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeRoute")
    )
    input_: capo_app_mesh.types.describe_route_input.DescribeRouteInput = {
        "route_name": route_name,
        "mesh_name": mesh_name,
        "virtual_router_name": virtual_router_name,
    }
    if mesh_owner is not None:
        input_["mesh_owner"] = mesh_owner

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_route async ¶

describe_route `async` ¶