VPCLattice / Client / get_rule

get_rule#

VPCLattice.Client.get_rule(**kwargs)#

Retrieves information about the specified listener rules. You can also retrieve information about the default listener rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.

See also: AWS API Documentation

Request Syntax

response = client.get_rule(
    listenerIdentifier='string',
    ruleIdentifier='string',
    serviceIdentifier='string'
)
Parameters:

  • listenerIdentifier (string) –

    [REQUIRED]

    The ID or ARN of the listener.

  • ruleIdentifier (string) –

    [REQUIRED]

    The ID or ARN of the listener rule.

  • serviceIdentifier (string) –

    [REQUIRED]

    The ID or ARN of the service.

Return type:

dict

Returns:

Response Syntax

{
    'action': {
        'fixedResponse': {
            'statusCode': 123
        },
        'forward': {
            'targetGroups': [
                {
                    'targetGroupIdentifier': 'string',
                    'weight': 123
                },
            ]
        }
    },
    'arn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'id': 'string',
    'isDefault': True|False,
    'lastUpdatedAt': datetime(2015, 1, 1),
    'match': {
        'httpMatch': {
            'headerMatches': [
                {
                    'caseSensitive': True|False,
                    'match': {
                        'contains': 'string',
                        'exact': 'string',
                        'prefix': 'string'
                    },
                    'name': 'string'
                },
            ],
            'method': 'string',
            'pathMatch': {
                'caseSensitive': True|False,
                'match': {
                    'exact': 'string',
                    'prefix': 'string'
                }
            }
        }
    },
    'name': 'string',
    'priority': 123
}

Response Structure

  • (dict) –

    • action (dict) –

      The action for the default rule.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: fixedResponse, forward. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • fixedResponse (dict) –

        The fixed response action. The rule returns a custom HTTP response.

        • statusCode (integer) –

          The HTTP response code.

      • forward (dict) –

        The forward action. Traffic that matches the rule is forwarded to the specified target groups.

        • targetGroups (list) –

          The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

          The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group.

          • (dict) –

            Describes the weight of a target group.

            • targetGroupIdentifier (string) –

              The ID or ARN of the target group.

            • weight (integer) –

              Only required if you specify multiple target groups for a forward action. The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there’s only one target group specified, then the default value is 100.

    • arn (string) –

      The Amazon Resource Name (ARN) of the listener.

    • createdAt (datetime) –

      The date and time that the listener rule was created, in ISO-8601 format.

    • id (string) –

      The ID of the listener.

    • isDefault (boolean) –

      Indicates whether this is the default rule.

    • lastUpdatedAt (datetime) –

      The date and time that the listener rule was last updated, in ISO-8601 format.

    • match (dict) –

      The rule match.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: httpMatch. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • httpMatch (dict) –

        The HTTP criteria that a rule must match.

        • headerMatches (list) –

          The header matches. Matches incoming requests with rule based on request header value before applying rule action.

          • (dict) –

            Describes the constraints for a header match. Matches incoming requests with rule based on request header value before applying rule action.

            • caseSensitive (boolean) –

              Indicates whether the match is case sensitive.

            • match (dict) –

              The header match type.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: contains, exact, prefix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

              • contains (string) –

                A contains type match.

              • exact (string) –

                An exact type match.

              • prefix (string) –

                A prefix type match. Matches the value with the prefix.

            • name (string) –

              The name of the header.

        • method (string) –

          The HTTP method type.

        • pathMatch (dict) –

          The path match.

          • caseSensitive (boolean) –

            Indicates whether the match is case sensitive.

          • match (dict) –

            The type of path match.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: exact, prefix. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

            • exact (string) –

              An exact match of the path.

            • prefix (string) –

              A prefix match of the path.

    • name (string) –

      The name of the listener.

    • priority (integer) –

      The priority level for the specified rule.

Exceptions