AppMesh / Client / list_routes

list_routes#

AppMesh.Client.list_routes(**kwargs)#

Returns a list of existing routes in a service mesh.

See also: AWS API Documentation

Request Syntax

response = client.list_routes(
    limit=123,
    meshName='string',
    meshOwner='string',
    nextToken='string',
    virtualRouterName='string'
)
Parameters:

  • limit (integer) – The maximum number of results returned by ListRoutes in paginated output. When you use this parameter, ListRoutes 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 ListRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListRoutes returns up to 100 results and a nextToken value if applicable.

  • meshName (string) –

    [REQUIRED]

    The name of the service mesh to list routes in.

  • 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.

  • nextToken (string) – The nextToken value returned from a previous paginated ListRoutes 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.

  • virtualRouterName (string) –

    [REQUIRED]

    The name of the virtual router to list routes in.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • nextToken (string) –

      The nextToken value to include in a future ListRoutes request. When the results of a ListRoutes 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.

    • routes (list) –

      The list of existing routes for the specified service mesh and virtual router.

      • (dict) –

        An object that represents a route returned by a list operation.

        • arn (string) –

          The full Amazon Resource Name (ARN) for the route.

        • 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 that the route resides in.

        • 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.

        • routeName (string) –

          The name of the route.

        • version (integer) –

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

        • virtualRouterName (string) –

          The virtual router that the route is associated with.

Exceptions