RTBFabric / Client / update_link_routing_rule

update_link_routing_rule

RTBFabric.Client.update_link_routing_rule(**kwargs)

Updates a routing rule for a link.

See also: AWS API Documentation

Request Syntax

response = client.update_link_routing_rule(
    gatewayId='string',
    linkId='string',
    ruleId='string',
    priority=123,
    conditions={
        'hostHeader': 'string',
        'hostHeaderWildcard': 'string',
        'pathPrefix': 'string',
        'pathExact': 'string',
        'queryStringEquals': {
            'key': 'string',
            'value': 'string'
        },
        'queryStringExists': '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.

• priority (integer) –

  [REQUIRED]

  The updated priority of the routing rule. Lower numbers are evaluated first. Valid values are 1 to 1000. Priority must be unique among non-deleted rules within a link.

• conditions (dict) –

  [REQUIRED]

  The updated conditions for the routing rule. All specified fields must match for the rule to apply. At least one condition field must be set.

  • 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) – [REQUIRED]

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

    • value (string) – [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'ruleId': 'string',
    'status': 'CREATION_IN_PROGRESS'|'ACTIVE'|'UPDATE_IN_PROGRESS'|'DELETION_IN_PROGRESS'|'DELETED'|'FAILED',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • ruleId (string) –

    The unique identifier of the routing rule.

  • status (string) –

    The status of the routing rule.

  • updatedAt (datetime) –

    The timestamp of when the routing rule was last updated.

Exceptions

• RTBFabric.Client.exceptions.ResourceNotFoundException

• RTBFabric.Client.exceptions.ThrottlingException

• RTBFabric.Client.exceptions.AccessDeniedException

• RTBFabric.Client.exceptions.ConflictException

• RTBFabric.Client.exceptions.InternalServerException

• RTBFabric.Client.exceptions.ValidationException