RTBFabric / Client / create_outbound_external_link

create_outbound_external_link

RTBFabric.Client.create_outbound_external_link(**kwargs)

Creates an outbound external link.

See also: AWS API Documentation

Request Syntax

response = client.create_outbound_external_link(
    clientToken='string',
    gatewayId='string',
    publicEndpoint='string',
    tags={
        'string': 'string'
    }
)

Parameters:

• clientToken (string) –

  [REQUIRED]

  The unique client token.

  This field is autopopulated if not provided.

• gatewayId (string) –

  [REQUIRED]

  The unique identifier of the gateway.

• publicEndpoint (string) –

  [REQUIRED]

  The public endpoint of the link.

• tags (dict) –

  A map of the key-value pairs of the tag or tags to assign to the resource.

  • (string) –

    • (string) –

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'
}

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.

Exceptions

• RTBFabric.Client.exceptions.ServiceQuotaExceededException

• RTBFabric.Client.exceptions.ResourceNotFoundException

• RTBFabric.Client.exceptions.ThrottlingException

• RTBFabric.Client.exceptions.AccessDeniedException

• RTBFabric.Client.exceptions.InternalServerException

• RTBFabric.Client.exceptions.ValidationException