RTBFabric / Client / get_link_routing_rule

get_link_routing_rule

RTBFabric.Client.get_link_routing_rule(**kwargs)

Retrieves the details of a routing rule for a link.

See also: AWS API Documentation

Request Syntax

response = client.get_link_routing_rule(
    gatewayId='string',
    linkId='string',
    ruleId='string'
)

Parameters:

• gatewayId (string) –

  [REQUIRED]

  The unique identifier of the gateway.

• linkId (string) –

  [REQUIRED]

  The unique identifier of the link.

• ruleId (string) –

  [REQUIRED]

  The unique identifier of the routing rule.

Return type:

dict

Returns:

Response Syntax

{
    'gatewayId': 'string',
    'linkId': 'string',
    '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),
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) –

  • gatewayId (string) –

    The unique identifier of the gateway.

  • linkId (string) –

    The unique identifier of the link.

  • 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.

  • tags (dict) –

    A map of the key-value pairs for the tag or tags assigned to the specified resource.

    • (string) –

      • (string) –

Exceptions

• RTBFabric.Client.exceptions.ResourceNotFoundException

• RTBFabric.Client.exceptions.ThrottlingException

• RTBFabric.Client.exceptions.AccessDeniedException

• RTBFabric.Client.exceptions.InternalServerException

• RTBFabric.Client.exceptions.ValidationException