2025/10/24 - RTBFabric - 7 updated api methods
Changes Add support for custom rate limits.
{'flowModules': {'moduleParameters': {'rateLimiter': {'tps': 'float'}}},
'pendingFlowModules': {'moduleParameters': {'rateLimiter': {'tps': 'float'}}}}
Accepts a link request between RTB applications.
When a requester RTB application requests to link with a responder RTB application, the responder can use this operation to accept the link request and establish the connection.
See also: AWS API Documentation
Request Syntax
client.accept_link(
gatewayId='string',
linkId='string',
attributes={
'responderErrorMasking': [
{
'httpCode': 'string',
'action': 'NO_BID'|'PASSTHROUGH',
'loggingTypes': [
'NONE'|'METRIC'|'RESPONSE',
],
'responseLoggingPercentage': ...
},
],
'customerProvidedId': 'string'
},
logSettings={
'applicationLogs': {
'sampling': {
'errorLog': 123.0,
'filterLog': 123.0
}
}
}
)
string
[REQUIRED]
The unique identifier of the gateway.
string
[REQUIRED]
The unique identifier of the link.
dict
Attributes of the link.
responderErrorMasking (list) --
Describes the masking for HTTP error codes.
(dict) --
Describes the masking for HTTP error codes.
httpCode (string) -- [REQUIRED]
The HTTP error code.
action (string) -- [REQUIRED]
The action for the error..
loggingTypes (list) -- [REQUIRED]
The error log type.
(string) --
responseLoggingPercentage (float) --
The percentage of response logging.
customerProvidedId (string) --
The customer-provided unique identifier of the link.
dict
[REQUIRED]
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.
dict
Response Syntax
{
'gatewayId': 'string',
'peerGatewayId': 'string',
'status': 'PENDING_CREATION'|'PENDING_REQUEST'|'REQUESTED'|'ACCEPTED'|'ACTIVE'|'REJECTED'|'FAILED'|'PENDING_DELETION'|'DELETED'|'PENDING_UPDATE'|'PENDING_ISOLATION'|'ISOLATED'|'PENDING_RESTORATION',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'direction': 'RESPONSE'|'REQUEST',
'flowModules': [
{
'version': 'string',
'name': 'string',
'dependsOn': [
'string',
],
'moduleParameters': {
'noBid': {
'reason': 'string',
'reasonCode': 123,
'passThroughPercentage': ...
},
'openRtbAttribute': {
'filterType': 'INCLUDE'|'EXCLUDE',
'filterConfiguration': [
{
'criteria': [
{
'path': 'string',
'values': [
'string',
]
},
]
},
],
'action': {
'noBid': {
'noBidReasonCode': 123
},
'headerTag': {
'name': 'string',
'value': 'string'
}
},
'holdbackPercentage': ...
},
'rateLimiter': {
'tps': ...
}
}
},
],
'pendingFlowModules': [
{
'version': 'string',
'name': 'string',
'dependsOn': [
'string',
],
'moduleParameters': {
'noBid': {
'reason': 'string',
'reasonCode': 123,
'passThroughPercentage': ...
},
'openRtbAttribute': {
'filterType': 'INCLUDE'|'EXCLUDE',
'filterConfiguration': [
{
'criteria': [
{
'path': 'string',
'values': [
'string',
]
},
]
},
],
'action': {
'noBid': {
'noBidReasonCode': 123
},
'headerTag': {
'name': 'string',
'value': 'string'
}
},
'holdbackPercentage': ...
},
'rateLimiter': {
'tps': ...
}
}
},
],
'attributes': {
'responderErrorMasking': [
{
'httpCode': 'string',
'action': 'NO_BID'|'PASSTHROUGH',
'loggingTypes': [
'NONE'|'METRIC'|'RESPONSE',
],
'responseLoggingPercentage': ...
},
],
'customerProvidedId': 'string'
},
'linkId': 'string'
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
peerGatewayId (string) --
The unique identifier of the peer gateway.
status (string) --
The status of the link.
createdAt (datetime) --
The timestamp of when the link was created.
updatedAt (datetime) --
The timestamp of when the link was updated.
direction (string) --
The direction of the link.
flowModules (list) --
The configuration of flow modules.
(dict) --
Describes the configuration of a module.
version (string) --
The version of the module.
name (string) --
The name of the module.
dependsOn (list) --
The dependencies of the module.
(string) --
moduleParameters (dict) --
Describes the parameters of a module.
noBid (dict) --
Describes the parameters of a no bid module.
reason (string) --
The reason description.
reasonCode (integer) --
The reason code.
passThroughPercentage (float) --
The pass through percentage.
openRtbAttribute (dict) --
Describes the parameters of an open RTB attribute module.
filterType (string) --
The filter type.
filterConfiguration (list) --
Describes the configuration of a filter.
(dict) --
Describes the configuration of a filter.
criteria (list) --
Describes the criteria for a filter.
(dict) --
Describes the criteria for a filter.
path (string) --
The path to filter.
values (list) --
The value to filter.
(string) --
action (dict) --
Describes a bid action.
noBid (dict) --
Describes a no bid action.
noBidReasonCode (integer) --
The reason code for the no bid action.
headerTag (dict) --
Describes the header tag for a bid action.
name (string) --
The name of the bid action.
value (string) --
The value of the bid action.
holdbackPercentage (float) --
The hold back percentage.
rateLimiter (dict) --
Describes the parameters of a rate limit.
tps (float) --
The transactions per second rate limit.
pendingFlowModules (list) --
The configuration of pending flow modules.
(dict) --
Describes the configuration of a module.
version (string) --
The version of the module.
name (string) --
The name of the module.
dependsOn (list) --
The dependencies of the module.
(string) --
moduleParameters (dict) --
Describes the parameters of a module.
noBid (dict) --
Describes the parameters of a no bid module.
reason (string) --
The reason description.
reasonCode (integer) --
The reason code.
passThroughPercentage (float) --
The pass through percentage.
openRtbAttribute (dict) --
Describes the parameters of an open RTB attribute module.
filterType (string) --
The filter type.
filterConfiguration (list) --
Describes the configuration of a filter.
(dict) --
Describes the configuration of a filter.
criteria (list) --
Describes the criteria for a filter.
(dict) --
Describes the criteria for a filter.
path (string) --
The path to filter.
values (list) --
The value to filter.
(string) --
action (dict) --
Describes a bid action.
noBid (dict) --
Describes a no bid action.
noBidReasonCode (integer) --
The reason code for the no bid action.
headerTag (dict) --
Describes the header tag for a bid action.
name (string) --
The name of the bid action.
value (string) --
The value of the bid action.
holdbackPercentage (float) --
The hold back percentage.
rateLimiter (dict) --
Describes the parameters of a rate limit.
tps (float) --
The transactions per second rate limit.
attributes (dict) --
Attributes of the link.
responderErrorMasking (list) --
Describes the masking for HTTP error codes.
(dict) --
Describes the masking for HTTP error codes.
httpCode (string) --
The HTTP error code.
action (string) --
The action for the error..
loggingTypes (list) --
The error log type.
(string) --
responseLoggingPercentage (float) --
The percentage of response logging.
customerProvidedId (string) --
The customer-provided unique identifier of the link.
linkId (string) --
The unique identifier of the link.
{'flowModules': {'moduleParameters': {'rateLimiter': {'tps': 'float'}}},
'pendingFlowModules': {'moduleParameters': {'rateLimiter': {'tps': 'float'}}}}
Creates a new link between RTB applications.
Establishes a connection that allows RTB applications to communicate and exchange bid requests and responses.
See also: AWS API Documentation
Request Syntax
client.create_link(
gatewayId='string',
peerGatewayId='string',
attributes={
'responderErrorMasking': [
{
'httpCode': 'string',
'action': 'NO_BID'|'PASSTHROUGH',
'loggingTypes': [
'NONE'|'METRIC'|'RESPONSE',
],
'responseLoggingPercentage': ...
},
],
'customerProvidedId': 'string'
},
httpResponderAllowed=True|False,
tags={
'string': 'string'
},
logSettings={
'applicationLogs': {
'sampling': {
'errorLog': 123.0,
'filterLog': 123.0
}
}
}
)
string
[REQUIRED]
The unique identifier of the gateway.
string
[REQUIRED]
The unique identifier of the peer gateway.
dict
Attributes of the link.
responderErrorMasking (list) --
Describes the masking for HTTP error codes.
(dict) --
Describes the masking for HTTP error codes.
httpCode (string) -- [REQUIRED]
The HTTP error code.
action (string) -- [REQUIRED]
The action for the error..
loggingTypes (list) -- [REQUIRED]
The error log type.
(string) --
responseLoggingPercentage (float) --
The percentage of response logging.
customerProvidedId (string) --
The customer-provided unique identifier of the link.
boolean
Boolean to specify if an HTTP responder is allowed.
dict
A map of the key-value pairs of the tag or tags to assign to the resource.
(string) --
(string) --
dict
[REQUIRED]
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.
dict
Response Syntax
{
'gatewayId': 'string',
'peerGatewayId': 'string',
'status': 'PENDING_CREATION'|'PENDING_REQUEST'|'REQUESTED'|'ACCEPTED'|'ACTIVE'|'REJECTED'|'FAILED'|'PENDING_DELETION'|'DELETED'|'PENDING_UPDATE'|'PENDING_ISOLATION'|'ISOLATED'|'PENDING_RESTORATION',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'direction': 'RESPONSE'|'REQUEST',
'flowModules': [
{
'version': 'string',
'name': 'string',
'dependsOn': [
'string',
],
'moduleParameters': {
'noBid': {
'reason': 'string',
'reasonCode': 123,
'passThroughPercentage': ...
},
'openRtbAttribute': {
'filterType': 'INCLUDE'|'EXCLUDE',
'filterConfiguration': [
{
'criteria': [
{
'path': 'string',
'values': [
'string',
]
},
]
},
],
'action': {
'noBid': {
'noBidReasonCode': 123
},
'headerTag': {
'name': 'string',
'value': 'string'
}
},
'holdbackPercentage': ...
},
'rateLimiter': {
'tps': ...
}
}
},
],
'pendingFlowModules': [
{
'version': 'string',
'name': 'string',
'dependsOn': [
'string',
],
'moduleParameters': {
'noBid': {
'reason': 'string',
'reasonCode': 123,
'passThroughPercentage': ...
},
'openRtbAttribute': {
'filterType': 'INCLUDE'|'EXCLUDE',
'filterConfiguration': [
{
'criteria': [
{
'path': 'string',
'values': [
'string',
]
},
]
},
],
'action': {
'noBid': {
'noBidReasonCode': 123
},
'headerTag': {
'name': 'string',
'value': 'string'
}
},
'holdbackPercentage': ...
},
'rateLimiter': {
'tps': ...
}
}
},
],
'attributes': {
'responderErrorMasking': [
{
'httpCode': 'string',
'action': 'NO_BID'|'PASSTHROUGH',
'loggingTypes': [
'NONE'|'METRIC'|'RESPONSE',
],
'responseLoggingPercentage': ...
},
],
'customerProvidedId': 'string'
},
'linkId': 'string',
'customerProvidedId': 'string'
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
peerGatewayId (string) --
The unique identifier of the peer gateway.
status (string) --
The status of the request.
createdAt (datetime) --
The timestamp of when the link was created.
updatedAt (datetime) --
The timestamp of when the link was updated.
direction (string) --
The direction of the link.
flowModules (list) --
The configuration of flow modules.
(dict) --
Describes the configuration of a module.
version (string) --
The version of the module.
name (string) --
The name of the module.
dependsOn (list) --
The dependencies of the module.
(string) --
moduleParameters (dict) --
Describes the parameters of a module.
noBid (dict) --
Describes the parameters of a no bid module.
reason (string) --
The reason description.
reasonCode (integer) --
The reason code.
passThroughPercentage (float) --
The pass through percentage.
openRtbAttribute (dict) --
Describes the parameters of an open RTB attribute module.
filterType (string) --
The filter type.
filterConfiguration (list) --
Describes the configuration of a filter.
(dict) --
Describes the configuration of a filter.
criteria (list) --
Describes the criteria for a filter.
(dict) --
Describes the criteria for a filter.
path (string) --
The path to filter.
values (list) --
The value to filter.
(string) --
action (dict) --
Describes a bid action.
noBid (dict) --
Describes a no bid action.
noBidReasonCode (integer) --
The reason code for the no bid action.
headerTag (dict) --
Describes the header tag for a bid action.
name (string) --
The name of the bid action.
value (string) --
The value of the bid action.
holdbackPercentage (float) --
The hold back percentage.
rateLimiter (dict) --
Describes the parameters of a rate limit.
tps (float) --
The transactions per second rate limit.
pendingFlowModules (list) --
The configuration of pending flow modules.
(dict) --
Describes the configuration of a module.
version (string) --
The version of the module.
name (string) --
The name of the module.
dependsOn (list) --
The dependencies of the module.
(string) --
moduleParameters (dict) --
Describes the parameters of a module.
noBid (dict) --
Describes the parameters of a no bid module.
reason (string) --
The reason description.
reasonCode (integer) --
The reason code.
passThroughPercentage (float) --
The pass through percentage.
openRtbAttribute (dict) --
Describes the parameters of an open RTB attribute module.
filterType (string) --
The filter type.
filterConfiguration (list) --
Describes the configuration of a filter.
(dict) --
Describes the configuration of a filter.
criteria (list) --
Describes the criteria for a filter.
(dict) --
Describes the criteria for a filter.
path (string) --
The path to filter.
values (list) --
The value to filter.
(string) --
action (dict) --
Describes a bid action.
noBid (dict) --
Describes a no bid action.
noBidReasonCode (integer) --
The reason code for the no bid action.
headerTag (dict) --
Describes the header tag for a bid action.
name (string) --
The name of the bid action.
value (string) --
The value of the bid action.
holdbackPercentage (float) --
The hold back percentage.
rateLimiter (dict) --
Describes the parameters of a rate limit.
tps (float) --
The transactions per second rate limit.
attributes (dict) --
Attributes of the link.
responderErrorMasking (list) --
Describes the masking for HTTP error codes.
(dict) --
Describes the masking for HTTP error codes.
httpCode (string) --
The HTTP error code.
action (string) --
The action for the error..
loggingTypes (list) --
The error log type.
(string) --
responseLoggingPercentage (float) --
The percentage of response logging.
customerProvidedId (string) --
The customer-provided unique identifier of the link.
linkId (string) --
The unique identifier of the link.
customerProvidedId (string) --
The customer-provided unique identifier of the link.
{'flowModules': {'moduleParameters': {'rateLimiter': {'tps': 'float'}}},
'pendingFlowModules': {'moduleParameters': {'rateLimiter': {'tps': 'float'}}}}
Retrieves information about an inbound external link.
See also: AWS API Documentation
Request Syntax
client.get_inbound_external_link(
gatewayId='string',
linkId='string'
)
string
[REQUIRED]
The unique identifier of the gateway.
string
[REQUIRED]
The unique identifier of the link.
dict
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',
'domainName': 'string',
'flowModules': [
{
'version': 'string',
'name': 'string',
'dependsOn': [
'string',
],
'moduleParameters': {
'noBid': {
'reason': 'string',
'reasonCode': 123,
'passThroughPercentage': ...
},
'openRtbAttribute': {
'filterType': 'INCLUDE'|'EXCLUDE',
'filterConfiguration': [
{
'criteria': [
{
'path': 'string',
'values': [
'string',
]
},
]
},
],
'action': {
'noBid': {
'noBidReasonCode': 123
},
'headerTag': {
'name': 'string',
'value': 'string'
}
},
'holdbackPercentage': ...
},
'rateLimiter': {
'tps': ...
}
}
},
],
'pendingFlowModules': [
{
'version': 'string',
'name': 'string',
'dependsOn': [
'string',
],
'moduleParameters': {
'noBid': {
'reason': 'string',
'reasonCode': 123,
'passThroughPercentage': ...
},
'openRtbAttribute': {
'filterType': 'INCLUDE'|'EXCLUDE',
'filterConfiguration': [
{
'criteria': [
{
'path': 'string',
'values': [
'string',
]
},
]
},
],
'action': {
'noBid': {
'noBidReasonCode': 123
},
'headerTag': {
'name': 'string',
'value': 'string'
}
},
'holdbackPercentage': ...
},
'rateLimiter': {
'tps': ...
}
}
},
],
'attributes': {
'responderErrorMasking': [
{
'httpCode': 'string',
'action': 'NO_BID'|'PASSTHROUGH',
'loggingTypes': [
'NONE'|'METRIC'|'RESPONSE',
],
'responseLoggingPercentage': ...
},
],
'customerProvidedId': '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.
domainName (string) --
The domain name.
flowModules (list) --
The configuration of flow modules.
(dict) --
Describes the configuration of a module.
version (string) --
The version of the module.
name (string) --
The name of the module.
dependsOn (list) --
The dependencies of the module.
(string) --
moduleParameters (dict) --
Describes the parameters of a module.
noBid (dict) --
Describes the parameters of a no bid module.
reason (string) --
The reason description.
reasonCode (integer) --
The reason code.
passThroughPercentage (float) --
The pass through percentage.
openRtbAttribute (dict) --
Describes the parameters of an open RTB attribute module.
filterType (string) --
The filter type.
filterConfiguration (list) --
Describes the configuration of a filter.
(dict) --
Describes the configuration of a filter.
criteria (list) --
Describes the criteria for a filter.
(dict) --
Describes the criteria for a filter.
path (string) --
The path to filter.
values (list) --
The value to filter.
(string) --
action (dict) --
Describes a bid action.
noBid (dict) --
Describes a no bid action.
noBidReasonCode (integer) --
The reason code for the no bid action.
headerTag (dict) --
Describes the header tag for a bid action.
name (string) --
The name of the bid action.
value (string) --
The value of the bid action.
holdbackPercentage (float) --
The hold back percentage.
rateLimiter (dict) --
Describes the parameters of a rate limit.
tps (float) --
The transactions per second rate limit.
pendingFlowModules (list) --
The configuration of pending flow modules.
(dict) --
Describes the configuration of a module.
version (string) --
The version of the module.
name (string) --
The name of the module.
dependsOn (list) --
The dependencies of the module.
(string) --
moduleParameters (dict) --
Describes the parameters of a module.
noBid (dict) --
Describes the parameters of a no bid module.
reason (string) --
The reason description.
reasonCode (integer) --
The reason code.
passThroughPercentage (float) --
The pass through percentage.
openRtbAttribute (dict) --
Describes the parameters of an open RTB attribute module.
filterType (string) --
The filter type.
filterConfiguration (list) --
Describes the configuration of a filter.
(dict) --
Describes the configuration of a filter.
criteria (list) --
Describes the criteria for a filter.
(dict) --
Describes the criteria for a filter.
path (string) --
The path to filter.
values (list) --
The value to filter.
(string) --
action (dict) --
Describes a bid action.
noBid (dict) --
Describes a no bid action.
noBidReasonCode (integer) --
The reason code for the no bid action.
headerTag (dict) --
Describes the header tag for a bid action.
name (string) --
The name of the bid action.
value (string) --
The value of the bid action.
holdbackPercentage (float) --
The hold back percentage.
rateLimiter (dict) --
Describes the parameters of a rate limit.
tps (float) --
The transactions per second rate limit.
attributes (dict) --
Attributes of the link.
responderErrorMasking (list) --
Describes the masking for HTTP error codes.
(dict) --
Describes the masking for HTTP error codes.
httpCode (string) --
The HTTP error code.
action (string) --
The action for the error..
loggingTypes (list) --
The error log type.
(string) --
responseLoggingPercentage (float) --
The percentage of response logging.
customerProvidedId (string) --
The customer-provided unique identifier of the link.
createdAt (datetime) --
The timestamp of when the inbound external link was created.
updatedAt (datetime) --
The timestamp of when the inbound 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) --
{'flowModules': {'moduleParameters': {'rateLimiter': {'tps': 'float'}}},
'pendingFlowModules': {'moduleParameters': {'rateLimiter': {'tps': 'float'}}}}
Retrieves information about a link between RTB applications.
Returns detailed information about the link configuration, status, and associated RTB applications.
See also: AWS API Documentation
Request Syntax
client.get_link(
gatewayId='string',
linkId='string'
)
string
[REQUIRED]
The unique identifier of the gateway.
string
[REQUIRED]
The unique identifier of the link.
dict
Response Syntax
{
'gatewayId': 'string',
'peerGatewayId': 'string',
'status': 'PENDING_CREATION'|'PENDING_REQUEST'|'REQUESTED'|'ACCEPTED'|'ACTIVE'|'REJECTED'|'FAILED'|'PENDING_DELETION'|'DELETED'|'PENDING_UPDATE'|'PENDING_ISOLATION'|'ISOLATED'|'PENDING_RESTORATION',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'direction': 'RESPONSE'|'REQUEST',
'flowModules': [
{
'version': 'string',
'name': 'string',
'dependsOn': [
'string',
],
'moduleParameters': {
'noBid': {
'reason': 'string',
'reasonCode': 123,
'passThroughPercentage': ...
},
'openRtbAttribute': {
'filterType': 'INCLUDE'|'EXCLUDE',
'filterConfiguration': [
{
'criteria': [
{
'path': 'string',
'values': [
'string',
]
},
]
},
],
'action': {
'noBid': {
'noBidReasonCode': 123
},
'headerTag': {
'name': 'string',
'value': 'string'
}
},
'holdbackPercentage': ...
},
'rateLimiter': {
'tps': ...
}
}
},
],
'pendingFlowModules': [
{
'version': 'string',
'name': 'string',
'dependsOn': [
'string',
],
'moduleParameters': {
'noBid': {
'reason': 'string',
'reasonCode': 123,
'passThroughPercentage': ...
},
'openRtbAttribute': {
'filterType': 'INCLUDE'|'EXCLUDE',
'filterConfiguration': [
{
'criteria': [
{
'path': 'string',
'values': [
'string',
]
},
]
},
],
'action': {
'noBid': {
'noBidReasonCode': 123
},
'headerTag': {
'name': 'string',
'value': 'string'
}
},
'holdbackPercentage': ...
},
'rateLimiter': {
'tps': ...
}
}
},
],
'attributes': {
'responderErrorMasking': [
{
'httpCode': 'string',
'action': 'NO_BID'|'PASSTHROUGH',
'loggingTypes': [
'NONE'|'METRIC'|'RESPONSE',
],
'responseLoggingPercentage': ...
},
],
'customerProvidedId': 'string'
},
'linkId': 'string',
'tags': {
'string': 'string'
},
'logSettings': {
'applicationLogs': {
'sampling': {
'errorLog': 123.0,
'filterLog': 123.0
}
}
}
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
peerGatewayId (string) --
The unique identifier of the peer gateway.
status (string) --
The status of the link.
createdAt (datetime) --
The timestamp of when the link was created.
updatedAt (datetime) --
The timestamp of when the link was updated.
direction (string) --
The direction of the link.
flowModules (list) --
The configuration of flow modules.
(dict) --
Describes the configuration of a module.
version (string) --
The version of the module.
name (string) --
The name of the module.
dependsOn (list) --
The dependencies of the module.
(string) --
moduleParameters (dict) --
Describes the parameters of a module.
noBid (dict) --
Describes the parameters of a no bid module.
reason (string) --
The reason description.
reasonCode (integer) --
The reason code.
passThroughPercentage (float) --
The pass through percentage.
openRtbAttribute (dict) --
Describes the parameters of an open RTB attribute module.
filterType (string) --
The filter type.
filterConfiguration (list) --
Describes the configuration of a filter.
(dict) --
Describes the configuration of a filter.
criteria (list) --
Describes the criteria for a filter.
(dict) --
Describes the criteria for a filter.
path (string) --
The path to filter.
values (list) --
The value to filter.
(string) --
action (dict) --
Describes a bid action.
noBid (dict) --
Describes a no bid action.
noBidReasonCode (integer) --
The reason code for the no bid action.
headerTag (dict) --
Describes the header tag for a bid action.
name (string) --
The name of the bid action.
value (string) --
The value of the bid action.
holdbackPercentage (float) --
The hold back percentage.
rateLimiter (dict) --
Describes the parameters of a rate limit.
tps (float) --
The transactions per second rate limit.
pendingFlowModules (list) --
The configuration of pending flow modules.
(dict) --
Describes the configuration of a module.
version (string) --
The version of the module.
name (string) --
The name of the module.
dependsOn (list) --
The dependencies of the module.
(string) --
moduleParameters (dict) --
Describes the parameters of a module.
noBid (dict) --
Describes the parameters of a no bid module.
reason (string) --
The reason description.
reasonCode (integer) --
The reason code.
passThroughPercentage (float) --
The pass through percentage.
openRtbAttribute (dict) --
Describes the parameters of an open RTB attribute module.
filterType (string) --
The filter type.
filterConfiguration (list) --
Describes the configuration of a filter.
(dict) --
Describes the configuration of a filter.
criteria (list) --
Describes the criteria for a filter.
(dict) --
Describes the criteria for a filter.
path (string) --
The path to filter.
values (list) --
The value to filter.
(string) --
action (dict) --
Describes a bid action.
noBid (dict) --
Describes a no bid action.
noBidReasonCode (integer) --
The reason code for the no bid action.
headerTag (dict) --
Describes the header tag for a bid action.
name (string) --
The name of the bid action.
value (string) --
The value of the bid action.
holdbackPercentage (float) --
The hold back percentage.
rateLimiter (dict) --
Describes the parameters of a rate limit.
tps (float) --
The transactions per second rate limit.
attributes (dict) --
Attributes of the link.
responderErrorMasking (list) --
Describes the masking for HTTP error codes.
(dict) --
Describes the masking for HTTP error codes.
httpCode (string) --
The HTTP error code.
action (string) --
The action for the error..
loggingTypes (list) --
The error log type.
(string) --
responseLoggingPercentage (float) --
The percentage of response logging.
customerProvidedId (string) --
The customer-provided unique identifier of the link.
linkId (string) --
The unique identifier of the link.
tags (dict) --
A map of the key-value pairs for the tag or tags assigned to the specified resource.
(string) --
(string) --
logSettings (dict) --
Settings for the application logs.
applicationLogs (dict) --
Describes the configuration of a link application log.
sampling (dict) --
Describes a link application log sample.
errorLog (float) --
An error log entry.
filterLog (float) --
A filter log entry.
{'links': {'flowModules': {'moduleParameters': {'rateLimiter': {'tps': 'float'}}},
'pendingFlowModules': {'moduleParameters': {'rateLimiter': {'tps': 'float'}}}}}
Lists links associated with an RTB application.
Returns a list of all links for the specified RTB application, including their status and configuration details.
See also: AWS API Documentation
Request Syntax
client.list_links(
gatewayId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique identifier of the gateway.
string
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
integer
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
dict
Response Syntax
{
'links': [
{
'gatewayId': 'string',
'peerGatewayId': 'string',
'status': 'PENDING_CREATION'|'PENDING_REQUEST'|'REQUESTED'|'ACCEPTED'|'ACTIVE'|'REJECTED'|'FAILED'|'PENDING_DELETION'|'DELETED'|'PENDING_UPDATE'|'PENDING_ISOLATION'|'ISOLATED'|'PENDING_RESTORATION',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'direction': 'RESPONSE'|'REQUEST',
'flowModules': [
{
'version': 'string',
'name': 'string',
'dependsOn': [
'string',
],
'moduleParameters': {
'noBid': {
'reason': 'string',
'reasonCode': 123,
'passThroughPercentage': ...
},
'openRtbAttribute': {
'filterType': 'INCLUDE'|'EXCLUDE',
'filterConfiguration': [
{
'criteria': [
{
'path': 'string',
'values': [
'string',
]
},
]
},
],
'action': {
'noBid': {
'noBidReasonCode': 123
},
'headerTag': {
'name': 'string',
'value': 'string'
}
},
'holdbackPercentage': ...
},
'rateLimiter': {
'tps': ...
}
}
},
],
'pendingFlowModules': [
{
'version': 'string',
'name': 'string',
'dependsOn': [
'string',
],
'moduleParameters': {
'noBid': {
'reason': 'string',
'reasonCode': 123,
'passThroughPercentage': ...
},
'openRtbAttribute': {
'filterType': 'INCLUDE'|'EXCLUDE',
'filterConfiguration': [
{
'criteria': [
{
'path': 'string',
'values': [
'string',
]
},
]
},
],
'action': {
'noBid': {
'noBidReasonCode': 123
},
'headerTag': {
'name': 'string',
'value': 'string'
}
},
'holdbackPercentage': ...
},
'rateLimiter': {
'tps': ...
}
}
},
],
'attributes': {
'responderErrorMasking': [
{
'httpCode': 'string',
'action': 'NO_BID'|'PASSTHROUGH',
'loggingTypes': [
'NONE'|'METRIC'|'RESPONSE',
],
'responseLoggingPercentage': ...
},
],
'customerProvidedId': 'string'
},
'linkId': 'string',
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
links (list) --
Information about created links.
(dict) --
Describes a link.
gatewayId (string) --
The unique identifier of the gateway.
peerGatewayId (string) --
The unique identifier of the peer gateway.
status (string) --
The status of the link.
createdAt (datetime) --
The timestamp of when the link was created.
updatedAt (datetime) --
The timestamp of when the link was updated.
direction (string) --
The direction of the link.
flowModules (list) --
Describes the configuration of flow modules.
(dict) --
Describes the configuration of a module.
version (string) --
The version of the module.
name (string) --
The name of the module.
dependsOn (list) --
The dependencies of the module.
(string) --
moduleParameters (dict) --
Describes the parameters of a module.
noBid (dict) --
Describes the parameters of a no bid module.
reason (string) --
The reason description.
reasonCode (integer) --
The reason code.
passThroughPercentage (float) --
The pass through percentage.
openRtbAttribute (dict) --
Describes the parameters of an open RTB attribute module.
filterType (string) --
The filter type.
filterConfiguration (list) --
Describes the configuration of a filter.
(dict) --
Describes the configuration of a filter.
criteria (list) --
Describes the criteria for a filter.
(dict) --
Describes the criteria for a filter.
path (string) --
The path to filter.
values (list) --
The value to filter.
(string) --
action (dict) --
Describes a bid action.
noBid (dict) --
Describes a no bid action.
noBidReasonCode (integer) --
The reason code for the no bid action.
headerTag (dict) --
Describes the header tag for a bid action.
name (string) --
The name of the bid action.
value (string) --
The value of the bid action.
holdbackPercentage (float) --
The hold back percentage.
rateLimiter (dict) --
Describes the parameters of a rate limit.
tps (float) --
The transactions per second rate limit.
pendingFlowModules (list) --
Describes the configuration of pending flow modules.
(dict) --
Describes the configuration of a module.
version (string) --
The version of the module.
name (string) --
The name of the module.
dependsOn (list) --
The dependencies of the module.
(string) --
moduleParameters (dict) --
Describes the parameters of a module.
noBid (dict) --
Describes the parameters of a no bid module.
reason (string) --
The reason description.
reasonCode (integer) --
The reason code.
passThroughPercentage (float) --
The pass through percentage.
openRtbAttribute (dict) --
Describes the parameters of an open RTB attribute module.
filterType (string) --
The filter type.
filterConfiguration (list) --
Describes the configuration of a filter.
(dict) --
Describes the configuration of a filter.
criteria (list) --
Describes the criteria for a filter.
(dict) --
Describes the criteria for a filter.
path (string) --
The path to filter.
values (list) --
The value to filter.
(string) --
action (dict) --
Describes a bid action.
noBid (dict) --
Describes a no bid action.
noBidReasonCode (integer) --
The reason code for the no bid action.
headerTag (dict) --
Describes the header tag for a bid action.
name (string) --
The name of the bid action.
value (string) --
The value of the bid action.
holdbackPercentage (float) --
The hold back percentage.
rateLimiter (dict) --
Describes the parameters of a rate limit.
tps (float) --
The transactions per second rate limit.
attributes (dict) --
Describes attributes of a link.
responderErrorMasking (list) --
Describes the masking for HTTP error codes.
(dict) --
Describes the masking for HTTP error codes.
httpCode (string) --
The HTTP error code.
action (string) --
The action for the error..
loggingTypes (list) --
The error log type.
(string) --
responseLoggingPercentage (float) --
The percentage of response logging.
customerProvidedId (string) --
The customer-provided unique identifier of the link.
linkId (string) --
The unique identifier of the link.
tags (dict) --
A map of the key-value pairs of the tag or tags to assign to the resource.
(string) --
(string) --
nextToken (string) --
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
{'flowModules': {'moduleParameters': {'rateLimiter': {'tps': 'float'}}},
'pendingFlowModules': {'moduleParameters': {'rateLimiter': {'tps': 'float'}}}}
Rejects a link request between RTB applications.
When a requester RTB application requests to link with a responder RTB application, the responder can use this operation to decline the link request.
See also: AWS API Documentation
Request Syntax
client.reject_link(
gatewayId='string',
linkId='string'
)
string
[REQUIRED]
The unique identifier of the gateway.
string
[REQUIRED]
The unique identifier of the link.
dict
Response Syntax
{
'gatewayId': 'string',
'peerGatewayId': 'string',
'status': 'PENDING_CREATION'|'PENDING_REQUEST'|'REQUESTED'|'ACCEPTED'|'ACTIVE'|'REJECTED'|'FAILED'|'PENDING_DELETION'|'DELETED'|'PENDING_UPDATE'|'PENDING_ISOLATION'|'ISOLATED'|'PENDING_RESTORATION',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'direction': 'RESPONSE'|'REQUEST',
'flowModules': [
{
'version': 'string',
'name': 'string',
'dependsOn': [
'string',
],
'moduleParameters': {
'noBid': {
'reason': 'string',
'reasonCode': 123,
'passThroughPercentage': ...
},
'openRtbAttribute': {
'filterType': 'INCLUDE'|'EXCLUDE',
'filterConfiguration': [
{
'criteria': [
{
'path': 'string',
'values': [
'string',
]
},
]
},
],
'action': {
'noBid': {
'noBidReasonCode': 123
},
'headerTag': {
'name': 'string',
'value': 'string'
}
},
'holdbackPercentage': ...
},
'rateLimiter': {
'tps': ...
}
}
},
],
'pendingFlowModules': [
{
'version': 'string',
'name': 'string',
'dependsOn': [
'string',
],
'moduleParameters': {
'noBid': {
'reason': 'string',
'reasonCode': 123,
'passThroughPercentage': ...
},
'openRtbAttribute': {
'filterType': 'INCLUDE'|'EXCLUDE',
'filterConfiguration': [
{
'criteria': [
{
'path': 'string',
'values': [
'string',
]
},
]
},
],
'action': {
'noBid': {
'noBidReasonCode': 123
},
'headerTag': {
'name': 'string',
'value': 'string'
}
},
'holdbackPercentage': ...
},
'rateLimiter': {
'tps': ...
}
}
},
],
'attributes': {
'responderErrorMasking': [
{
'httpCode': 'string',
'action': 'NO_BID'|'PASSTHROUGH',
'loggingTypes': [
'NONE'|'METRIC'|'RESPONSE',
],
'responseLoggingPercentage': ...
},
],
'customerProvidedId': 'string'
},
'linkId': 'string'
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
peerGatewayId (string) --
The unique identifier of the peer gateway.
status (string) --
The status of the link.
createdAt (datetime) --
The timestamp of when the link was created.
updatedAt (datetime) --
The timestamp of when the link was updated.
direction (string) --
The direction of the link.
flowModules (list) --
The configuration of flow modules.
(dict) --
Describes the configuration of a module.
version (string) --
The version of the module.
name (string) --
The name of the module.
dependsOn (list) --
The dependencies of the module.
(string) --
moduleParameters (dict) --
Describes the parameters of a module.
noBid (dict) --
Describes the parameters of a no bid module.
reason (string) --
The reason description.
reasonCode (integer) --
The reason code.
passThroughPercentage (float) --
The pass through percentage.
openRtbAttribute (dict) --
Describes the parameters of an open RTB attribute module.
filterType (string) --
The filter type.
filterConfiguration (list) --
Describes the configuration of a filter.
(dict) --
Describes the configuration of a filter.
criteria (list) --
Describes the criteria for a filter.
(dict) --
Describes the criteria for a filter.
path (string) --
The path to filter.
values (list) --
The value to filter.
(string) --
action (dict) --
Describes a bid action.
noBid (dict) --
Describes a no bid action.
noBidReasonCode (integer) --
The reason code for the no bid action.
headerTag (dict) --
Describes the header tag for a bid action.
name (string) --
The name of the bid action.
value (string) --
The value of the bid action.
holdbackPercentage (float) --
The hold back percentage.
rateLimiter (dict) --
Describes the parameters of a rate limit.
tps (float) --
The transactions per second rate limit.
pendingFlowModules (list) --
The configuration of pending flow modules.
(dict) --
Describes the configuration of a module.
version (string) --
The version of the module.
name (string) --
The name of the module.
dependsOn (list) --
The dependencies of the module.
(string) --
moduleParameters (dict) --
Describes the parameters of a module.
noBid (dict) --
Describes the parameters of a no bid module.
reason (string) --
The reason description.
reasonCode (integer) --
The reason code.
passThroughPercentage (float) --
The pass through percentage.
openRtbAttribute (dict) --
Describes the parameters of an open RTB attribute module.
filterType (string) --
The filter type.
filterConfiguration (list) --
Describes the configuration of a filter.
(dict) --
Describes the configuration of a filter.
criteria (list) --
Describes the criteria for a filter.
(dict) --
Describes the criteria for a filter.
path (string) --
The path to filter.
values (list) --
The value to filter.
(string) --
action (dict) --
Describes a bid action.
noBid (dict) --
Describes a no bid action.
noBidReasonCode (integer) --
The reason code for the no bid action.
headerTag (dict) --
Describes the header tag for a bid action.
name (string) --
The name of the bid action.
value (string) --
The value of the bid action.
holdbackPercentage (float) --
The hold back percentage.
rateLimiter (dict) --
Describes the parameters of a rate limit.
tps (float) --
The transactions per second rate limit.
attributes (dict) --
Attributes of the link.
responderErrorMasking (list) --
Describes the masking for HTTP error codes.
(dict) --
Describes the masking for HTTP error codes.
httpCode (string) --
The HTTP error code.
action (string) --
The action for the error..
loggingTypes (list) --
The error log type.
(string) --
responseLoggingPercentage (float) --
The percentage of response logging.
customerProvidedId (string) --
The customer-provided unique identifier of the link.
linkId (string) --
The unique identifier of the link.
{'modules': {'moduleParameters': {'rateLimiter': {'tps': 'float'}}}}
Updates a link module flow.
See also: AWS API Documentation
Request Syntax
client.update_link_module_flow(
clientToken='string',
gatewayId='string',
linkId='string',
modules=[
{
'version': 'string',
'name': 'string',
'dependsOn': [
'string',
],
'moduleParameters': {
'noBid': {
'reason': 'string',
'reasonCode': 123,
'passThroughPercentage': ...
},
'openRtbAttribute': {
'filterType': 'INCLUDE'|'EXCLUDE',
'filterConfiguration': [
{
'criteria': [
{
'path': 'string',
'values': [
'string',
]
},
]
},
],
'action': {
'noBid': {
'noBidReasonCode': 123
},
'headerTag': {
'name': 'string',
'value': 'string'
}
},
'holdbackPercentage': ...
},
'rateLimiter': {
'tps': ...
}
}
},
]
)
string
[REQUIRED]
The unique client token.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier of the gateway.
string
[REQUIRED]
The unique identifier of the link.
list
[REQUIRED]
The configuration of a module.
(dict) --
Describes the configuration of a module.
version (string) --
The version of the module.
name (string) -- [REQUIRED]
The name of the module.
dependsOn (list) --
The dependencies of the module.
(string) --
moduleParameters (dict) --
Describes the parameters of a module.
noBid (dict) --
Describes the parameters of a no bid module.
reason (string) --
The reason description.
reasonCode (integer) --
The reason code.
passThroughPercentage (float) --
The pass through percentage.
openRtbAttribute (dict) --
Describes the parameters of an open RTB attribute module.
filterType (string) -- [REQUIRED]
The filter type.
filterConfiguration (list) -- [REQUIRED]
Describes the configuration of a filter.
(dict) --
Describes the configuration of a filter.
criteria (list) -- [REQUIRED]
Describes the criteria for a filter.
(dict) --
Describes the criteria for a filter.
path (string) -- [REQUIRED]
The path to filter.
values (list) -- [REQUIRED]
The value to filter.
(string) --
action (dict) -- [REQUIRED]
Describes a bid action.
noBid (dict) --
Describes a no bid action.
noBidReasonCode (integer) --
The reason code for the no bid action.
headerTag (dict) --
Describes the header tag for a bid action.
name (string) -- [REQUIRED]
The name of the bid action.
value (string) -- [REQUIRED]
The value of the bid action.
holdbackPercentage (float) -- [REQUIRED]
The hold back percentage.
rateLimiter (dict) --
Describes the parameters of a rate limit.
tps (float) --
The transactions per second rate limit.
dict
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.