AppMesh / Paginator / ListRoutes

ListRoutes#

class AppMesh.Paginator.ListRoutes#

paginator = client.get_paginator('list_routes')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from AppMesh.Client.list_routes().

Request Syntax

response_iterator = paginator.paginate(
    meshName='string',
    meshOwner='string',
    virtualRouterName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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.
virtualRouterName (string) –
[REQUIRED]

The name of the virtual router to list routes in.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- 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.
- NextToken (string) –
  
  A token to resume pagination.