VPCLattice / Client / list_rules

list_rules#

VPCLattice.Client.list_rules(**kwargs)#

Lists the rules for the listener.

See also: AWS API Documentation

Request Syntax

response = client.list_rules(
    listenerIdentifier='string',
    maxResults=123,
    nextToken='string',
    serviceIdentifier='string'
)
Parameters:

  • listenerIdentifier (string) –

    [REQUIRED]

    The ID or Amazon Resource Name (ARN) of the listener.

  • maxResults (integer) – The maximum number of results to return.

  • nextToken (string) – A pagination token for the next page of results.

  • serviceIdentifier (string) –

    [REQUIRED]

    The ID or Amazon Resource Name (ARN) of the service.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'id': 'string',
            'isDefault': True|False,
            'lastUpdatedAt': datetime(2015, 1, 1),
            'name': 'string',
            'priority': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      Information about the rules.

      • (dict) –

        Summary information about the listener rule.

        • arn (string) –

          The Amazon Resource Name (ARN) of the rule.

        • createdAt (datetime) –

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

        • id (string) –

          The ID of the rule.

        • isDefault (boolean) –

          Indicates whether this is the default listener rule.

        • lastUpdatedAt (datetime) –

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

        • name (string) –

          The name of the rule.

        • priority (integer) –

          The priority of the rule.

    • nextToken (string) –

      If there are additional results, a pagination token for the next page of results.

Exceptions