AppMeshClient#
Auto-generated documentation for AppMesh type annotations stubs module mypy-boto3-appmesh.
AppMeshClient#
Type annotations and code completion for boto3.client("appmesh")
.
boto3 documentation
# AppMeshClient usage example
from boto3.session import Session
from mypy_boto3_appmesh.client import AppMeshClient
def get_appmesh_client() -> AppMeshClient:
return Session().client("appmesh")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("appmesh").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("appmesh")
try:
do_something(client)
except (
client.exceptions.BadRequestException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.ForbiddenException,
client.exceptions.InternalServerErrorException,
client.exceptions.LimitExceededException,
client.exceptions.NotFoundException,
client.exceptions.ResourceInUseException,
client.exceptions.ServiceUnavailableException,
client.exceptions.TooManyRequestsException,
client.exceptions.TooManyTagsException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_appmesh.client import Exceptions
def handle_error(exc: Exceptions.BadRequestException) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("appmesh").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("appmesh").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_gateway_route#
Creates a gateway route.
Type annotations and code completion for boto3.client("appmesh").create_gateway_route
method.
boto3 documentation
# create_gateway_route method definition
def create_gateway_route(
self,
*,
gatewayRouteName: str,
meshName: str,
spec: GatewayRouteSpecTypeDef, # (1)
virtualGatewayName: str,
clientToken: str = ...,
meshOwner: str = ...,
tags: Sequence[TagRefTypeDef] = ..., # (2)
) -> CreateGatewayRouteOutputTypeDef: # (3)
...
# create_gateway_route method usage example with argument unpacking
kwargs: CreateGatewayRouteInputRequestTypeDef = { # (1)
"gatewayRouteName": ...,
"meshName": ...,
"spec": ...,
"virtualGatewayName": ...,
}
parent.create_gateway_route(**kwargs)
create_mesh#
Creates a service mesh.
Type annotations and code completion for boto3.client("appmesh").create_mesh
method.
boto3 documentation
# create_mesh method definition
def create_mesh(
self,
*,
meshName: str,
clientToken: str = ...,
spec: MeshSpecTypeDef = ..., # (1)
tags: Sequence[TagRefTypeDef] = ..., # (2)
) -> CreateMeshOutputTypeDef: # (3)
...
- See MeshSpecTypeDef
- See TagRefTypeDef
- See CreateMeshOutputTypeDef
# create_mesh method usage example with argument unpacking
kwargs: CreateMeshInputRequestTypeDef = { # (1)
"meshName": ...,
}
parent.create_mesh(**kwargs)
create_route#
Creates a route that is associated with a virtual router.
Type annotations and code completion for boto3.client("appmesh").create_route
method.
boto3 documentation
# create_route method definition
def create_route(
self,
*,
meshName: str,
routeName: str,
spec: RouteSpecTypeDef, # (1)
virtualRouterName: str,
clientToken: str = ...,
meshOwner: str = ...,
tags: Sequence[TagRefTypeDef] = ..., # (2)
) -> CreateRouteOutputTypeDef: # (3)
...
- See RouteSpecTypeDef
- See TagRefTypeDef
- See CreateRouteOutputTypeDef
# create_route method usage example with argument unpacking
kwargs: CreateRouteInputRequestTypeDef = { # (1)
"meshName": ...,
"routeName": ...,
"spec": ...,
"virtualRouterName": ...,
}
parent.create_route(**kwargs)
create_virtual_gateway#
Creates a virtual gateway.
Type annotations and code completion for boto3.client("appmesh").create_virtual_gateway
method.
boto3 documentation
# create_virtual_gateway method definition
def create_virtual_gateway(
self,
*,
meshName: str,
spec: VirtualGatewaySpecTypeDef, # (1)
virtualGatewayName: str,
clientToken: str = ...,
meshOwner: str = ...,
tags: Sequence[TagRefTypeDef] = ..., # (2)
) -> CreateVirtualGatewayOutputTypeDef: # (3)
...
# create_virtual_gateway method usage example with argument unpacking
kwargs: CreateVirtualGatewayInputRequestTypeDef = { # (1)
"meshName": ...,
"spec": ...,
"virtualGatewayName": ...,
}
parent.create_virtual_gateway(**kwargs)
create_virtual_node#
Creates a virtual node within a service mesh.
Type annotations and code completion for boto3.client("appmesh").create_virtual_node
method.
boto3 documentation
# create_virtual_node method definition
def create_virtual_node(
self,
*,
meshName: str,
spec: VirtualNodeSpecTypeDef, # (1)
virtualNodeName: str,
clientToken: str = ...,
meshOwner: str = ...,
tags: Sequence[TagRefTypeDef] = ..., # (2)
) -> CreateVirtualNodeOutputTypeDef: # (3)
...
# create_virtual_node method usage example with argument unpacking
kwargs: CreateVirtualNodeInputRequestTypeDef = { # (1)
"meshName": ...,
"spec": ...,
"virtualNodeName": ...,
}
parent.create_virtual_node(**kwargs)
create_virtual_router#
Creates a virtual router within a service mesh.
Type annotations and code completion for boto3.client("appmesh").create_virtual_router
method.
boto3 documentation
# create_virtual_router method definition
def create_virtual_router(
self,
*,
meshName: str,
spec: VirtualRouterSpecTypeDef, # (1)
virtualRouterName: str,
clientToken: str = ...,
meshOwner: str = ...,
tags: Sequence[TagRefTypeDef] = ..., # (2)
) -> CreateVirtualRouterOutputTypeDef: # (3)
...
# create_virtual_router method usage example with argument unpacking
kwargs: CreateVirtualRouterInputRequestTypeDef = { # (1)
"meshName": ...,
"spec": ...,
"virtualRouterName": ...,
}
parent.create_virtual_router(**kwargs)
create_virtual_service#
Creates a virtual service within a service mesh.
Type annotations and code completion for boto3.client("appmesh").create_virtual_service
method.
boto3 documentation
# create_virtual_service method definition
def create_virtual_service(
self,
*,
meshName: str,
spec: VirtualServiceSpecTypeDef, # (1)
virtualServiceName: str,
clientToken: str = ...,
meshOwner: str = ...,
tags: Sequence[TagRefTypeDef] = ..., # (2)
) -> CreateVirtualServiceOutputTypeDef: # (3)
...
# create_virtual_service method usage example with argument unpacking
kwargs: CreateVirtualServiceInputRequestTypeDef = { # (1)
"meshName": ...,
"spec": ...,
"virtualServiceName": ...,
}
parent.create_virtual_service(**kwargs)
delete_gateway_route#
Deletes an existing gateway route.
Type annotations and code completion for boto3.client("appmesh").delete_gateway_route
method.
boto3 documentation
# delete_gateway_route method definition
def delete_gateway_route(
self,
*,
gatewayRouteName: str,
meshName: str,
virtualGatewayName: str,
meshOwner: str = ...,
) -> DeleteGatewayRouteOutputTypeDef: # (1)
...
# delete_gateway_route method usage example with argument unpacking
kwargs: DeleteGatewayRouteInputRequestTypeDef = { # (1)
"gatewayRouteName": ...,
"meshName": ...,
"virtualGatewayName": ...,
}
parent.delete_gateway_route(**kwargs)
delete_mesh#
Deletes an existing service mesh.
Type annotations and code completion for boto3.client("appmesh").delete_mesh
method.
boto3 documentation
# delete_mesh method definition
def delete_mesh(
self,
*,
meshName: str,
) -> DeleteMeshOutputTypeDef: # (1)
...
# delete_mesh method usage example with argument unpacking
kwargs: DeleteMeshInputRequestTypeDef = { # (1)
"meshName": ...,
}
parent.delete_mesh(**kwargs)
delete_route#
Deletes an existing route.
Type annotations and code completion for boto3.client("appmesh").delete_route
method.
boto3 documentation
# delete_route method definition
def delete_route(
self,
*,
meshName: str,
routeName: str,
virtualRouterName: str,
meshOwner: str = ...,
) -> DeleteRouteOutputTypeDef: # (1)
...
# delete_route method usage example with argument unpacking
kwargs: DeleteRouteInputRequestTypeDef = { # (1)
"meshName": ...,
"routeName": ...,
"virtualRouterName": ...,
}
parent.delete_route(**kwargs)
delete_virtual_gateway#
Deletes an existing virtual gateway.
Type annotations and code completion for boto3.client("appmesh").delete_virtual_gateway
method.
boto3 documentation
# delete_virtual_gateway method definition
def delete_virtual_gateway(
self,
*,
meshName: str,
virtualGatewayName: str,
meshOwner: str = ...,
) -> DeleteVirtualGatewayOutputTypeDef: # (1)
...
# delete_virtual_gateway method usage example with argument unpacking
kwargs: DeleteVirtualGatewayInputRequestTypeDef = { # (1)
"meshName": ...,
"virtualGatewayName": ...,
}
parent.delete_virtual_gateway(**kwargs)
delete_virtual_node#
Deletes an existing virtual node.
Type annotations and code completion for boto3.client("appmesh").delete_virtual_node
method.
boto3 documentation
# delete_virtual_node method definition
def delete_virtual_node(
self,
*,
meshName: str,
virtualNodeName: str,
meshOwner: str = ...,
) -> DeleteVirtualNodeOutputTypeDef: # (1)
...
# delete_virtual_node method usage example with argument unpacking
kwargs: DeleteVirtualNodeInputRequestTypeDef = { # (1)
"meshName": ...,
"virtualNodeName": ...,
}
parent.delete_virtual_node(**kwargs)
delete_virtual_router#
Deletes an existing virtual router.
Type annotations and code completion for boto3.client("appmesh").delete_virtual_router
method.
boto3 documentation
# delete_virtual_router method definition
def delete_virtual_router(
self,
*,
meshName: str,
virtualRouterName: str,
meshOwner: str = ...,
) -> DeleteVirtualRouterOutputTypeDef: # (1)
...
# delete_virtual_router method usage example with argument unpacking
kwargs: DeleteVirtualRouterInputRequestTypeDef = { # (1)
"meshName": ...,
"virtualRouterName": ...,
}
parent.delete_virtual_router(**kwargs)