AppMesh / Client / list_gateway_routes

list_gateway_routes#

AppMesh.Client.list_gateway_routes(**kwargs)#

Returns a list of existing gateway routes that are associated to a virtual gateway.

See also: AWS API Documentation

Request Syntax

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

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

  • meshName (string) –

    [REQUIRED]

    The name of the service mesh to list gateway 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 ListGatewayRoutes 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.

  • virtualGatewayName (string) –

    [REQUIRED]

    The name of the virtual gateway to list gateway routes in.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • gatewayRoutes (list) –

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

      • (dict) –

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

        • arn (string) –

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

        • createdAt (datetime) –

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

        • gatewayRouteName (string) –

          The name of the gateway route.

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

        • version (integer) –

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

        • virtualGatewayName (string) –

          The virtual gateway that the gateway route is associated with.

    • nextToken (string) –

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