AppMesh / Client / list_meshes

list_meshes#

AppMesh.Client.list_meshes(**kwargs)#

Returns a list of existing service meshes.

See also: AWS API Documentation

Request Syntax

response = client.list_meshes(
    limit=123,
    nextToken='string'
)
Parameters:
  • limit (integer) – The maximum number of results returned by ListMeshes in paginated output. When you use this parameter, ListMeshes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListMeshes request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListMeshes returns up to 100 results and a nextToken value if applicable.

  • nextToken (string) –

    The nextToken value returned from a previous paginated ListMeshes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken 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.

Return type:

dict

Returns:

Response Syntax

{
    'meshes': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'meshName': 'string',
            'meshOwner': 'string',
            'resourceOwner': 'string',
            'version': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • meshes (list) –

      The list of existing service meshes.

      • (dict) –

        An object that represents a service mesh returned by a list operation.

        • arn (string) –

          The full Amazon Resource Name (ARN) of the service mesh.

        • createdAt (datetime) –

          The Unix epoch timestamp in seconds for when the resource was created.

        • lastUpdatedAt (datetime) –

          The Unix epoch timestamp in seconds for when the resource was last updated.

        • meshName (string) –

          The name of the service mesh.

        • meshOwner (string) –

          The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it’s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

        • resourceOwner (string) –

          The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it’s the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.

        • version (integer) –

          The version of the resource. Resources are created at version 1, and this version is incremented each time that they’re updated.

    • nextToken (string) –

      The nextToken value to include in a future ListMeshes request. When the results of a ListMeshes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

  • AppMesh.Client.exceptions.NotFoundException

  • AppMesh.Client.exceptions.BadRequestException

  • AppMesh.Client.exceptions.TooManyRequestsException

  • AppMesh.Client.exceptions.ForbiddenException

  • AppMesh.Client.exceptions.ServiceUnavailableException

  • AppMesh.Client.exceptions.InternalServerErrorException