ApiGatewayV2 / Client / get_routing_rule

get_routing_rule

ApiGatewayV2.Client.get_routing_rule(**kwargs)

Gets a routing rule.

See also: AWS API Documentation

Request Syntax

response = client.get_routing_rule(
    DomainName='string',
    DomainNameId='string',
    RoutingRuleId='string'
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The domain name.

  • DomainNameId (string) – The domain name ID.

  • RoutingRuleId (string) –

    [REQUIRED]

    The routing rule ID.

Return type:

dict

Returns:

Response Syntax

{
    '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

    • Actions (list) –

      The resulting action based on matching a routing rules condition. Only InvokeApi is supported.

      • (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 conditions of the routing rule.

      • (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 order in which API Gateway evaluates a rule. Priority is evaluated from the lowest value to the highest value.

    • RoutingRuleArn (string) –

      The routing rule ARN.

    • RoutingRuleId (string) –

      The routing rule ID.

Exceptions