create_gateway_route async ¶

async def create_gateway_route(
    self,
    gateway_route_name: "capo_app_mesh.types.resource_name.ResourceName",
    mesh_name: "capo_app_mesh.types.resource_name.ResourceName",
    virtual_gateway_name: "capo_app_mesh.types.resource_name.ResourceName",
    spec: "capo_app_mesh.types.gateway_route_spec.GatewayRouteSpec",
    *,
    config_overrides: Optional[AsyncAppMeshClientConfig] = None,
    tags: Optional["capo_app_mesh.types.tag_list.TagList"] = None,
    client_token: Optional[str] = None,
    mesh_owner: Optional["capo_app_mesh.types.account_id.AccountId"] = None,
) -> "capo_app_mesh.types.create_gateway_route_output.CreateGatewayRouteOutput":
    """<p>Creates a gateway route.</p> <p>A gateway route is attached to a virtual gateway and routes traffic to an existing virtual service. If a route matches a request, it can distribute traffic to a target virtual service.</p> <p>For more information about gateway routes, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html">Gateway routes</a>.</p>

    Args:
        gateway_route_name: <p>The name to use for the gateway route.</p>
        mesh_name: <p>The name of the service mesh to create the gateway route in.</p>
        virtual_gateway_name: <p>The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh, then you must be the owner of the virtual gateway resource.</p>
        spec: <p>The gateway route specification to apply.</p>
        tags: <p>Optional metadata that you can apply to the gateway route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</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 the account that you specify must share the mesh with your account before you can create the resource in the service mesh. 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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_app_mesh.types.create_gateway_route_input.CreateGatewayRouteInput]",
    ) -> AsyncOperationResponse[
        "capo_app_mesh.types.create_gateway_route_output.CreateGatewayRouteOutput"
    ]:
        import capo_app_mesh._operations.app_mesh.create_gateway_route

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateGatewayRoute")
    )
    input_: capo_app_mesh.types.create_gateway_route_input.CreateGatewayRouteInput = {
        "gateway_route_name": gateway_route_name,
        "mesh_name": mesh_name,
        "virtual_gateway_name": virtual_gateway_name,
        "spec": spec,
    }
    if tags is not None:
        input_["tags"] = tags
    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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output