EC2 / Paginator / DescribeClientVpnRoutes

DescribeClientVpnRoutes

class EC2.Paginator.DescribeClientVpnRoutes

paginator = client.get_paginator('describe_client_vpn_routes')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EC2.Client.describe_client_vpn_routes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ClientVpnEndpointId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ClientVpnEndpointId (string) –

  [REQUIRED]

  The ID of the Client VPN endpoint.

• Filters (list) –

  One or more filters. Filter names and values are case-sensitive.

  • destination-cidr - The CIDR of the route destination.

  • origin - How the route was associated with the Client VPN endpoint ( associate | add-route).

  • target-subnet - The ID of the subnet through which traffic is routed.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

• DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

• 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': [
        {
            'ClientVpnEndpointId': 'string',
            'DestinationCidr': 'string',
            'TargetSubnet': 'string',
            'Type': 'string',
            'Origin': 'string',
            'Status': {
                'Code': 'creating'|'active'|'failed'|'deleting',
                'Message': 'string'
            },
            'Description': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • Routes (list) –

    Information about the Client VPN endpoint routes.

    • (dict) –

      Information about a Client VPN endpoint route.

      • ClientVpnEndpointId (string) –

        The ID of the Client VPN endpoint with which the route is associated.

      • DestinationCidr (string) –

        The IPv4 address range, in CIDR notation, of the route destination.

      • TargetSubnet (string) –

        The ID of the subnet through which traffic is routed.

      • Type (string) –

        The route type.

      • Origin (string) –

        Indicates how the route was associated with the Client VPN endpoint. associate indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. add-route indicates that the route was manually added using the CreateClientVpnRoute action.

      • Status (dict) –

        The current state of the route.

        • Code (string) –

          The state of the Client VPN endpoint route.

        • Message (string) –

          A message about the status of the Client VPN endpoint route, if applicable.

      • Description (string) –

        A brief description of the route.