ListMeshes
Returns a list of existing service meshes.
Request Syntax
GET /v20190125/meshes?limit=limit
&nextToken=nextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- limit
-
The maximum number of results returned by
ListMeshes
in paginated output. When you use this parameter,ListMeshes
returns onlylimit
results in a single page along with anextToken
response element. You can see the remaining results of the initial request by sending anotherListMeshes
request with the returnednextToken
value. This value can be between 1 and 100. If you don't use this parameter,ListMeshes
returns up to 100 results and anextToken
value if applicable.Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
The
nextToken
value returned from a previous paginatedListMeshes
request wherelimit
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.Note
This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"meshes": [
{
"arn": "string",
"createdAt": number,
"lastUpdatedAt": number,
"meshName": "string",
"meshOwner": "string",
"resourceOwner": "string",
"version": number
}
],
"nextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- meshes
-
The list of existing service meshes.
Type: Array of MeshRef objects
- nextToken
-
The
nextToken
value to include in a futureListMeshes
request. When the results of aListMeshes
request exceedlimit
, you can use this value to retrieve the next page of results. This value isnull
when there are no more results to return.Type: String
Errors
- BadRequestException
-
The request syntax was malformed. Check your request syntax and try again.
HTTP Status Code: 400
- ForbiddenException
-
You don't have permissions to perform this action.
HTTP Status Code: 403
- InternalServerErrorException
-
The request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
- NotFoundException
-
The specified resource doesn't exist. Check your request syntax and try again.
HTTP Status Code: 404
- ServiceUnavailableException
-
The request has failed due to a temporary failure of the service.
HTTP Status Code: 503
- 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.
HTTP Status Code: 429
Examples
In the following example or examples, the Authorization header contents
(AUTHPARAMS
) must be replaced with an AWS Signature Version 4
signature. For more information about creating these signatures, see Signature
Version 4 Signing Process in the
AWS General
Reference.
You need to learn how to sign HTTP requests only if you intend to manually
create them. When you use the AWS Command Line Interface (AWS CLI)
Example
This example lists the service meshes for an account in the
us-east-1
Region.
Sample Request
GET /v20190125/meshes HTTP/1.1
Host: appmesh.us-east-1.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/1.16.56 Python/3.7.0 Darwin/17.7.0 botocore/1.12.46
X-Amz-Date: 20190227T235715Z
Authorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OK
x-amzn-requestid: 572dcc56-18d6-4f86-b596-8e182f81afce
content-type: application/json
content-length: 114
date: Wed, 27 Feb 2019 23:57:15 GMT
x-envoy-upstream-service-time: 67
server: envoy
Connection: keep-alive
{
"meshes": [
{
"arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/ecs-mesh",
"meshName": "ecs-mesh"
}
],
"nextToken": null
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: