Skip to content

create_virtual_service async

create_virtual_service(
    virtual_service_name: ServiceName,
    mesh_name: ResourceName,
    spec: VirtualServiceSpec,
    *,
    config_overrides: Optional[AsyncAppMeshClientConfig] = None,
    tags: Optional[TagList] = None,
    client_token: Optional[str] = None,
    mesh_owner: Optional[AccountId] = None,
) -> CreateVirtualServiceOutput

Creates a virtual service within a service mesh.

A virtual service is an abstraction of a real service that is provided by a virtual node directly or indirectly by means of a virtual router. Dependent services call your virtual service by its virtualServiceName, and those requests are routed to the virtual node or virtual router that is specified as the provider for the virtual service.

For more information about virtual services, see Virtual services.

Parameters:

  • virtual_service_name (ServiceName) –

    The name to use for the virtual service.

  • mesh_name (ResourceName) –

    The name of the service mesh to create the virtual service in.

  • spec (VirtualServiceSpec) –

    The virtual service specification to apply.

  • tags (Optional[TagList], default: None ) –

    Optional metadata that you can apply to the virtual service 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.

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

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

  • 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 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 Working with shared meshes.

Raises:

  • BadRequestException –

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

  • ConflictException –

    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.

  • ForbiddenException –

    You don't have permissions to perform this action.

  • InternalServerErrorException –

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

  • LimitExceededException –

    You have exceeded a service limit for your account. For more information, see Service Limits in the App Mesh User Guide.

  • 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 create_virtual_service(
    self,
    virtual_service_name: "capo_app_mesh.types.service_name.ServiceName",
    mesh_name: "capo_app_mesh.types.resource_name.ResourceName",
    spec: "capo_app_mesh.types.virtual_service_spec.VirtualServiceSpec",
    *,
    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_virtual_service_output.CreateVirtualServiceOutput":
    """<p>Creates a virtual service within a service mesh.</p> <p>A virtual service is an abstraction of a real service that is provided by a virtual node directly or indirectly by means of a virtual router. Dependent services call your virtual service by its <code>virtualServiceName</code>, and those requests are routed to the virtual node or virtual router that is specified as the provider for the virtual service.</p> <p>For more information about virtual services, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_services.html">Virtual services</a>.</p>

    Args:
        virtual_service_name: <p>The name to use for the virtual service.</p>
        mesh_name: <p>The name of the service mesh to create the virtual service in.</p>
        spec: <p>The virtual service specification to apply.</p>
        tags: <p>Optional metadata that you can apply to the virtual service 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_virtual_service_input.CreateVirtualServiceInput]",
    ) -> AsyncOperationResponse[
        "capo_app_mesh.types.create_virtual_service_output.CreateVirtualServiceOutput"
    ]:
        import capo_app_mesh._operations.app_mesh.create_virtual_service

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateVirtualService")
    )
    input_: capo_app_mesh.types.create_virtual_service_input.CreateVirtualServiceInput = {
        "virtual_service_name": virtual_service_name,
        "mesh_name": mesh_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