RTBFabric / Client / update_link

update_link

RTBFabric.Client.update_link(**kwargs)

Updates the configuration of a link between gateways.

Allows you to modify settings and parameters for an existing link.

See also: AWS API Documentation

Request Syntax

response = client.update_link(
    gatewayId='string',
    linkId='string',
    logSettings={
        'applicationLogs': {
            'sampling': {
                'errorLog': 123.0,
                'filterLog': 123.0
            }
        }
    }
)

Parameters:

• gatewayId (string) –

  [REQUIRED]

  The unique identifier of the gateway.

• linkId (string) –

  [REQUIRED]

  The unique identifier of the link.

• logSettings (dict) –

  Settings for the application logs.

  • applicationLogs (dict) – [REQUIRED]

    Describes the configuration of a link application log.

    • sampling (dict) – [REQUIRED]

      Describes a link application log sample.

      • errorLog (float) – [REQUIRED]

        An error log entry.

      • filterLog (float) – [REQUIRED]

        A filter log entry.

Return type:

dict

Returns:

Response Syntax

{
    'linkId': 'string',
    'status': 'PENDING_CREATION'|'PENDING_REQUEST'|'REQUESTED'|'ACCEPTED'|'ACTIVE'|'REJECTED'|'FAILED'|'PENDING_DELETION'|'DELETED'|'PENDING_UPDATE'|'PENDING_ISOLATION'|'ISOLATED'|'PENDING_RESTORATION'
}

Response Structure

• (dict) –

  • linkId (string) –

    The unique identifier of the link.

  • status (string) –

    The status of the request.

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