2025/10/22 - RTBFabric - 27 new api methods
Changes Update for general availability of AWS RTB Fabric service.
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': ...
}
}
},
],
'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': ...
}
}
},
],
'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.
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.
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.
Creates an outbound external link.
See also: AWS API Documentation
Request Syntax
client.create_outbound_external_link(
clientToken='string',
gatewayId='string',
publicEndpoint='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique client token.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier of the gateway.
string
[REQUIRED]
The public endpoint of the link.
dict
A map of the key-value pairs of the tag or tags to assign to the resource.
(string) --
(string) --
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.
Deletes a link between RTB applications.
Permanently removes the connection between RTB applications. This action cannot be undone.
See also: AWS API Documentation
Request Syntax
client.delete_link(
gatewayId='string',
linkId='string'
)
string
[REQUIRED]
The unique identifier of the gateway.
string
[REQUIRED]
The unique identifier of the link.
dict
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.
Deletes a requester gateway.
See also: AWS API Documentation
Request Syntax
client.delete_requester_gateway(
gatewayId='string'
)
string
[REQUIRED]
The unique identifier of the gateway.
dict
Response Syntax
{
'gatewayId': 'string',
'status': 'PENDING_CREATION'|'ACTIVE'|'PENDING_DELETION'|'DELETED'|'ERROR'|'PENDING_UPDATE'|'ISOLATED'|'PENDING_ISOLATION'|'PENDING_RESTORATION'
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
status (string) --
The status of the request.
Updates a responder gateway.
See also: AWS API Documentation
Request Syntax
client.update_responder_gateway(
domainName='string',
port=123,
protocol='HTTP'|'HTTPS',
trustStoreConfiguration={
'certificateAuthorityCertificates': [
'string',
]
},
managedEndpointConfiguration={
'autoScalingGroups': {
'autoScalingGroupNames': [
'string',
],
'roleArn': 'string'
},
'eksEndpoints': {
'endpointsResourceName': 'string',
'endpointsResourceNamespace': 'string',
'clusterApiServerEndpointUri': 'string',
'clusterApiServerCaCertificateChain': 'string',
'clusterName': 'string',
'roleArn': 'string'
}
},
clientToken='string',
gatewayId='string',
description='string'
)
string
The domain name for the responder gateway.
integer
[REQUIRED]
The networking port to use.
string
[REQUIRED]
The networking protocol to use.
dict
The configuration of the trust store.
certificateAuthorityCertificates (list) -- [REQUIRED]
The certificate authority certificate.
(string) --
dict
The configuration for the managed endpoint.
autoScalingGroups (dict) --
Describes the configuration of an auto scaling group.
autoScalingGroupNames (list) -- [REQUIRED]
The names of the auto scaling group.
(string) --
roleArn (string) -- [REQUIRED]
The role ARN of the auto scaling group.
eksEndpoints (dict) --
Describes the configuration of an Amazon Elastic Kubernetes Service endpoint.
endpointsResourceName (string) -- [REQUIRED]
The name of the endpoint resource.
endpointsResourceNamespace (string) -- [REQUIRED]
The namespace of the endpoint resource.
clusterApiServerEndpointUri (string) -- [REQUIRED]
The URI of the cluster API server endpoint.
clusterApiServerCaCertificateChain (string) -- [REQUIRED]
The CA certificate chain of the cluster API server.
clusterName (string) -- [REQUIRED]
The name of the cluster.
roleArn (string) -- [REQUIRED]
The role ARN for the cluster.
string
[REQUIRED]
The unique client token.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier of the gateway.
string
An optional description for the responder gateway.
dict
Response Syntax
{
'gatewayId': 'string',
'status': 'PENDING_CREATION'|'ACTIVE'|'PENDING_DELETION'|'DELETED'|'ERROR'|'PENDING_UPDATE'|'ISOLATED'|'PENDING_ISOLATION'|'PENDING_RESTORATION'
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
status (string) --
The status of the request.
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': ...
}
}
},
],
'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': ...
}
}
},
],
'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.
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.
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.
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': ...
}
}
},
]
)
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.
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.
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': ...
}
}
},
],
'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': ...
}
}
},
],
'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.
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.
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.
Creates a responder gateway.
See also: AWS API Documentation
Request Syntax
client.create_responder_gateway(
vpcId='string',
subnetIds=[
'string',
],
securityGroupIds=[
'string',
],
domainName='string',
port=123,
protocol='HTTP'|'HTTPS',
trustStoreConfiguration={
'certificateAuthorityCertificates': [
'string',
]
},
managedEndpointConfiguration={
'autoScalingGroups': {
'autoScalingGroupNames': [
'string',
],
'roleArn': 'string'
},
'eksEndpoints': {
'endpointsResourceName': 'string',
'endpointsResourceNamespace': 'string',
'clusterApiServerEndpointUri': 'string',
'clusterApiServerCaCertificateChain': 'string',
'clusterName': 'string',
'roleArn': 'string'
}
},
clientToken='string',
description='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique identifier of the Virtual Private Cloud (VPC).
list
[REQUIRED]
The unique identifiers of the subnets.
(string) --
list
[REQUIRED]
The unique identifiers of the security groups.
(string) --
string
The domain name for the responder gateway.
integer
[REQUIRED]
The networking port to use.
string
[REQUIRED]
The networking protocol to use.
dict
The configuration of the trust store.
certificateAuthorityCertificates (list) -- [REQUIRED]
The certificate authority certificate.
(string) --
dict
The configuration for the managed endpoint.
autoScalingGroups (dict) --
Describes the configuration of an auto scaling group.
autoScalingGroupNames (list) -- [REQUIRED]
The names of the auto scaling group.
(string) --
roleArn (string) -- [REQUIRED]
The role ARN of the auto scaling group.
eksEndpoints (dict) --
Describes the configuration of an Amazon Elastic Kubernetes Service endpoint.
endpointsResourceName (string) -- [REQUIRED]
The name of the endpoint resource.
endpointsResourceNamespace (string) -- [REQUIRED]
The namespace of the endpoint resource.
clusterApiServerEndpointUri (string) -- [REQUIRED]
The URI of the cluster API server endpoint.
clusterApiServerCaCertificateChain (string) -- [REQUIRED]
The CA certificate chain of the cluster API server.
clusterName (string) -- [REQUIRED]
The name of the cluster.
roleArn (string) -- [REQUIRED]
The role ARN for the cluster.
string
[REQUIRED]
The unique client token.
This field is autopopulated if not provided.
string
An optional description for the responder gateway.
dict
A map of the key-value pairs of the tag or tags to assign to the resource.
(string) --
(string) --
dict
Response Syntax
{
'gatewayId': 'string',
'status': 'PENDING_CREATION'|'ACTIVE'|'PENDING_DELETION'|'DELETED'|'ERROR'|'PENDING_UPDATE'|'ISOLATED'|'PENDING_ISOLATION'|'PENDING_RESTORATION'
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
status (string) --
The status of the request.
Retrieves information about a requester gateway.
See also: AWS API Documentation
Request Syntax
client.get_requester_gateway(
gatewayId='string'
)
string
[REQUIRED]
The unique identifier of the gateway.
dict
Response Syntax
{
'status': 'PENDING_CREATION'|'ACTIVE'|'PENDING_DELETION'|'DELETED'|'ERROR'|'PENDING_UPDATE'|'ISOLATED'|'PENDING_ISOLATION'|'PENDING_RESTORATION',
'domainName': 'string',
'description': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'vpcId': 'string',
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'gatewayId': 'string',
'tags': {
'string': 'string'
},
'activeLinksCount': 123,
'totalLinksCount': 123
}
Response Structure
(dict) --
status (string) --
The status of the request.
domainName (string) --
The domain name of the requester gateway.
description (string) --
The description of the requester gateway.
createdAt (datetime) --
The timestamp of when the requester gateway was created.
updatedAt (datetime) --
The timestamp of when the requester gateway was updated.
vpcId (string) --
The unique identifier of the Virtual Private Cloud (VPC).
subnetIds (list) --
The unique identifiers of the subnets.
(string) --
securityGroupIds (list) --
The unique identifiers of the security groups.
(string) --
gatewayId (string) --
The unique identifier of the gateway.
tags (dict) --
A map of the key-value pairs for the tag or tags assigned to the specified resource.
(string) --
(string) --
activeLinksCount (integer) --
The count of active links for the requester gateway.
totalLinksCount (integer) --
The total count of links for the requester gateway.
Lists reponder gateways.
See also: AWS API Documentation
Request Syntax
client.list_responder_gateways(
maxResults=123,
nextToken='string'
)
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.
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.
dict
Response Syntax
{
'gatewayIds': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
gatewayIds (list) --
The unique identifier of the gateways.
(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.
Updates the configuration of a link between RTB applications.
Allows you to modify settings and parameters for an existing link.
See also: AWS API Documentation
Request Syntax
client.update_link(
gatewayId='string',
linkId='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
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
{
'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.
Updates a requester gateway.
See also: AWS API Documentation
Request Syntax
client.update_requester_gateway(
clientToken='string',
gatewayId='string',
description='string'
)
string
[REQUIRED]
The unique client token.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier of the gateway.
string
An optional description for the requester gateway.
dict
Response Syntax
{
'gatewayId': 'string',
'status': 'PENDING_CREATION'|'ACTIVE'|'PENDING_DELETION'|'DELETED'|'ERROR'|'PENDING_UPDATE'|'ISOLATED'|'PENDING_ISOLATION'|'PENDING_RESTORATION'
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
status (string) --
The status of the request.
Retrieves information about a responder gateway.
See also: AWS API Documentation
Request Syntax
client.get_responder_gateway(
gatewayId='string'
)
string
[REQUIRED]
The unique identifier of the gateway.
dict
Response Syntax
{
'vpcId': 'string',
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'status': 'PENDING_CREATION'|'ACTIVE'|'PENDING_DELETION'|'DELETED'|'ERROR'|'PENDING_UPDATE'|'ISOLATED'|'PENDING_ISOLATION'|'PENDING_RESTORATION',
'description': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'domainName': 'string',
'port': 123,
'protocol': 'HTTP'|'HTTPS',
'trustStoreConfiguration': {
'certificateAuthorityCertificates': [
'string',
]
},
'managedEndpointConfiguration': {
'autoScalingGroups': {
'autoScalingGroupNames': [
'string',
],
'roleArn': 'string'
},
'eksEndpoints': {
'endpointsResourceName': 'string',
'endpointsResourceNamespace': 'string',
'clusterApiServerEndpointUri': 'string',
'clusterApiServerCaCertificateChain': 'string',
'clusterName': 'string',
'roleArn': 'string'
}
},
'gatewayId': 'string',
'tags': {
'string': 'string'
},
'activeLinksCount': 123,
'totalLinksCount': 123,
'inboundLinksCount': 123
}
Response Structure
(dict) --
vpcId (string) --
The unique identifier of the Virtual Private Cloud (VPC).
subnetIds (list) --
The unique identifiers of the subnets.
(string) --
securityGroupIds (list) --
The unique identifiers of the security groups.
(string) --
status (string) --
The status of the request.
description (string) --
The description of the responder gateway.
createdAt (datetime) --
The timestamp of when the responder gateway was created.
updatedAt (datetime) --
The timestamp of when the responder gateway was updated.
domainName (string) --
The domain name of the responder gateway.
port (integer) --
The networking port.
protocol (string) --
The networking protocol.
trustStoreConfiguration (dict) --
The configuration of the trust store.
certificateAuthorityCertificates (list) --
The certificate authority certificate.
(string) --
managedEndpointConfiguration (dict) --
The configuration of the managed endpoint.
autoScalingGroups (dict) --
Describes the configuration of an auto scaling group.
autoScalingGroupNames (list) --
The names of the auto scaling group.
(string) --
roleArn (string) --
The role ARN of the auto scaling group.
eksEndpoints (dict) --
Describes the configuration of an Amazon Elastic Kubernetes Service endpoint.
endpointsResourceName (string) --
The name of the endpoint resource.
endpointsResourceNamespace (string) --
The namespace of the endpoint resource.
clusterApiServerEndpointUri (string) --
The URI of the cluster API server endpoint.
clusterApiServerCaCertificateChain (string) --
The CA certificate chain of the cluster API server.
clusterName (string) --
The name of the cluster.
roleArn (string) --
The role ARN for the cluster.
gatewayId (string) --
The unique identifier of the gateway.
tags (dict) --
A map of the key-value pairs for the tag or tags assigned to the specified resource.
(string) --
(string) --
activeLinksCount (integer) --
The count of active links for the responder gateway.
totalLinksCount (integer) --
The total count of links for the responder gateway.
inboundLinksCount (integer) --
The count of inbound links for the responder gateway.
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': ...
}
}
},
],
'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': ...
}
}
},
],
'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.
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.
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.
Deletes an inbound external link.
See also: AWS API Documentation
Request Syntax
client.delete_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
{
'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.
Deletes an outbound external link.
See also: AWS API Documentation
Request Syntax
client.delete_outbound_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
{
'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.
Lists tags for a resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
A map of the key-value pairs for the tag or tags assigned to the specified resource.
(string) --
(string) --
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': ...
}
}
},
],
'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': ...
}
}
},
],
'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.
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.
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) --
Assigns one or more tags (key-value pairs) to the specified resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you want to tag.
dict
[REQUIRED]
A map of the key-value pairs of the tag or tags to assign to the resource.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a responder gateway.
See also: AWS API Documentation
Request Syntax
client.delete_responder_gateway(
gatewayId='string'
)
string
[REQUIRED]
The unique identifier of the gateway.
dict
Response Syntax
{
'gatewayId': 'string',
'status': 'PENDING_CREATION'|'ACTIVE'|'PENDING_DELETION'|'DELETED'|'ERROR'|'PENDING_UPDATE'|'ISOLATED'|'PENDING_ISOLATION'|'PENDING_RESTORATION'
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
status (string) --
The status of the request.
Creates a requester gateway.
See also: AWS API Documentation
Request Syntax
client.create_requester_gateway(
vpcId='string',
subnetIds=[
'string',
],
securityGroupIds=[
'string',
],
clientToken='string',
description='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique identifier of the Virtual Private Cloud (VPC).
list
[REQUIRED]
The unique identifiers of the subnets.
(string) --
list
[REQUIRED]
The unique identifiers of the security groups.
(string) --
string
[REQUIRED]
The unique client token.
This field is autopopulated if not provided.
string
An optional description for the requester gateway.
dict
A map of the key-value pairs of the tag or tags to assign to the resource.
(string) --
(string) --
dict
Response Syntax
{
'gatewayId': 'string',
'domainName': 'string',
'status': 'PENDING_CREATION'|'ACTIVE'|'PENDING_DELETION'|'DELETED'|'ERROR'|'PENDING_UPDATE'|'ISOLATED'|'PENDING_ISOLATION'|'PENDING_RESTORATION'
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
domainName (string) --
The domain name of the requester gateway.
status (string) --
The status of the request.
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': ...
}
}
},
],
'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': ...
}
}
},
],
'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.
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.
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.
Lists requester gateways.
See also: AWS API Documentation
Request Syntax
client.list_requester_gateways(
maxResults=123,
nextToken='string'
)
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.
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.
dict
Response Syntax
{
'gatewayIds': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
gatewayIds (list) --
The unique identifier of the gateways.
(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.
Retrieves information about an outbound external link.
See also: AWS API Documentation
Request Syntax
client.get_outbound_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',
'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) --
Creates an inbound external link.
See also: AWS API Documentation
Request Syntax
client.create_inbound_external_link(
clientToken='string',
gatewayId='string',
attributes={
'responderErrorMasking': [
{
'httpCode': 'string',
'action': 'NO_BID'|'PASSTHROUGH',
'loggingTypes': [
'NONE'|'METRIC'|'RESPONSE',
],
'responseLoggingPercentage': ...
},
],
'customerProvidedId': 'string'
},
tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique client token.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier of the 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.
dict
A map of the key-value pairs of the tag or tags to assign to the resource.
(string) --
(string) --
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'
}
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.
Removes a tag or tags from a resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you want to untag.
list
[REQUIRED]
The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --