CreateMesh

$result = $client->createMesh([/* ... */]);
$promise = $client->createMeshAsync([/* ... */]);

Creates a new service mesh. A service mesh is a logical boundary for network traffic between the services that reside within it.

After you create your service mesh, you can create virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh.

Parameter Syntax

$result = $client->createMesh([
    'clientToken' => '<string>',
    'meshName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'mesh' => [
        'meshName' => '<string>',
        'metadata' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'uid' => '<string>',
            'version' => <integer>,
        ],
        'status' => [
            'status' => 'ACTIVE|DELETED|INACTIVE',
        ],
    ],
]

Result Details

Errors

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 do not 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 AWS App Mesh User Guide.

NotFoundException:

The specified resource does not 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.

CreateRoute

$result = $client->createRoute([/* ... */]);
$promise = $client->createRouteAsync([/* ... */]);

Creates a new route that is associated with a virtual router.

You can use the prefix parameter in your route specification for path-based routing of requests. For example, if your virtual router service name is my-service.local, and you want the route to match requests to my-service.local/metrics, then your prefix should be /metrics.

If your route matches a request, you can distribute traffic to one or more target virtual nodes with relative weighting.

Parameter Syntax

$result = $client->createRoute([
    'clientToken' => '<string>',
    'meshName' => '<string>', // REQUIRED
    'routeName' => '<string>', // REQUIRED
    'spec' => [ // REQUIRED
        'httpRoute' => [
            'action' => [
                'weightedTargets' => [
                    [
                        'virtualNode' => '<string>',
                        'weight' => <integer>,
                    ],
                    // ...
                ],
            ],
            'match' => [
                'prefix' => '<string>',
            ],
        ],
    ],
    'virtualRouterName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'route' => [
        'meshName' => '<string>',
        'metadata' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'uid' => '<string>',
            'version' => <integer>,
        ],
        'routeName' => '<string>',
        'spec' => [
            'httpRoute' => [
                'action' => [
                    'weightedTargets' => [
                        [
                            'virtualNode' => '<string>',
                            'weight' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'match' => [
                    'prefix' => '<string>',
                ],
            ],
        ],
        'status' => [
            'status' => 'ACTIVE|DELETED|INACTIVE',
        ],
        'virtualRouterName' => '<string>',
    ],
]

Result Details

Errors

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 do not 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 AWS App Mesh User Guide.

NotFoundException:

The specified resource does not 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.

CreateVirtualNode

$result = $client->createVirtualNode([/* ... */]);
$promise = $client->createVirtualNodeAsync([/* ... */]);

Creates a new virtual node within a service mesh.

A virtual node acts as logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you must specify the DNS service discovery name for your task group.

Any inbound traffic that your virtual node expects should be specified as a listener. Any outbound traffic that your virtual node expects to reach should be specified as a backend.

The response metadata for your new virtual node contains the arn that is associated with the virtual node. Set this value (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME environment variable for your task group's Envoy proxy container in your task definition or pod spec. This is then mapped to the node.id and node.cluster Envoy parameters.

Parameter Syntax

$result = $client->createVirtualNode([
    'clientToken' => '<string>',
    'meshName' => '<string>', // REQUIRED
    'spec' => [ // REQUIRED
        'backends' => ['<string>', ...],
        'listeners' => [
            [
                'healthCheck' => [
                    'healthyThreshold' => <integer>, // REQUIRED
                    'intervalMillis' => <integer>, // REQUIRED
                    'path' => '<string>',
                    'port' => <integer>,
                    'protocol' => 'http|tcp', // REQUIRED
                    'timeoutMillis' => <integer>, // REQUIRED
                    'unhealthyThreshold' => <integer>, // REQUIRED
                ],
                'portMapping' => [
                    'port' => <integer>,
                    'protocol' => 'http|tcp',
                ],
            ],
            // ...
        ],
        'serviceDiscovery' => [
            'dns' => [
                'serviceName' => '<string>',
            ],
        ],
    ],
    'virtualNodeName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'virtualNode' => [
        'meshName' => '<string>',
        'metadata' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'uid' => '<string>',
            'version' => <integer>,
        ],
        'spec' => [
            'backends' => ['<string>', ...],
            'listeners' => [
                [
                    'healthCheck' => [
                        'healthyThreshold' => <integer>,
                        'intervalMillis' => <integer>,
                        'path' => '<string>',
                        'port' => <integer>,
                        'protocol' => 'http|tcp',
                        'timeoutMillis' => <integer>,
                        'unhealthyThreshold' => <integer>,
                    ],
                    'portMapping' => [
                        'port' => <integer>,
                        'protocol' => 'http|tcp',
                    ],
                ],
                // ...
            ],
            'serviceDiscovery' => [
                'dns' => [
                    'serviceName' => '<string>',
                ],
            ],
        ],
        'status' => [
            'status' => 'ACTIVE|DELETED|INACTIVE',
        ],
        'virtualNodeName' => '<string>',
    ],
]

Result Details

Errors

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 do not 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 AWS App Mesh User Guide.

NotFoundException:

The specified resource does not 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.

CreateVirtualRouter

$result = $client->createVirtualRouter([/* ... */]);
$promise = $client->createVirtualRouterAsync([/* ... */]);

Creates a new virtual router within a service mesh.

Virtual routers handle traffic for one or more service names within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes.

Parameter Syntax

$result = $client->createVirtualRouter([
    'clientToken' => '<string>',
    'meshName' => '<string>', // REQUIRED
    'spec' => [ // REQUIRED
        'serviceNames' => ['<string>', ...],
    ],
    'virtualRouterName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'virtualRouter' => [
        'meshName' => '<string>',
        'metadata' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'uid' => '<string>',
            'version' => <integer>,
        ],
        'spec' => [
            'serviceNames' => ['<string>', ...],
        ],
        'status' => [
            'status' => 'ACTIVE|DELETED|INACTIVE',
        ],
        'virtualRouterName' => '<string>',
    ],
]

Result Details

Errors

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 do not 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 AWS App Mesh User Guide.

NotFoundException:

The specified resource does not 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.

DeleteMesh

$result = $client->deleteMesh([/* ... */]);
$promise = $client->deleteMeshAsync([/* ... */]);

Deletes an existing service mesh.

You must delete all resources (routes, virtual routers, virtual nodes) in the service mesh before you can delete the mesh itself.

Parameter Syntax

$result = $client->deleteMesh([
    'meshName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'mesh' => [
        'meshName' => '<string>',
        'metadata' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'uid' => '<string>',
            'version' => <integer>,
        ],
        'status' => [
            'status' => 'ACTIVE|DELETED|INACTIVE',
        ],
    ],
]

Result Details

Errors

BadRequestException:

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

ForbiddenException:

You do not have permissions to perform this action.

InternalServerErrorException:

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

NotFoundException:

The specified resource does not exist. Check your request syntax and try again.

ResourceInUseException:

You cannot delete the specified resource because it is in use or required by another resource.

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.

DeleteRoute

$result = $client->deleteRoute([/* ... */]);
$promise = $client->deleteRouteAsync([/* ... */]);

Deletes an existing route.

Parameter Syntax

$result = $client->deleteRoute([
    'meshName' => '<string>', // REQUIRED
    'routeName' => '<string>', // REQUIRED
    'virtualRouterName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'route' => [
        'meshName' => '<string>',
        'metadata' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'uid' => '<string>',
            'version' => <integer>,
        ],
        'routeName' => '<string>',
        'spec' => [
            'httpRoute' => [
                'action' => [
                    'weightedTargets' => [
                        [
                            'virtualNode' => '<string>',
                            'weight' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'match' => [
                    'prefix' => '<string>',
                ],
            ],
        ],
        'status' => [
            'status' => 'ACTIVE|DELETED|INACTIVE',
        ],
        'virtualRouterName' => '<string>',
    ],
]

Result Details

Errors

BadRequestException:

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

ForbiddenException:

You do not have permissions to perform this action.

InternalServerErrorException:

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

NotFoundException:

The specified resource does not exist. Check your request syntax and try again.

ResourceInUseException:

You cannot delete the specified resource because it is in use or required by another resource.

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.

DeleteVirtualNode

$result = $client->deleteVirtualNode([/* ... */]);
$promise = $client->deleteVirtualNodeAsync([/* ... */]);

Deletes an existing virtual node.

Parameter Syntax

$result = $client->deleteVirtualNode([
    'meshName' => '<string>', // REQUIRED
    'virtualNodeName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'virtualNode' => [
        'meshName' => '<string>',
        'metadata' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'uid' => '<string>',
            'version' => <integer>,
        ],
        'spec' => [
            'backends' => ['<string>', ...],
            'listeners' => [
                [
                    'healthCheck' => [
                        'healthyThreshold' => <integer>,
                        'intervalMillis' => <integer>,
                        'path' => '<string>',
                        'port' => <integer>,
                        'protocol' => 'http|tcp',
                        'timeoutMillis' => <integer>,
                        'unhealthyThreshold' => <integer>,
                    ],
                    'portMapping' => [
                        'port' => <integer>,
                        'protocol' => 'http|tcp',
                    ],
                ],
                // ...
            ],
            'serviceDiscovery' => [
                'dns' => [
                    'serviceName' => '<string>',
                ],
            ],
        ],
        'status' => [
            'status' => 'ACTIVE|DELETED|INACTIVE',
        ],
        'virtualNodeName' => '<string>',
    ],
]

Result Details

Errors

BadRequestException:

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

ForbiddenException:

You do not have permissions to perform this action.

InternalServerErrorException:

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

NotFoundException:

The specified resource does not exist. Check your request syntax and try again.

ResourceInUseException:

You cannot delete the specified resource because it is in use or required by another resource.

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.

DeleteVirtualRouter

$result = $client->deleteVirtualRouter([/* ... */]);
$promise = $client->deleteVirtualRouterAsync([/* ... */]);

Deletes an existing virtual router.

You must delete any routes associated with the virtual router before you can delete the router itself.

Parameter Syntax

$result = $client->deleteVirtualRouter([
    'meshName' => '<string>', // REQUIRED
    'virtualRouterName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'virtualRouter' => [
        'meshName' => '<string>',
        'metadata' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'uid' => '<string>',
            'version' => <integer>,
        ],
        'spec' => [
            'serviceNames' => ['<string>', ...],
        ],
        'status' => [
            'status' => 'ACTIVE|DELETED|INACTIVE',
        ],
        'virtualRouterName' => '<string>',
    ],
]

Result Details

Errors

BadRequestException:

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

ForbiddenException:

You do not have permissions to perform this action.

InternalServerErrorException:

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

NotFoundException:

The specified resource does not exist. Check your request syntax and try again.

ResourceInUseException:

You cannot delete the specified resource because it is in use or required by another resource.

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.

DescribeMesh

$result = $client->describeMesh([/* ... */]);
$promise = $client->describeMeshAsync([/* ... */]);

Describes an existing service mesh.

Parameter Syntax

$result = $client->describeMesh([
    'meshName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'mesh' => [
        'meshName' => '<string>',
        'metadata' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'uid' => '<string>',
            'version' => <integer>,
        ],
        'status' => [
            'status' => 'ACTIVE|DELETED|INACTIVE',
        ],
    ],
]

Result Details

Errors

BadRequestException:

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

ForbiddenException:

You do not have permissions to perform this action.

InternalServerErrorException:

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

NotFoundException:

The specified resource does not 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.

DescribeRoute

$result = $client->describeRoute([/* ... */]);
$promise = $client->describeRouteAsync([/* ... */]);

Describes an existing route.

Parameter Syntax

$result = $client->describeRoute([
    'meshName' => '<string>', // REQUIRED
    'routeName' => '<string>', // REQUIRED
    'virtualRouterName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'route' => [
        'meshName' => '<string>',
        'metadata' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'uid' => '<string>',
            'version' => <integer>,
        ],
        'routeName' => '<string>',
        'spec' => [
            'httpRoute' => [
                'action' => [
                    'weightedTargets' => [
                        [
                            'virtualNode' => '<string>',
                            'weight' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'match' => [
                    'prefix' => '<string>',
                ],
            ],
        ],
        'status' => [
            'status' => 'ACTIVE|DELETED|INACTIVE',
        ],
        'virtualRouterName' => '<string>',
    ],
]

Result Details

Errors

BadRequestException:

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

ForbiddenException:

You do not have permissions to perform this action.

InternalServerErrorException:

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

NotFoundException:

The specified resource does not 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.

DescribeVirtualNode

$result = $client->describeVirtualNode([/* ... */]);
$promise = $client->describeVirtualNodeAsync([/* ... */]);

Describes an existing virtual node.

Parameter Syntax

$result = $client->describeVirtualNode([
    'meshName' => '<string>', // REQUIRED
    'virtualNodeName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'virtualNode' => [
        'meshName' => '<string>',
        'metadata' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'uid' => '<string>',
            'version' => <integer>,
        ],
        'spec' => [
            'backends' => ['<string>', ...],
            'listeners' => [
                [
                    'healthCheck' => [
                        'healthyThreshold' => <integer>,
                        'intervalMillis' => <integer>,
                        'path' => '<string>',
                        'port' => <integer>,
                        'protocol' => 'http|tcp',
                        'timeoutMillis' => <integer>,
                        'unhealthyThreshold' => <integer>,
                    ],
                    'portMapping' => [
                        'port' => <integer>,
                        'protocol' => 'http|tcp',
                    ],
                ],
                // ...
            ],
            'serviceDiscovery' => [
                'dns' => [
                    'serviceName' => '<string>',
                ],
            ],
        ],
        'status' => [
            'status' => 'ACTIVE|DELETED|INACTIVE',
        ],
        'virtualNodeName' => '<string>',
    ],
]

Result Details

Errors

BadRequestException:

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

ForbiddenException:

You do not have permissions to perform this action.

InternalServerErrorException:

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

NotFoundException:

The specified resource does not 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.

DescribeVirtualRouter

$result = $client->describeVirtualRouter([/* ... */]);
$promise = $client->describeVirtualRouterAsync([/* ... */]);

Describes an existing virtual router.

Parameter Syntax

$result = $client->describeVirtualRouter([
    'meshName' => '<string>', // REQUIRED
    'virtualRouterName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'virtualRouter' => [
        'meshName' => '<string>',
        'metadata' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'uid' => '<string>',
            'version' => <integer>,
        ],
        'spec' => [
            'serviceNames' => ['<string>', ...],
        ],
        'status' => [
            'status' => 'ACTIVE|DELETED|INACTIVE',
        ],
        'virtualRouterName' => '<string>',
    ],
]

Result Details

Errors

BadRequestException:

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

ForbiddenException:

You do not have permissions to perform this action.

InternalServerErrorException:

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

NotFoundException:

The specified resource does not 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.

ListMeshes

$result = $client->listMeshes([/* ... */]);
$promise = $client->listMeshesAsync([/* ... */]);

Returns a list of existing service meshes.

Parameter Syntax

$result = $client->listMeshes([
    'limit' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'meshes' => [
        [
            'arn' => '<string>',
            'meshName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

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

ForbiddenException:

You do not have permissions to perform this action.

InternalServerErrorException:

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

NotFoundException:

The specified resource does not 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.

ListRoutes

$result = $client->listRoutes([/* ... */]);
$promise = $client->listRoutesAsync([/* ... */]);

Returns a list of existing routes in a service mesh.

Parameter Syntax

$result = $client->listRoutes([
    'limit' => <integer>,
    'meshName' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'virtualRouterName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'routes' => [
        [
            'arn' => '<string>',
            'meshName' => '<string>',
            'routeName' => '<string>',
            'virtualRouterName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

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

ForbiddenException:

You do not have permissions to perform this action.

InternalServerErrorException:

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

NotFoundException:

The specified resource does not 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.

ListVirtualNodes

$result = $client->listVirtualNodes([/* ... */]);
$promise = $client->listVirtualNodesAsync([/* ... */]);

Returns a list of existing virtual nodes.

Parameter Syntax

$result = $client->listVirtualNodes([
    'limit' => <integer>,
    'meshName' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'virtualNodes' => [
        [
            'arn' => '<string>',
            'meshName' => '<string>',
            'virtualNodeName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

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

ForbiddenException:

You do not have permissions to perform this action.

InternalServerErrorException:

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

NotFoundException:

The specified resource does not 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.

ListVirtualRouters

$result = $client->listVirtualRouters([/* ... */]);
$promise = $client->listVirtualRoutersAsync([/* ... */]);

Returns a list of existing virtual routers in a service mesh.

Parameter Syntax

$result = $client->listVirtualRouters([
    'limit' => <integer>,
    'meshName' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'virtualRouters' => [
        [
            'arn' => '<string>',
            'meshName' => '<string>',
            'virtualRouterName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

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

ForbiddenException:

You do not have permissions to perform this action.

InternalServerErrorException:

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

NotFoundException:

The specified resource does not 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.

UpdateRoute

$result = $client->updateRoute([/* ... */]);
$promise = $client->updateRouteAsync([/* ... */]);

Updates an existing route for a specified service mesh and virtual router.

Parameter Syntax

$result = $client->updateRoute([
    'clientToken' => '<string>',
    'meshName' => '<string>', // REQUIRED
    'routeName' => '<string>', // REQUIRED
    'spec' => [ // REQUIRED
        'httpRoute' => [
            'action' => [
                'weightedTargets' => [
                    [
                        'virtualNode' => '<string>',
                        'weight' => <integer>,
                    ],
                    // ...
                ],
            ],
            'match' => [
                'prefix' => '<string>',
            ],
        ],
    ],
    'virtualRouterName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'route' => [
        'meshName' => '<string>',
        'metadata' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'uid' => '<string>',
            'version' => <integer>,
        ],
        'routeName' => '<string>',
        'spec' => [
            'httpRoute' => [
                'action' => [
                    'weightedTargets' => [
                        [
                            'virtualNode' => '<string>',
                            'weight' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'match' => [
                    'prefix' => '<string>',
                ],
            ],
        ],
        'status' => [
            'status' => 'ACTIVE|DELETED|INACTIVE',
        ],
        'virtualRouterName' => '<string>',
    ],
]

Result Details

Errors

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 do not 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 AWS App Mesh User Guide.

NotFoundException:

The specified resource does not 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.

UpdateVirtualNode

$result = $client->updateVirtualNode([/* ... */]);
$promise = $client->updateVirtualNodeAsync([/* ... */]);

Updates an existing virtual node in a specified service mesh.

Parameter Syntax

$result = $client->updateVirtualNode([
    'clientToken' => '<string>',
    'meshName' => '<string>', // REQUIRED
    'spec' => [ // REQUIRED
        'backends' => ['<string>', ...],
        'listeners' => [
            [
                'healthCheck' => [
                    'healthyThreshold' => <integer>, // REQUIRED
                    'intervalMillis' => <integer>, // REQUIRED
                    'path' => '<string>',
                    'port' => <integer>,
                    'protocol' => 'http|tcp', // REQUIRED
                    'timeoutMillis' => <integer>, // REQUIRED
                    'unhealthyThreshold' => <integer>, // REQUIRED
                ],
                'portMapping' => [
                    'port' => <integer>,
                    'protocol' => 'http|tcp',
                ],
            ],
            // ...
        ],
        'serviceDiscovery' => [
            'dns' => [
                'serviceName' => '<string>',
            ],
        ],
    ],
    'virtualNodeName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'virtualNode' => [
        'meshName' => '<string>',
        'metadata' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'uid' => '<string>',
            'version' => <integer>,
        ],
        'spec' => [
            'backends' => ['<string>', ...],
            'listeners' => [
                [
                    'healthCheck' => [
                        'healthyThreshold' => <integer>,
                        'intervalMillis' => <integer>,
                        'path' => '<string>',
                        'port' => <integer>,
                        'protocol' => 'http|tcp',
                        'timeoutMillis' => <integer>,
                        'unhealthyThreshold' => <integer>,
                    ],
                    'portMapping' => [
                        'port' => <integer>,
                        'protocol' => 'http|tcp',
                    ],
                ],
                // ...
            ],
            'serviceDiscovery' => [
                'dns' => [
                    'serviceName' => '<string>',
                ],
            ],
        ],
        'status' => [
            'status' => 'ACTIVE|DELETED|INACTIVE',
        ],
        'virtualNodeName' => '<string>',
    ],
]

Result Details

Errors

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 do not 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 AWS App Mesh User Guide.

NotFoundException:

The specified resource does not 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.

UpdateVirtualRouter

$result = $client->updateVirtualRouter([/* ... */]);
$promise = $client->updateVirtualRouterAsync([/* ... */]);

Updates an existing virtual router in a specified service mesh.

Parameter Syntax

$result = $client->updateVirtualRouter([
    'clientToken' => '<string>',
    'meshName' => '<string>', // REQUIRED
    'spec' => [ // REQUIRED
        'serviceNames' => ['<string>', ...],
    ],
    'virtualRouterName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'virtualRouter' => [
        'meshName' => '<string>',
        'metadata' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'uid' => '<string>',
            'version' => <integer>,
        ],
        'spec' => [
            'serviceNames' => ['<string>', ...],
        ],
        'status' => [
            'status' => 'ACTIVE|DELETED|INACTIVE',
        ],
        'virtualRouterName' => '<string>',
    ],
]

Result Details

Errors

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 do not 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 AWS App Mesh User Guide.

NotFoundException:

The specified resource does not 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.