ApiGatewayV2 / Paginator / ListRoutingRules

ListRoutingRules

class ApiGatewayV2.Paginator.ListRoutingRules

paginator = client.get_paginator('list_routing_rules')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ApiGatewayV2.Client.list_routing_rules().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DomainName='string',
    DomainNameId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• DomainName (string) –

  [REQUIRED]

  The domain name.

• DomainNameId (string) – The domain name ID.

• 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

{
    'RoutingRules': [
        {
            'Actions': [
                {
                    'InvokeApi': {
                        'ApiId': 'string',
                        'Stage': 'string',
                        'StripBasePath': True|False
                    }
                },
            ],
            'Conditions': [
                {
                    'MatchBasePaths': {
                        'AnyOf': [
                            'string',
                        ]
                    },
                    'MatchHeaders': {
                        'AnyOf': [
                            {
                                'Header': 'string',
                                'ValueGlob': 'string'
                            },
                        ]
                    }
                },
            ],
            'Priority': 123,
            'RoutingRuleArn': 'string',
            'RoutingRuleId': 'string'
        },
    ]
}

Response Structure

• (dict) –

  Success

  • RoutingRules (list) –

    The routing rules.

    • (dict) –

      Represents a routing rule.

      • Actions (list) –

        The routing rule action.

        • (dict) –

          The routing rule action.

          • InvokeApi (dict) –

            Represents an InvokeApi action.

            • ApiId (string) –

              The identifier.

            • Stage (string) –

              A string with a length between [1-128].

            • StripBasePath (boolean) –

              The strip base path setting.

      • Conditions (list) –

        The routing rule condition.

        • (dict) –

          Represents a routing rule condition.

          • MatchBasePaths (dict) –

            The base path to be matched.

            • AnyOf (list) – The string of the case sensitive base path to be matched.

              • (string) –

                After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression’s associated selection key type.

          • MatchHeaders (dict) –

            The headers to be matched.

            • AnyOf (list) –

              The header name and header value glob to be matched. The matchHeaders condition is matched if any of the header name and header value globs are matched.

              • (dict) –

                Represents a MatchHeaderValue.

                • Header (string) –

                  After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression’s associated selection key type.

                • ValueGlob (string) –

                  An expression used to extract information at runtime. See Selection Expressions for more information.

      • Priority (integer) –

        The routing rule priority.

      • RoutingRuleArn (string) –

        The routing rule ARN.

      • RoutingRuleId (string) –

        The routing rule ID.