RTBFabric / Paginator / ListLinkRoutingRules

ListLinkRoutingRules

class RTBFabric.Paginator.ListLinkRoutingRules

paginator = client.get_paginator('list_link_routing_rules')

paginate(**kwargs)

Creates an iterator that will paginate through responses from RTBFabric.Client.list_link_routing_rules().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    gatewayId='string',
    linkId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• gatewayId (string) –

  [REQUIRED]

  The unique identifier of the gateway.

• linkId (string) –

  [REQUIRED]

  The unique identifier of the link.

• 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

{
    'rules': [
        {
            'ruleId': 'string',
            'priority': 123,
            'conditions': {
                'hostHeader': 'string',
                'hostHeaderWildcard': 'string',
                'pathPrefix': 'string',
                'pathExact': 'string',
                'queryStringEquals': {
                    'key': 'string',
                    'value': 'string'
                },
                'queryStringExists': 'string'
            },
            'status': 'CREATION_IN_PROGRESS'|'ACTIVE'|'UPDATE_IN_PROGRESS'|'DELETION_IN_PROGRESS'|'DELETED'|'FAILED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • rules (list) –

    The list of routing rules for the link.

    • (dict) –

      A summary of a link routing rule.

      • ruleId (string) –

        The unique identifier of the routing rule.

      • priority (integer) –

        The priority of the routing rule.

      • conditions (dict) –

        The conditions for the routing rule.

        • hostHeader (string) –

          The exact host header value to match.

        • hostHeaderWildcard (string) –

          A wildcard pattern for host header matching (for example, *.example.com).

        • pathPrefix (string) –

          The path prefix to match. The request path must start with this value. Must start with /.

        • pathExact (string) –

          The exact path to match. Must start with /.

        • queryStringEquals (dict) –

          A query string key-value pair that must be present and match exactly.

          • key (string) –

            The key of the query string parameter to match. Must contain only RFC 3986 unreserved characters.

          • value (string) –

            The value of the query string parameter to match. Must contain only RFC 3986 unreserved characters.

        • queryStringExists (string) –

          A query string key that must be present in the request (any value is accepted).

      • status (string) –

        The status of the routing rule.

      • createdAt (datetime) –

        The timestamp of when the routing rule was created.

      • updatedAt (datetime) –

        The timestamp of when the routing rule was last updated.

  • NextToken (string) –

    A token to resume pagination.