Elastic Load Balancing

{'Marker': 'string', 'PageSize': 'integer'}

{'NextMarker': 'string'}

Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.

See also: AWS API Documentation

Request Syntax

client.describe_rules(
    ListenerArn='string',
    RuleArns=[
        'string',
    ],
    Marker='string',
    PageSize=123
)

type ListenerArn:

string

param ListenerArn:

The Amazon Resource Name (ARN) of the listener.

type RuleArns:

list

param RuleArns:

The Amazon Resource Names (ARN) of the rules.

• (string) --

type Marker:

string

param Marker:

The marker for the next set of results. (You received this marker from a previous call.)

type PageSize:

integer

param PageSize:

The maximum number of results to return with this call.

rtype:

dict

returns:

Response Syntax

{
    'Rules': [
        {
            'RuleArn': 'string',
            'Priority': 'string',
            'Conditions': [
                {
                    'Field': 'string',
                    'Values': [
                        'string',
                    ]
                },
            ],
            'Actions': [
                {
                    'Type': 'forward',
                    'TargetGroupArn': 'string'
                },
            ],
            'IsDefault': True|False
        },
    ],
    'NextMarker': 'string'
}

Response Structure

• (dict) --

  • Rules (list) --

    Information about the rules.

    • (dict) --

      Information about a rule.

      • RuleArn (string) --

        The Amazon Resource Name (ARN) of the rule.

      • Priority (string) --

        The priority.

      • Conditions (list) --

        The conditions.

        • (dict) --

          Information about a condition for a rule.

          • Field (string) --

            The name of the field. The possible values are host-header and path-pattern.

          • Values (list) --

            The condition value.

            If the field name is host-header, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.

            • A-Z, a-z, 0-9

            • • .

            • • (matches 0 or more characters)

            • ? (matches exactly 1 character)

            If the field name is path-pattern, you can specify a single path pattern (for example, /img/*). A path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.

            • A-Z, a-z, 0-9

            • _ - . $ / ~ " ' @ : +

            • & (using &)

            • • (matches 0 or more characters)

            • ? (matches exactly 1 character)

            • (string) --

      • Actions (list) --

        The actions.

        • (dict) --

          Information about an action.

          • Type (string) --

            The type of action.

          • TargetGroupArn (string) --

            The Amazon Resource Name (ARN) of the target group.

      • IsDefault (boolean) --

        Indicates whether this is the default rule.

  • NextMarker (string) --

    The marker to use when requesting the next set of results. If there are no additional results, the string is empty.