ApiGatewayV2 / Client / list_routing_rules

list_routing_rules

ApiGatewayV2.Client.list_routing_rules(**kwargs)

Lists routing rules.

See also: AWS API Documentation

Request Syntax

response = client.list_routing_rules(
    DomainName='string',
    DomainNameId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The domain name.

  • DomainNameId (string) – The domain name ID.

  • MaxResults (integer) – The maximum number of elements to be returned for this resource.

  • NextToken (string) – The next page of elements from this collection. Not valid for the last element of the collection.

Return type:

dict

Returns:

Response Syntax

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

    • NextToken (string) –

      The next page of elements from this collection. Not valid for the last element of the collection.

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

Exceptions