VPCLattice / Paginator / ListRules

ListRules#

class VPCLattice.Paginator.ListRules#
paginator = client.get_paginator('list_rules')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from VPCLattice.Client.list_rules().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    listenerIdentifier='string',
    serviceIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • listenerIdentifier (string) –

    [REQUIRED]

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

  • serviceIdentifier (string) –

    [REQUIRED]

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

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

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 rule. Listener rules are created when you create a listener. Each listener has a default rule for checking connection requests.

        • 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) –

      A token to resume pagination.