RTBFabric / Client / delete_link

delete_link

RTBFabric.Client.delete_link(**kwargs)

Deletes a link between gateways.

Permanently removes the connection between gateways. This action cannot be undone.

See also: AWS API Documentation

Request Syntax

response = client.delete_link(
    gatewayId='string',
    linkId='string'
)

Parameters:

• gatewayId (string) –

  [REQUIRED]

  The unique identifier of the gateway.

• linkId (string) –

  [REQUIRED]

  The unique identifier of the link.

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

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