RTBFabric / Client / get_outbound_external_link

get_outbound_external_link

RTBFabric.Client.get_outbound_external_link(**kwargs)

Retrieves information about an outbound external link.

See also: AWS API Documentation

Request Syntax

response = client.get_outbound_external_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

{
    'gatewayId': 'string',
    'linkId': 'string',
    'status': 'PENDING_CREATION'|'PENDING_REQUEST'|'REQUESTED'|'ACCEPTED'|'ACTIVE'|'REJECTED'|'FAILED'|'PENDING_DELETION'|'DELETED'|'PENDING_UPDATE'|'PENDING_ISOLATION'|'ISOLATED'|'PENDING_RESTORATION',
    'publicEndpoint': 'string',
    '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.

  • status (string) –

    The status of the request.

  • publicEndpoint (string) –

    The public endpoint for the link.

  • createdAt (datetime) –

    The timestamp of when the outbound external link was created.

  • updatedAt (datetime) –

    The timestamp of when the outbound external link was 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