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
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.
client = boto3.client("appmesh")
try:
do_something(client)
except (
client.BadRequestException,
client.ClientError,
client.ConflictException,
client.ForbiddenException,
client.InternalServerErrorException,
client.LimitExceededException,
client.NotFoundException,
client.ResourceInUseException,
client.ServiceUnavailableException,
client.TooManyRequestsException,
client.TooManyTagsException,
) as e:
print(e)
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
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("appmesh").close
method.
boto3 documentation
create_gateway_route
Creates a gateway route.
Type annotations and code completion for boto3.client("appmesh").create_gateway_route
method.
boto3 documentation
def create_gateway_route(
self,
*,
gatewayRouteName: str,
meshName: str,
spec: GatewayRouteSpecTypeDef, # (1)
virtualGatewayName: str,
clientToken: str = ...,
meshOwner: str = ...,
tags: Sequence[TagRefTypeDef] = ..., # (2)
) -> CreateGatewayRouteOutputTypeDef: # (3)
...
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
def create_mesh(
self,
*,
meshName: str,
clientToken: str = ...,
spec: MeshSpecTypeDef = ..., # (1)
tags: Sequence[TagRefTypeDef] = ..., # (2)
) -> CreateMeshOutputTypeDef: # (3)
...
- See MeshSpecTypeDef
- See TagRefTypeDef
- See CreateMeshOutputTypeDef
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
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
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
def create_virtual_gateway(
self,
*,
meshName: str,
spec: VirtualGatewaySpecTypeDef, # (1)
virtualGatewayName: str,
clientToken: str = ...,
meshOwner: str = ...,
tags: Sequence[TagRefTypeDef] = ..., # (2)
) -> CreateVirtualGatewayOutputTypeDef: # (3)
...
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
def create_virtual_node(
self,
*,
meshName: str,
spec: VirtualNodeSpecTypeDef, # (1)
virtualNodeName: str,
clientToken: str = ...,
meshOwner: str = ...,
tags: Sequence[TagRefTypeDef] = ..., # (2)
) -> CreateVirtualNodeOutputTypeDef: # (3)
...
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
def create_virtual_router(
self,
*,
meshName: str,
spec: VirtualRouterSpecTypeDef, # (1)
virtualRouterName: str,
clientToken: str = ...,
meshOwner: str = ...,
tags: Sequence[TagRefTypeDef] = ..., # (2)
) -> CreateVirtualRouterOutputTypeDef: # (3)
...
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
def create_virtual_service(
self,
*,
meshName: str,
spec: VirtualServiceSpecTypeDef, # (1)
virtualServiceName: str,
clientToken: str = ...,
meshOwner: str = ...,
tags: Sequence[TagRefTypeDef] = ..., # (2)
) -> CreateVirtualServiceOutputTypeDef: # (3)
...
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
def delete_gateway_route(
self,
*,
gatewayRouteName: str,
meshName: str,
virtualGatewayName: str,
meshOwner: str = ...,
) -> DeleteGatewayRouteOutputTypeDef: # (1)
...
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
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
def delete_route(
self,
*,
meshName: str,
routeName: str,
virtualRouterName: str,
meshOwner: str = ...,
) -> DeleteRouteOutputTypeDef: # (1)
...
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
def delete_virtual_gateway(
self,
*,
meshName: str,
virtualGatewayName: str,
meshOwner: str = ...,
) -> DeleteVirtualGatewayOutputTypeDef: # (1)
...
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
def delete_virtual_node(
self,
*,
meshName: str,
virtualNodeName: str,
meshOwner: str = ...,
) -> DeleteVirtualNodeOutputTypeDef: # (1)
...
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
def delete_virtual_router(
self,
*,
meshName: str,
virtualRouterName: str,
meshOwner: str = ...,
) -> DeleteVirtualRouterOutputTypeDef: # (1)
...
kwargs: DeleteVirtualRouterInputRequestTypeDef = { # (1)
"meshName": ...,
"virtualRouterName": ...,
}
parent.delete_virtual_router(**kwargs)
delete_virtual_service
Deletes an existing virtual service.
Type annotations and code completion for boto3.client("appmesh").delete_virtual_service
method.
boto3 documentation
def delete_virtual_service(
self,
*,
meshName: str,
virtualServiceName: str,
meshOwner: str = ...,
) -> DeleteVirtualServiceOutputTypeDef: # (1)
...
kwargs: DeleteVirtualServiceInputRequestTypeDef = { # (1)
"meshName": ...,
"virtualServiceName": ...,
}
parent.delete_virtual_service(**kwargs)
describe_gateway_route
Describes an existing gateway route.
Type annotations and code completion for boto3.client("appmesh").describe_gateway_route
method.
boto3 documentation
def describe_gateway_route(
self,
*,
gatewayRouteName: str,
meshName: str,
virtualGatewayName: str,
meshOwner: str = ...,
) -> DescribeGatewayRouteOutputTypeDef: # (1)
...
kwargs: DescribeGatewayRouteInputRequestTypeDef = { # (1)
"gatewayRouteName": ...,
"meshName": ...,
"virtualGatewayName": ...,
}
parent.describe_gateway_route(**kwargs)
describe_mesh
Describes an existing service mesh.
Type annotations and code completion for boto3.client("appmesh").describe_mesh
method.
boto3 documentation
def describe_mesh(
self,
*,
meshName: str,
meshOwner: str = ...,
) -> DescribeMeshOutputTypeDef: # (1)
...
kwargs: DescribeMeshInputRequestTypeDef = { # (1)
"meshName": ...,
}
parent.describe_mesh(**kwargs)
describe_route
Describes an existing route.
Type annotations and code completion for boto3.client("appmesh").describe_route
method.
boto3 documentation
def describe_route(
self,
*,
meshName: str,
routeName: str,
virtualRouterName: str,
meshOwner: str = ...,
) -> DescribeRouteOutputTypeDef: # (1)
...
kwargs: DescribeRouteInputRequestTypeDef = { # (1)
"meshName": ...,
"routeName": ...,
"virtualRouterName": ...,
}
parent.describe_route(**kwargs)
describe_virtual_gateway
Describes an existing virtual gateway.
Type annotations and code completion for boto3.client("appmesh").describe_virtual_gateway
method.
boto3 documentation
def describe_virtual_gateway(
self,
*,
meshName: str,
virtualGatewayName: str,
meshOwner: str = ...,
) -> DescribeVirtualGatewayOutputTypeDef: # (1)
...
kwargs: DescribeVirtualGatewayInputRequestTypeDef = { # (1)
"meshName": ...,
"virtualGatewayName": ...,
}
parent.describe_virtual_gateway(**kwargs)
describe_virtual_node
Describes an existing virtual node.
Type annotations and code completion for boto3.client("appmesh").describe_virtual_node
method.
boto3 documentation
def describe_virtual_node(
self,
*,
meshName: str,
virtualNodeName: str,
meshOwner: str = ...,
) -> DescribeVirtualNodeOutputTypeDef: # (1)
...
kwargs: DescribeVirtualNodeInputRequestTypeDef = { # (1)
"meshName": ...,
"virtualNodeName": ...,
}
parent.describe_virtual_node(**kwargs)
describe_virtual_router
Describes an existing virtual router.
Type annotations and code completion for boto3.client("appmesh").describe_virtual_router
method.
boto3 documentation
def describe_virtual_router(
self,
*,
meshName: str,
virtualRouterName: str,
meshOwner: str = ...,
) -> DescribeVirtualRouterOutputTypeDef: # (1)
...
kwargs: DescribeVirtualRouterInputRequestTypeDef = { # (1)
"meshName": ...,
"virtualRouterName": ...,
}
parent.describe_virtual_router(**kwargs)
describe_virtual_service
Describes an existing virtual service.
Type annotations and code completion for boto3.client("appmesh").describe_virtual_service
method.
boto3 documentation
def describe_virtual_service(
self,
*,
meshName: str,
virtualServiceName: str,
meshOwner: str = ...,
) -> DescribeVirtualServiceOutputTypeDef: # (1)
...
kwargs: DescribeVirtualServiceInputRequestTypeDef = { # (1)
"meshName": ...,
"virtualServiceName": ...,
}
parent.describe_virtual_service(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("appmesh").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
list_gateway_routes
Returns a list of existing gateway routes that are associated to a virtual gateway.
Type annotations and code completion for boto3.client("appmesh").list_gateway_routes
method.
boto3 documentation
def list_gateway_routes(
self,
*,
meshName: str,
virtualGatewayName: str,
limit: int = ...,
meshOwner: str = ...,
nextToken: str = ...,
) -> ListGatewayRoutesOutputTypeDef: # (1)
...
kwargs: ListGatewayRoutesInputRequestTypeDef = { # (1)
"meshName": ...,
"virtualGatewayName": ...,
}
parent.list_gateway_routes(**kwargs)
list_meshes
Returns a list of existing service meshes.
Type annotations and code completion for boto3.client("appmesh").list_meshes
method.
boto3 documentation
def list_meshes(
self,
*,
limit: int = ...,
nextToken: str = ...,
) -> ListMeshesOutputTypeDef: # (1)
...
kwargs: ListMeshesInputRequestTypeDef = { # (1)
"limit": ...,
}
parent.list_meshes(**kwargs)
list_routes
Returns a list of existing routes in a service mesh.
Type annotations and code completion for boto3.client("appmesh").list_routes
method.
boto3 documentation
def list_routes(
self,
*,
meshName: str,
virtualRouterName: str,
limit: int = ...,
meshOwner: str = ...,
nextToken: str = ...,
) -> ListRoutesOutputTypeDef: # (1)
...
kwargs: ListRoutesInputRequestTypeDef = { # (1)
"meshName": ...,
"virtualRouterName": ...,
}
parent.list_routes(**kwargs)
list_tags_for_resource
List the tags for an App Mesh resource.
Type annotations and code completion for boto3.client("appmesh").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
resourceArn: str,
limit: int = ...,
nextToken: str = ...,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_virtual_gateways
Returns a list of existing virtual gateways in a service mesh.
Type annotations and code completion for boto3.client("appmesh").list_virtual_gateways
method.
boto3 documentation
def list_virtual_gateways(
self,
*,
meshName: str,
limit: int = ...,
meshOwner: str = ...,
nextToken: str = ...,
) -> ListVirtualGatewaysOutputTypeDef: # (1)
...
kwargs: ListVirtualGatewaysInputRequestTypeDef = { # (1)
"meshName": ...,
}
parent.list_virtual_gateways(**kwargs)
list_virtual_nodes
Returns a list of existing virtual nodes.
Type annotations and code completion for boto3.client("appmesh").list_virtual_nodes
method.
boto3 documentation
def list_virtual_nodes(
self,
*,
meshName: str,
limit: int = ...,
meshOwner: str = ...,
nextToken: str = ...,
) -> ListVirtualNodesOutputTypeDef: # (1)
...
kwargs: ListVirtualNodesInputRequestTypeDef = { # (1)
"meshName": ...,
}
parent.list_virtual_nodes(**kwargs)
list_virtual_routers
Returns a list of existing virtual routers in a service mesh.
Type annotations and code completion for boto3.client("appmesh").list_virtual_routers
method.
boto3 documentation
def list_virtual_routers(
self,
*,
meshName: str,
limit: int = ...,
meshOwner: str = ...,
nextToken: str = ...,
) -> ListVirtualRoutersOutputTypeDef: # (1)
...
kwargs: ListVirtualRoutersInputRequestTypeDef = { # (1)
"meshName": ...,
}
parent.list_virtual_routers(**kwargs)
list_virtual_services
Returns a list of existing virtual services in a service mesh.
Type annotations and code completion for boto3.client("appmesh").list_virtual_services
method.
boto3 documentation
def list_virtual_services(
self,
*,
meshName: str,
limit: int = ...,
meshOwner: str = ...,
nextToken: str = ...,
) -> ListVirtualServicesOutputTypeDef: # (1)
...
kwargs: ListVirtualServicesInputRequestTypeDef = { # (1)
"meshName": ...,
}
parent.list_virtual_services(**kwargs)
tag_resource
Associates the specified tags to a resource with the specified resourceArn
.
Type annotations and code completion for boto3.client("appmesh").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
resourceArn: str,
tags: Sequence[TagRefTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagRefTypeDef
kwargs: TagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Deletes specified tags from a resource.
Type annotations and code completion for boto3.client("appmesh").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_gateway_route
Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.
Type annotations and code completion for boto3.client("appmesh").update_gateway_route
method.
boto3 documentation
def update_gateway_route(
self,
*,
gatewayRouteName: str,
meshName: str,
spec: GatewayRouteSpecTypeDef, # (1)
virtualGatewayName: str,
clientToken: str = ...,
meshOwner: str = ...,
) -> UpdateGatewayRouteOutputTypeDef: # (2)
...
kwargs: UpdateGatewayRouteInputRequestTypeDef = { # (1)
"gatewayRouteName": ...,
"meshName": ...,
"spec": ...,
"virtualGatewayName": ...,
}
parent.update_gateway_route(**kwargs)
update_mesh
Updates an existing service mesh.
Type annotations and code completion for boto3.client("appmesh").update_mesh
method.
boto3 documentation
def update_mesh(
self,
*,
meshName: str,
clientToken: str = ...,
spec: MeshSpecTypeDef = ..., # (1)
) -> UpdateMeshOutputTypeDef: # (2)
...
kwargs: UpdateMeshInputRequestTypeDef = { # (1)
"meshName": ...,
}
parent.update_mesh(**kwargs)
update_route
Updates an existing route for a specified service mesh and virtual router.
Type annotations and code completion for boto3.client("appmesh").update_route
method.
boto3 documentation
def update_route(
self,
*,
meshName: str,
routeName: str,
spec: RouteSpecTypeDef, # (1)
virtualRouterName: str,
clientToken: str = ...,
meshOwner: str = ...,
) -> UpdateRouteOutputTypeDef: # (2)
...
kwargs: UpdateRouteInputRequestTypeDef = { # (1)
"meshName": ...,
"routeName": ...,
"spec": ...,
"virtualRouterName": ...,
}
parent.update_route(**kwargs)
update_virtual_gateway
Updates an existing virtual gateway in a specified service mesh.
Type annotations and code completion for boto3.client("appmesh").update_virtual_gateway
method.
boto3 documentation
def update_virtual_gateway(
self,
*,
meshName: str,
spec: VirtualGatewaySpecTypeDef, # (1)
virtualGatewayName: str,
clientToken: str = ...,
meshOwner: str = ...,
) -> UpdateVirtualGatewayOutputTypeDef: # (2)
...
kwargs: UpdateVirtualGatewayInputRequestTypeDef = { # (1)
"meshName": ...,
"spec": ...,
"virtualGatewayName": ...,
}
parent.update_virtual_gateway(**kwargs)
update_virtual_node
Updates an existing virtual node in a specified service mesh.
Type annotations and code completion for boto3.client("appmesh").update_virtual_node
method.
boto3 documentation
def update_virtual_node(
self,
*,
meshName: str,
spec: VirtualNodeSpecTypeDef, # (1)
virtualNodeName: str,
clientToken: str = ...,
meshOwner: str = ...,
) -> UpdateVirtualNodeOutputTypeDef: # (2)
...
kwargs: UpdateVirtualNodeInputRequestTypeDef = { # (1)
"meshName": ...,
"spec": ...,
"virtualNodeName": ...,
}
parent.update_virtual_node(**kwargs)
update_virtual_router
Updates an existing virtual router in a specified service mesh.
Type annotations and code completion for boto3.client("appmesh").update_virtual_router
method.
boto3 documentation
def update_virtual_router(
self,
*,
meshName: str,
spec: VirtualRouterSpecTypeDef, # (1)
virtualRouterName: str,
clientToken: str = ...,
meshOwner: str = ...,
) -> UpdateVirtualRouterOutputTypeDef: # (2)
...
kwargs: UpdateVirtualRouterInputRequestTypeDef = { # (1)
"meshName": ...,
"spec": ...,
"virtualRouterName": ...,
}
parent.update_virtual_router(**kwargs)
update_virtual_service
Updates an existing virtual service in a specified service mesh.
Type annotations and code completion for boto3.client("appmesh").update_virtual_service
method.
boto3 documentation
def update_virtual_service(
self,
*,
meshName: str,
spec: VirtualServiceSpecTypeDef, # (1)
virtualServiceName: str,
clientToken: str = ...,
meshOwner: str = ...,
) -> UpdateVirtualServiceOutputTypeDef: # (2)
...
kwargs: UpdateVirtualServiceInputRequestTypeDef = { # (1)
"meshName": ...,
"spec": ...,
"virtualServiceName": ...,
}
parent.update_virtual_service(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("appmesh").get_paginator
method with overloads.
client.get_paginator("list_gateway_routes")
-> ListGatewayRoutesPaginatorclient.get_paginator("list_meshes")
-> ListMeshesPaginatorclient.get_paginator("list_routes")
-> ListRoutesPaginatorclient.get_paginator("list_tags_for_resource")
-> ListTagsForResourcePaginatorclient.get_paginator("list_virtual_gateways")
-> ListVirtualGatewaysPaginatorclient.get_paginator("list_virtual_nodes")
-> ListVirtualNodesPaginatorclient.get_paginator("list_virtual_routers")
-> ListVirtualRoutersPaginatorclient.get_paginator("list_virtual_services")
-> ListVirtualServicesPaginator