RTBFabric / Client / list_link_routing_rules

list_link_routing_rules

RTBFabric.Client.list_link_routing_rules(**kwargs)

Lists the routing rules for a link.

See also: AWS API Documentation

Request Syntax

response = client.list_link_routing_rules(
    gatewayId='string',
    linkId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

• gatewayId (string) –

  [REQUIRED]

  The unique identifier of the gateway.

• linkId (string) –

  [REQUIRED]

  The unique identifier of the link.

• nextToken (string) – If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

• maxResults (integer) –

  The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

  This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

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

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Exceptions

• RTBFabric.Client.exceptions.ResourceNotFoundException

• RTBFabric.Client.exceptions.ThrottlingException

• RTBFabric.Client.exceptions.AccessDeniedException

• RTBFabric.Client.exceptions.InternalServerException

• RTBFabric.Client.exceptions.ValidationException