2026/11/19 - RTBFabric - 7 new 28 updated api methods
Changes AWS RTB Fabric now lets you discover modules and attach them to your links. Find modules and their versions with ListAvailableModules, GetAvailableModule, ListAvailableModuleVersions and GetAvailableModuleVersion, attach them with PutLinkFlows and track each change with GetUpdate and ListUpdates.
Returns an ACTIVE or DEPRECATED version of a module that you can attach. If you can't attach the module, or the version is in another status, the operation returns ResourceNotFoundException, the same as for a missing one.
See also: AWS API Documentation
Request Syntax
client.get_available_module_version(
moduleId='string',
version='string'
)
string
[REQUIRED]
The module's ID.
string
[REQUIRED]
The version.
dict
Response Syntax
{
'moduleId': 'string',
'version': 'string',
'moduleVersionArn': 'string',
'status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DEPRECATED',
'permissions': [
'READ_REQUEST_BODY'|'READ_REQUEST_HEADERS'|'MUTATE_REQUEST_BODY'|'ENRICH_REQUEST_HEADERS'|'ENRICH_REQUEST_EXT'|'FILTER',
],
'configurableActions': [
'FILTER'|'ENRICH_REQUEST_EXT'|'ENRICH_REQUEST_HEADERS'|'OBSERVE',
],
'configurationSchema': 'string',
'releaseNotes': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
moduleId (string) --
The module's ID.
version (string) --
The version.
moduleVersionArn (string) --
The version's ARN.
status (string) --
ACTIVE or DEPRECATED.
permissions (list) --
The data-access grants the version holds.
(string) --
A data-access grant that a version holds.
configurableActions (list) --
The capabilities that you can turn on when you attach the version.
(string) --
A capability that you can turn on when you attach a version, such as FILTER or OBSERVE. Each capability needs a minimum permission.
configurationSchema (string) --
The JSON Schema for the parameters that you can set in configurationValues when you attach the version.
releaseNotes (string) --
The vendor's release notes.
createdAt (datetime) --
The time when the version was created.
updatedAt (datetime) --
The time when the version last changed.
Lists the modules that you can attach, newest first by createdAt. Results are paginated. Use nextToken to get the next page.
See also: AWS API Documentation
Request Syntax
client.list_available_modules(
subscriptionType='MARKETPLACE'|'PRIVATE'|'AWS_BUILT_IN',
maxResults=123,
nextToken='string'
)
string
Lists only modules that you have access to this way.
integer
The maximum number of results for each page, from 1 to 10. The default is 10.
string
If nextToken is returned, there are more results available. 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 token fails with ValidationException.
dict
Response Syntax
{
'modules': [
{
'moduleId': 'string',
'moduleArn': 'string',
'moduleName': 'string',
'subscriptionType': 'MARKETPLACE'|'PRIVATE'|'AWS_BUILT_IN',
'subscriptionStatus': 'ACTIVE'|'EXPIRED',
'marketplaceProductId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
modules (list) --
The modules on this page, newest first.
(dict) --
A module that you can attach, as ListAvailableModules returns it. ListAvailableModules and GetAvailableModule never return how a module is implemented.
moduleId (string) --
The module's ID.
moduleArn (string) --
The module's ARN.
moduleName (string) --
A label, not unique: modules can share a name.
subscriptionType (string) --
The type of access that you have to the module.
subscriptionStatus (string) --
Specifies whether your access to the module is current.
marketplaceProductId (string) --
The Marketplace product the module is sold under. Present only when subscriptionType is MARKETPLACE.
nextToken (string) --
If nextToken is returned, there are more results available. 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 token fails with ValidationException.
Replaces a link's flow configuration. The change applies asynchronously. The call returns once the change is accepted, and the link serves its prior flows until the update commits atomically. RTB Fabric validates the request before accepting it, and a request that fails validation changes nothing. After the call, use GetLink. Once the change completes, the link's status is ACTIVE again and its flows show the change.
See also: AWS API Documentation
Request Syntax
client.put_link_flows(
gatewayId='string',
linkId='string',
clientToken='string',
lockToken='string',
flows=[
{
'name': 'string',
'pipeline': {
'sequential': {
'modules': [
{
'name': 'string',
'moduleVersionArn': 'string',
'selectedActions': [
'FILTER'|'ENRICH_REQUEST_EXT'|'ENRICH_REQUEST_HEADERS'|'OBSERVE',
],
'failureMode': 'OPEN'|'CLOSED',
'activationPercentage': ...,
'configurationValues': 'string'
},
]
},
'phased': {
'phases': [
{
'modules': [
{
'name': 'string',
'moduleVersionArn': 'string',
'selectedActions': [
'FILTER'|'ENRICH_REQUEST_EXT'|'ENRICH_REQUEST_HEADERS'|'OBSERVE',
],
'failureMode': 'OPEN'|'CLOSED',
'activationPercentage': ...,
'configurationValues': 'string'
},
]
},
]
}
}
},
]
)
string
[REQUIRED]
The unique identifier of the gateway.
string
[REQUIRED]
The unique identifier of the link.
string
A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you retry with the same token and parameters, you get the original response without an error. If you retry with the same token but different parameters, the call fails with ValidationException. If you don't provide a token, the SDK generates one, and RTB Fabric remembers it for 8 hours. A retry returns the original updateId before lockToken is checked.
This field is autopopulated if not provided.
string
[REQUIRED]
The concurrency token that you read from GetLink. If the link changed since that read, by any operation, the call fails with ConflictException.
list
[REQUIRED]
The link's flows, replacing the current ones. An empty list removes every flow.
(dict) --
One flow on a link: a set of modules that runs on the link's bid requests.
name (string) -- [REQUIRED]
The flow's name, unique within the link.
pipeline (dict) -- [REQUIRED]
The pipeline that the flow's modules run in. In a sequential pipeline, each module sees the previous module's output. In a phased pipeline, a phase's modules see the prior phase's output, not each other's.
sequential (dict) --
Modules run in list order. Use it when each module needs the previous module's output.
modules (list) -- [REQUIRED]
In execution order.
(dict) --
A version attached to a flow, with its settings.
name (string) -- [REQUIRED]
The module's name, unique within the flow.
moduleVersionArn (string) -- [REQUIRED]
The version to attach. It must be ACTIVE and available to you (see ListAvailableModuleVersions). You can keep a version that's already in the link's flows after it's deprecated, but you can't give it a higher share of traffic.
selectedActions (list) --
The capabilities to turn on, chosen from the version's configurableActions. If the version exposes one, it's the default. If the version exposes more than one, this field is required. If it exposes none, omit this field.
(string) --
A capability that you can turn on when you attach a version, such as FILTER or OBSERVE. Each capability needs a minimum permission.
failureMode (string) --
Specifies what happens when the module fails – when its call fails or times out, or when an express module's dataset is stale. The default is OPEN.
activationPercentage (float) --
The percentage of the flow's requests that the module runs on. The flow skips the module on the rest of the requests. The default is 100.
configurationValues (string) --
RTB Fabric validates the value against the version's configurationSchema and rejects a value that fails with ValidationException. Omit it when the schema is empty or fully defaulted.
phased (dict) --
Phases run in order; a phase's modules run concurrently on the same input. Use it when a phase's modules don't depend on each other.
phases (list) -- [REQUIRED]
At most 8 modules in total across the phases; more fails with ValidationException.
(dict) --
One phase of a phased pipeline. Its modules run concurrently on the previous phase's output.
modules (list) -- [REQUIRED]
At most one MUTATE_REQUEST_BODY module.
(dict) --
A version attached to a flow, with its settings.
name (string) -- [REQUIRED]
The module's name, unique within the flow.
moduleVersionArn (string) -- [REQUIRED]
The version to attach. It must be ACTIVE and available to you (see ListAvailableModuleVersions). You can keep a version that's already in the link's flows after it's deprecated, but you can't give it a higher share of traffic.
selectedActions (list) --
The capabilities to turn on, chosen from the version's configurableActions. If the version exposes one, it's the default. If the version exposes more than one, this field is required. If it exposes none, omit this field.
(string) --
A capability that you can turn on when you attach a version, such as FILTER or OBSERVE. Each capability needs a minimum permission.
failureMode (string) --
Specifies what happens when the module fails – when its call fails or times out, or when an express module's dataset is stale. The default is OPEN.
activationPercentage (float) --
The percentage of the flow's requests that the module runs on. The flow skips the module on the rest of the requests. The default is 100.
configurationValues (string) --
RTB Fabric validates the value against the version's configurationSchema and rejects a value that fails with ValidationException. Omit it when the schema is empty or fully defaulted.
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'|'CREATE_FAILED'|'DELETE_FAILED',
'updateId': 'string'
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
linkId (string) --
The unique identifier of the link.
status (string) --
The link's status. A successful call returns PENDING_UPDATE, and the link serves its prior flows until the change completes.
updateId (string) --
The ID of the update this call started.
Lists the ACTIVE and DEPRECATED versions of a module that you can attach, highest version first (numerically by MAJOR, then MINOR, then PATCH). If you can't attach the module, the operation returns ResourceNotFoundException, the same as for a missing one. If the module has no ACTIVE or DEPRECATED versions, the operation returns an empty list. The operation lists DEPRECATED versions so that you can inspect one that you've attached, but you can't attach them. Results are paginated. Use nextToken to get the next page.
See also: AWS API Documentation
Request Syntax
client.list_available_module_versions(
moduleId='string',
status='CREATING'|'CREATE_FAILED'|'ACTIVE'|'DEPRECATED',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The module's ID.
string
Lists only versions in this status. Only ACTIVE and DEPRECATED versions are listed, so another value returns an empty list.
integer
The maximum number of results for each page, from 1 to 10. The default is 10.
string
If nextToken is returned, there are more results available. 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 token fails with ValidationException.
dict
Response Syntax
{
'moduleId': 'string',
'versions': [
{
'version': 'string',
'moduleVersionArn': 'string',
'status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DEPRECATED',
'createdAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
moduleId (string) --
The module's ID.
versions (list) --
The versions on this page, highest version first.
(dict) --
A version of a module that you can attach, as ListAvailableModuleVersions returns it. ListAvailableModuleVersions and GetAvailableModuleVersion never return how a version is implemented.
version (string) --
The version.
moduleVersionArn (string) --
The version's ARN.
status (string) --
ACTIVE or DEPRECATED.
createdAt (datetime) --
The time when the version was created.
nextToken (string) --
If nextToken is returned, there are more results available. 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 token fails with ValidationException.
Returns ResourceNotFoundException for an updateId past the 90-day retention window, indistinguishable in the response from an id that never existed.
See also: AWS API Documentation
Request Syntax
client.get_update(
gatewayId='string',
updateId='string'
)
string
[REQUIRED]
The unique identifier of the gateway.
string
[REQUIRED]
The unique identifier of the update.
dict
Response Syntax
{
'update': {
'updateId': 'string',
'type': 'GATEWAY_CONFIG_UPDATE'|'LINK_CONFIG_UPDATE'|'LINK_FLOW_UPDATE'|'ROUTING_RULE_UPDATE',
'status': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED',
'target': {
'gateway': {},
'link': {
'linkId': 'string'
},
'routingRule': {
'linkId': 'string',
'ruleId': 'string'
}
},
'createdAt': datetime(2015, 1, 1),
'parameters': {
'responderGatewayConfig': {
'description': 'string',
'clientRoutingPolicy': 'AVAILABILITY_ZONE_AFFINITY'|'ANY_AVAILABILITY_ZONE',
'domainName': 'string',
'port': 123,
'protocol': 'HTTP'|'HTTPS',
'listenerConfig': {
'protocols': [
'HTTP'|'HTTPS',
]
},
'trustStoreConfiguration': {
'certificateAuthorityCertificates': [
'string',
]
},
'managedEndpointConfiguration': {
'autoScalingGroups': {
'autoScalingGroupNames': [
'string',
],
'roleArn': 'string',
'healthCheckConfig': {
'port': 123,
'path': 'string',
'protocol': 'HTTP'|'HTTPS',
'timeoutMs': 123,
'intervalSeconds': 123,
'statusCodeMatcher': 'string',
'healthyThresholdCount': 123,
'unhealthyThresholdCount': 123
}
},
'eksEndpoints': {
'endpointsResourceName': 'string',
'endpointsResourceNamespace': 'string',
'clusterApiServerEndpointUri': 'string',
'clusterApiServerCaCertificateChain': 'string',
'clusterName': 'string',
'roleArn': 'string'
}
}
},
'linkConfig': {
'logSettings': {
'applicationLogs': {
'sampling': {
'errorLog': 123.0,
'filterLog': 123.0
}
}
},
'timeoutInMillis': 123
},
'linkFlow': {
'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': ...
}
}
},
],
'flows': [
{
'name': 'string',
'pipeline': {
'sequential': {
'modules': [
{
'name': 'string',
'moduleVersionArn': 'string',
'selectedActions': [
'FILTER'|'ENRICH_REQUEST_EXT'|'ENRICH_REQUEST_HEADERS'|'OBSERVE',
],
'failureMode': 'OPEN'|'CLOSED',
'activationPercentage': ...,
'configurationValues': 'string'
},
]
},
'phased': {
'phases': [
{
'modules': [
{
'name': 'string',
'moduleVersionArn': 'string',
'selectedActions': [
'FILTER'|'ENRICH_REQUEST_EXT'|'ENRICH_REQUEST_HEADERS'|'OBSERVE',
],
'failureMode': 'OPEN'|'CLOSED',
'activationPercentage': ...,
'configurationValues': 'string'
},
]
},
]
}
}
},
]
},
'routingRule': {
'priority': 123,
'conditions': {
'hostHeader': 'string',
'hostHeaderWildcard': 'string',
'pathPrefix': 'string',
'pathExact': 'string',
'queryStringEquals': {
'key': 'string',
'value': 'string'
},
'queryStringExists': 'string'
}
}
},
'errorDetails': [
{
'code': 'VPC_NOT_FOUND'|'EC2_SUBNET_NOT_FOUND'|'EC2_SECURITY_GROUP_NOT_FOUND'|'EC2_SUBNET_IP_EXHAUSTION'|'IAM_ASSUME_ROLE_ACCESS_DENIED'|'INTERNAL_ERROR',
'message': 'string',
'resourceIds': [
'string',
]
},
]
}
}
Response Structure
(dict) --
update (dict) --
The update.
updateId (string) --
The unique identifier of the update.
type (string) --
The type of change.
status (string) --
The status of the update.
target (dict) --
The resource that the update targeted.
gateway (dict) --
The gateway itself.
link (dict) --
A link on the gateway.
linkId (string) --
The unique identifier of the link.
routingRule (dict) --
A routing rule on one of the gateway's links.
linkId (string) --
The unique identifier of the rule's link.
ruleId (string) --
Identifier for a routing rule
createdAt (datetime) --
The timestamp of when the update was created.
parameters (dict) --
The changes that the update requested.
responderGatewayConfig (dict) --
The requested responder gateway configuration.
description (string) --
The gateway's description.
clientRoutingPolicy (string) --
The gateway's client routing policy.
domainName (string) --
The gateway's domain name.
port (integer) --
The networking port.
protocol (string) --
The networking protocol.
listenerConfig (dict) --
Listener configuration for the protocols (HTTP, HTTPS, or both) accepted by the gateway.
protocols (list) --
The protocol for connections from clients to the gateway
(string) --
trustStoreConfiguration (dict) --
Describes the configuration of a trust store.
certificateAuthorityCertificates (list) --
The certificate authority certificate.
(string) --
managedEndpointConfiguration (dict) --
Describes the configuration of a 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.
healthCheckConfig (dict) --
The health check configuration for the Auto Scaling group managed endpoint.
port (integer) --
The port to use for health check probes. Valid range is 80 to 65535.
path (string) --
The destination path for the health check request. Must start with /.
protocol (string) --
The protocol to use for health check probes.
timeoutMs (integer) --
The timeout for each health check probe, in milliseconds. Valid range is 100 to 5000.
intervalSeconds (integer) --
The interval between health check probes, in seconds. Valid range is 5 to 60.
statusCodeMatcher (string) --
The expected HTTP status code or status code pattern from healthy instances. Supports a single code (for example, 200), a range (for example, 200-299), or a comma-separated list (for example, 200,204).
healthyThresholdCount (integer) --
The number of consecutive successful health checks required before an instance is considered healthy. Valid range is 2 to 10.
unhealthyThresholdCount (integer) --
The number of consecutive failed health checks required before an instance is considered unhealthy. Valid range is 2 to 10.
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.
linkConfig (dict) --
The requested link configuration.
logSettings (dict) --
Describes the settings for a link log.
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.
timeoutInMillis (integer) --
The timeout value in milliseconds.
linkFlow (dict) --
The requested link flow.
modules (list) --
The requested 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.
flows (list) --
A link's flows: at most one.
(dict) --
One flow on a link: a set of modules that runs on the link's bid requests.
name (string) --
The flow's name, unique within the link.
pipeline (dict) --
The pipeline that the flow's modules run in. In a sequential pipeline, each module sees the previous module's output. In a phased pipeline, a phase's modules see the prior phase's output, not each other's.
sequential (dict) --
Modules run in list order. Use it when each module needs the previous module's output.
modules (list) --
In execution order.
(dict) --
A version attached to a flow, with its settings.
name (string) --
The module's name, unique within the flow.
moduleVersionArn (string) --
The version to attach. It must be ACTIVE and available to you (see ListAvailableModuleVersions). You can keep a version that's already in the link's flows after it's deprecated, but you can't give it a higher share of traffic.
selectedActions (list) --
The capabilities to turn on, chosen from the version's configurableActions. If the version exposes one, it's the default. If the version exposes more than one, this field is required. If it exposes none, omit this field.
(string) --
A capability that you can turn on when you attach a version, such as FILTER or OBSERVE. Each capability needs a minimum permission.
failureMode (string) --
Specifies what happens when the module fails – when its call fails or times out, or when an express module's dataset is stale. The default is OPEN.
activationPercentage (float) --
The percentage of the flow's requests that the module runs on. The flow skips the module on the rest of the requests. The default is 100.
configurationValues (string) --
RTB Fabric validates the value against the version's configurationSchema and rejects a value that fails with ValidationException. Omit it when the schema is empty or fully defaulted.
phased (dict) --
Phases run in order; a phase's modules run concurrently on the same input. Use it when a phase's modules don't depend on each other.
phases (list) --
At most 8 modules in total across the phases; more fails with ValidationException.
(dict) --
One phase of a phased pipeline. Its modules run concurrently on the previous phase's output.
modules (list) --
At most one MUTATE_REQUEST_BODY module.
(dict) --
A version attached to a flow, with its settings.
name (string) --
The module's name, unique within the flow.
moduleVersionArn (string) --
The version to attach. It must be ACTIVE and available to you (see ListAvailableModuleVersions). You can keep a version that's already in the link's flows after it's deprecated, but you can't give it a higher share of traffic.
selectedActions (list) --
The capabilities to turn on, chosen from the version's configurableActions. If the version exposes one, it's the default. If the version exposes more than one, this field is required. If it exposes none, omit this field.
(string) --
A capability that you can turn on when you attach a version, such as FILTER or OBSERVE. Each capability needs a minimum permission.
failureMode (string) --
Specifies what happens when the module fails – when its call fails or times out, or when an express module's dataset is stale. The default is OPEN.
activationPercentage (float) --
The percentage of the flow's requests that the module runs on. The flow skips the module on the rest of the requests. The default is 100.
configurationValues (string) --
RTB Fabric validates the value against the version's configurationSchema and rejects a value that fails with ValidationException. Omit it when the schema is empty or fully defaulted.
routingRule (dict) --
The requested routing rule.
priority (integer) --
WAF-style evaluation priority. Lower number = evaluated first (priority 1 before 10). Gaps are allowed (1, 10, 20 is valid). Must be between 1 and 1000 inclusive. Uniqueness per link among non-deleted rules is enforced at the API layer (HTTP 409 on conflict).
conditions (dict) --
The conditions for a routing rule. All specified fields must match for the rule to apply (AND logic). At least one condition field must be set.
hostHeader (string) --
The exact host header value to match.
hostHeaderWildcard (string) --
A wildcard pattern for host header matching (for example, *.example.com).
pathPrefix (string) --
The path prefix to match. The request path must start with this value. Must start with /.
pathExact (string) --
The exact path to match. Must start with /.
queryStringEquals (dict) --
A query string key-value pair that must be present and match exactly.
key (string) --
The key of the query string parameter to match. Must contain only RFC 3986 unreserved characters.
value (string) --
The value of the query string parameter to match. Must contain only RFC 3986 unreserved characters.
queryStringExists (string) --
A query string key that must be present in the request (any value is accepted).
errorDetails (list) --
The causes of the failure. Present only when the update has failed.
(dict) --
Describes one cause of a failure of a resource or an update, with an error code, a description, and the IDs of the resources involved.
code (string) --
The error code for what failed.
message (string) --
A description of the failure.
resourceIds (list) --
The IDs of the resources involved, such as a subnet or security group.
(string) --
Lists the updates on a gateway. Results are paginated. Use nextToken to get the next page.
See also: AWS API Documentation
Request Syntax
client.list_updates(
gatewayId='string',
linkId='string',
ruleId='string',
type='GATEWAY_CONFIG_UPDATE'|'LINK_CONFIG_UPDATE'|'LINK_FLOW_UPDATE'|'ROUTING_RULE_UPDATE',
status='IN_PROGRESS'|'SUCCESSFUL'|'FAILED',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique identifier of the gateway.
string
The ID of a link on this gateway, to list only that link's updates. Omit both linkId and ruleId to list the gateway's own updates.
string
The ID of a routing rule, to list only that rule's updates. Requires linkId, because you address a rule through its link. A ruleId without linkId fails with ValidationException.
string
Lists only updates of this type.
string
Lists only updates in this status.
string
If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
integer
The maximum number of results to return for each call.
dict
Response Syntax
{
'updates': [
{
'updateId': 'string',
'type': 'GATEWAY_CONFIG_UPDATE'|'LINK_CONFIG_UPDATE'|'LINK_FLOW_UPDATE'|'ROUTING_RULE_UPDATE',
'status': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED',
'createdAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
updates (list) --
The updates on this page.
(dict) --
A summary of an update.
updateId (string) --
The unique identifier of the update.
type (string) --
The type of change.
status (string) --
The status of the update.
createdAt (datetime) --
The timestamp of when the update was created.
nextToken (string) --
If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
Returns a module that you can attach. If you can't attach the module, the operation returns ResourceNotFoundException, the same as for a missing one.
See also: AWS API Documentation
Request Syntax
client.get_available_module(
moduleId='string'
)
string
[REQUIRED]
The module's ID.
dict
Response Syntax
{
'moduleId': 'string',
'moduleArn': 'string',
'moduleName': 'string',
'description': 'string',
'subscriptionType': 'MARKETPLACE'|'PRIVATE'|'AWS_BUILT_IN',
'subscriptionStatus': 'ACTIVE'|'EXPIRED',
'marketplaceProductId': 'string',
'createdAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
moduleId (string) --
The module's ID.
moduleArn (string) --
The module's ARN.
moduleName (string) --
A label, not unique: modules can share a name.
description (string) --
The module's description.
subscriptionType (string) --
The type of access that you have to the module.
subscriptionStatus (string) --
Specifies whether your access to the module is current.
marketplaceProductId (string) --
The Marketplace product the module is sold under. Present only when subscriptionType is MARKETPLACE.
createdAt (datetime) --
The time when the module was created.
{'errorDetails': [{'code': 'VPC_NOT_FOUND | EC2_SUBNET_NOT_FOUND | '
'EC2_SECURITY_GROUP_NOT_FOUND | '
'EC2_SUBNET_IP_EXHAUSTION | '
'IAM_ASSUME_ROLE_ACCESS_DENIED | INTERNAL_ERROR',
'message': 'string',
'resourceIds': ['string']}],
'status': {'DELETE_FAILED', 'CREATE_FAILED'}}
Accepts a link request between gateways.
When a requester gateway requests to link with a responder gateway, 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
}
}
},
timeoutInMillis=123
)
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.
integer
The timeout value in milliseconds.
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'|'CREATE_FAILED'|'DELETE_FAILED',
'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'
},
'logSettings': {
'applicationLogs': {
'sampling': {
'errorLog': 123.0,
'filterLog': 123.0
}
}
},
'connectivityType': 'DEFAULT'|'PUBLIC_INGRESS'|'PUBLIC_EGRESS'|'EXTERNAL_INBOUND',
'errorDetails': [
{
'code': 'VPC_NOT_FOUND'|'EC2_SUBNET_NOT_FOUND'|'EC2_SECURITY_GROUP_NOT_FOUND'|'EC2_SUBNET_IP_EXHAUSTION'|'IAM_ASSUME_ROLE_ACCESS_DENIED'|'INTERNAL_ERROR',
'message': 'string',
'resourceIds': [
'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.
logSettings (dict) --
Describes the settings for a link log.
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.
connectivityType (string) --
The connectivity type of the link.
errorDetails (list) --
The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
(dict) --
Describes one cause of a failure of a resource or an update, with an error code, a description, and the IDs of the resources involved.
code (string) --
The error code for what failed.
message (string) --
A description of the failure.
resourceIds (list) --
The IDs of the resources involved, such as a subnet or security group.
(string) --
linkId (string) --
The unique identifier of the link.
{'status': {'DELETE_FAILED', 'CREATE_FAILED'}}
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'
},
logSettings={
'applicationLogs': {
'sampling': {
'errorLog': 123.0,
'filterLog': 123.0
}
}
},
tags={
'string': 'string'
}
)
string
[REQUIRED]
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
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
[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
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'|'CREATE_FAILED'|'DELETE_FAILED',
'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.
{'errorDetails': [{'code': 'VPC_NOT_FOUND | EC2_SUBNET_NOT_FOUND | '
'EC2_SECURITY_GROUP_NOT_FOUND | '
'EC2_SUBNET_IP_EXHAUSTION | '
'IAM_ASSUME_ROLE_ACCESS_DENIED | INTERNAL_ERROR',
'message': 'string',
'resourceIds': ['string']}],
'status': {'DELETE_FAILED', 'CREATE_FAILED'}}
Creates a new link between gateways.
Establishes a connection that allows gateways 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
}
}
},
timeoutInMillis=123
)
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]
Application log settings for the link. This value is required. Under applicationLogs.sampling, the errorLog and filterLog fields set the percentage of eligible events to log. Valid values range from 0 through 100. To turn off application logs, set both fields to 0, as in {"applicationLogs":{"sampling":{"errorLog":0,"filterLog":0}}}.
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.
integer
The timeout value in milliseconds.
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'|'CREATE_FAILED'|'DELETE_FAILED',
'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'
},
'logSettings': {
'applicationLogs': {
'sampling': {
'errorLog': 123.0,
'filterLog': 123.0
}
}
},
'connectivityType': 'DEFAULT'|'PUBLIC_INGRESS'|'PUBLIC_EGRESS'|'EXTERNAL_INBOUND',
'errorDetails': [
{
'code': 'VPC_NOT_FOUND'|'EC2_SUBNET_NOT_FOUND'|'EC2_SECURITY_GROUP_NOT_FOUND'|'EC2_SUBNET_IP_EXHAUSTION'|'IAM_ASSUME_ROLE_ACCESS_DENIED'|'INTERNAL_ERROR',
'message': 'string',
'resourceIds': [
'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.
logSettings (dict) --
Describes the settings for a link log.
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.
connectivityType (string) --
The connectivity type of the link.
errorDetails (list) --
The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
(dict) --
Describes one cause of a failure of a resource or an update, with an error code, a description, and the IDs of the resources involved.
code (string) --
The error code for what failed.
message (string) --
A description of the failure.
resourceIds (list) --
The IDs of the resources involved, such as a subnet or security group.
(string) --
linkId (string) --
The unique identifier of the link.
customerProvidedId (string) --
The customer-provided unique identifier of the link.
{'status': {'CREATE_FAILED', 'DELETE_FAILED'}}
Creates a routing rule for a link.
Routing rules use priority-based evaluation where lower priority numbers are evaluated first. Each rule specifies conditions that must all match for the rule to apply.
See also: AWS API Documentation
Request Syntax
client.create_link_routing_rule(
clientToken='string',
gatewayId='string',
linkId='string',
priority=123,
conditions={
'hostHeader': 'string',
'hostHeaderWildcard': 'string',
'pathPrefix': 'string',
'pathExact': 'string',
'queryStringEquals': {
'key': 'string',
'value': 'string'
},
'queryStringExists': 'string'
},
tags={
'string': 'string'
}
)
string
[REQUIRED]
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier of the gateway.
string
[REQUIRED]
The unique identifier of the link.
integer
[REQUIRED]
The priority of the routing rule. Lower numbers are evaluated first. Valid values are 1 to 1000. Priority must be unique among non-deleted rules within a link.
dict
[REQUIRED]
The conditions for the routing rule. All specified fields must match for the rule to apply. At least one condition field must be set.
hostHeader (string) --
The exact host header value to match.
hostHeaderWildcard (string) --
A wildcard pattern for host header matching (for example, *.example.com).
pathPrefix (string) --
The path prefix to match. The request path must start with this value. Must start with /.
pathExact (string) --
The exact path to match. Must start with /.
queryStringEquals (dict) --
A query string key-value pair that must be present and match exactly.
key (string) -- [REQUIRED]
The key of the query string parameter to match. Must contain only RFC 3986 unreserved characters.
value (string) -- [REQUIRED]
The value of the query string parameter to match. Must contain only RFC 3986 unreserved characters.
queryStringExists (string) --
A query string key that must be present in the request (any value is accepted).
dict
A map of the key-value pairs of the tag or tags to assign to the resource.
(string) --
(string) --
dict
Response Syntax
{
'ruleId': 'string',
'status': 'CREATION_IN_PROGRESS'|'ACTIVE'|'UPDATE_IN_PROGRESS'|'DELETION_IN_PROGRESS'|'DELETED'|'FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
'createdAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ruleId (string) --
The unique identifier of the routing rule.
status (string) --
The status of the routing rule.
createdAt (datetime) --
The timestamp of when the routing rule was created.
{'status': {'DELETE_FAILED', 'CREATE_FAILED'}}
Creates an outbound external link.
See also: AWS API Documentation
Request Syntax
client.create_outbound_external_link(
clientToken='string',
gatewayId='string',
attributes={
'responderErrorMasking': [
{
'httpCode': 'string',
'action': 'NO_BID'|'PASSTHROUGH',
'loggingTypes': [
'NONE'|'METRIC'|'RESPONSE',
],
'responseLoggingPercentage': ...
},
],
'customerProvidedId': 'string'
},
publicEndpoint='string',
logSettings={
'applicationLogs': {
'sampling': {
'errorLog': 123.0,
'filterLog': 123.0
}
}
},
tags={
'string': 'string'
}
)
string
[REQUIRED]
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
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.
string
[REQUIRED]
The public endpoint 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
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'|'CREATE_FAILED'|'DELETE_FAILED'
}
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.
{'status': {'DELETE_FAILED', 'CREATE_FAILED'}}
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]
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
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'|'CREATE_FAILED'|'DELETE_FAILED'
}
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.
{'status': {'DELETE_FAILED', 'CREATE_FAILED'}}
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',
listenerConfig={
'protocols': [
'HTTP'|'HTTPS',
]
},
trustStoreConfiguration={
'certificateAuthorityCertificates': [
'string',
]
},
managedEndpointConfiguration={
'autoScalingGroups': {
'autoScalingGroupNames': [
'string',
],
'roleArn': 'string',
'healthCheckConfig': {
'port': 123,
'path': 'string',
'protocol': 'HTTP'|'HTTPS',
'timeoutMs': 123,
'intervalSeconds': 123,
'statusCodeMatcher': 'string',
'healthyThresholdCount': 123,
'unhealthyThresholdCount': 123
}
},
'eksEndpoints': {
'endpointsResourceName': 'string',
'endpointsResourceNamespace': 'string',
'clusterApiServerEndpointUri': 'string',
'clusterApiServerCaCertificateChain': 'string',
'clusterName': 'string',
'roleArn': 'string'
}
},
clientToken='string',
description='string',
tags={
'string': 'string'
},
gatewayType='EXTERNAL'|'INTERNAL',
clientRoutingPolicy='AVAILABILITY_ZONE_AFFINITY'|'ANY_AVAILABILITY_ZONE'
)
string
[REQUIRED]
The unique identifier of the Virtual Private Cloud (VPC).
list
[REQUIRED]
Unique identifiers of the subnets. A service quota for your account sets the number of Availability Zones that your subnets can span. By default, this quota is one Availability Zone. To span more Availability Zones, request a quota increase.
(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
Listener configuration for the protocols (HTTP, HTTPS, or both) accepted by the gateway.
protocols (list) -- [REQUIRED]
The protocol for connections from clients to the gateway
(string) --
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.
healthCheckConfig (dict) --
The health check configuration for the Auto Scaling group managed endpoint.
port (integer) -- [REQUIRED]
The port to use for health check probes. Valid range is 80 to 65535.
path (string) -- [REQUIRED]
The destination path for the health check request. Must start with /.
protocol (string) --
The protocol to use for health check probes.
timeoutMs (integer) --
The timeout for each health check probe, in milliseconds. Valid range is 100 to 5000.
intervalSeconds (integer) --
The interval between health check probes, in seconds. Valid range is 5 to 60.
statusCodeMatcher (string) --
The expected HTTP status code or status code pattern from healthy instances. Supports a single code (for example, 200), a range (for example, 200-299), or a comma-separated list (for example, 200,204).
healthyThresholdCount (integer) --
The number of consecutive successful health checks required before an instance is considered healthy. Valid range is 2 to 10.
unhealthyThresholdCount (integer) --
The number of consecutive failed health checks required before an instance is considered unhealthy. Valid range is 2 to 10.
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]
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
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) --
string
The type of gateway. Valid values are EXTERNAL or INTERNAL.
string
The client routing policy of the gateway. This policy controls which Availability Zones RTB Fabric uses to reach the gateway for the requester gateways that send traffic to it. Valid values are the following:
AVAILABILITY_ZONE_AFFINITY: RTB Fabric routes each requester's traffic to gateway capacity in the requester's own Availability Zone when the gateway has capacity available there. Otherwise, RTB Fabric routes the traffic to gateway capacity in the other Availability Zones of the gateway.
ANY_AVAILABILITY_ZONE: RTB Fabric routes each requester's traffic to gateway capacity in every Availability Zone that the subnets of the gateway span. The Availability Zone that the requester is in does not change this.
If you don't specify a value, RTB Fabric uses AVAILABILITY_ZONE_AFFINITY. To get the behavior of ANY_AVAILABILITY_ZONE, create the gateway with subnets in more than one Availability Zone. RTB Fabric does not support partial Availability Zone affinity, so PARTIAL_AVAILABILITY_ZONE_AFFINITY is not a valid value. For more information, see Configuring Availability Zone affinity in the Amazon Web Services RTB Fabric User Guide.
dict
Response Syntax
{
'gatewayId': 'string',
'status': 'PENDING_CREATION'|'ACTIVE'|'PENDING_DELETION'|'DELETED'|'ERROR'|'PENDING_UPDATE'|'ISOLATED'|'PENDING_ISOLATION'|'PENDING_RESTORATION'|'CREATE_FAILED'|'DELETE_FAILED',
'listenerConfig': {
'protocols': [
'HTTP'|'HTTPS',
]
},
'externalInboundEndpoint': 'string',
'clientRoutingPolicy': 'AVAILABILITY_ZONE_AFFINITY'|'ANY_AVAILABILITY_ZONE'
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
status (string) --
The status of the request.
listenerConfig (dict) --
The listener configuration for the responder gateway.
protocols (list) --
The protocol for connections from clients to the gateway
(string) --
externalInboundEndpoint (string) --
The external inbound endpoint for the responder gateway.
clientRoutingPolicy (string) --
The client routing policy of the gateway. This policy controls which Availability Zones RTB Fabric uses to reach the gateway for the requester gateways that send traffic to it. For more information, see Configuring Availability Zone affinity in the Amazon Web Services RTB Fabric User Guide.
{'status': {'DELETE_FAILED', 'CREATE_FAILED'}}
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'|'CREATE_FAILED'|'DELETE_FAILED'
}
Response Structure
(dict) --
linkId (string) --
The unique identifier of the link.
status (string) --
The status of the request.
{'status': {'DELETE_FAILED', 'CREATE_FAILED'}}
Deletes a link between gateways.
Permanently removes the connection between gateways. 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'|'CREATE_FAILED'|'DELETE_FAILED'
}
Response Structure
(dict) --
linkId (string) --
The unique identifier of the link.
status (string) --
The status of the link.
{'status': {'CREATE_FAILED', 'DELETE_FAILED'}}
Deletes a routing rule from a link.
See also: AWS API Documentation
Request Syntax
client.delete_link_routing_rule(
gatewayId='string',
linkId='string',
ruleId='string'
)
string
[REQUIRED]
The unique identifier of the gateway.
string
[REQUIRED]
The unique identifier of the link.
string
[REQUIRED]
The unique identifier of the routing rule.
dict
Response Syntax
{
'ruleId': 'string',
'status': 'CREATION_IN_PROGRESS'|'ACTIVE'|'UPDATE_IN_PROGRESS'|'DELETION_IN_PROGRESS'|'DELETED'|'FAILED'|'CREATE_FAILED'|'DELETE_FAILED'
}
Response Structure
(dict) --
ruleId (string) --
The unique identifier of the routing rule.
status (string) --
The status of the routing rule.
{'status': {'DELETE_FAILED', 'CREATE_FAILED'}}
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'|'CREATE_FAILED'|'DELETE_FAILED'
}
Response Structure
(dict) --
linkId (string) --
The unique identifier of the link.
status (string) --
The status of the request.
{'status': {'DELETE_FAILED', 'CREATE_FAILED'}}
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'|'CREATE_FAILED'|'DELETE_FAILED'
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
status (string) --
The status of the request.
{'status': {'DELETE_FAILED', 'CREATE_FAILED'}}
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'|'CREATE_FAILED'|'DELETE_FAILED'
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
status (string) --
The status of the request.
{'errorDetails': [{'code': 'VPC_NOT_FOUND | EC2_SUBNET_NOT_FOUND | '
'EC2_SECURITY_GROUP_NOT_FOUND | '
'EC2_SUBNET_IP_EXHAUSTION | '
'IAM_ASSUME_ROLE_ACCESS_DENIED | INTERNAL_ERROR',
'message': 'string',
'resourceIds': ['string']}]}
Retrieves the details of a certificate association with a responder gateway.
See also: AWS API Documentation
Request Syntax
client.get_certificate_association(
gatewayId='string',
acmCertificateArn='string'
)
string
[REQUIRED]
The unique identifier of the gateway.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the ACM certificate.
dict
Response Syntax
{
'gatewayId': 'string',
'acmCertificateArn': 'string',
'status': 'PENDING_ASSOCIATION'|'ASSOCIATED'|'PENDING_DISASSOCIATION'|'DISASSOCIATED'|'FAILED',
'associatedAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'errorDetails': [
{
'code': 'VPC_NOT_FOUND'|'EC2_SUBNET_NOT_FOUND'|'EC2_SECURITY_GROUP_NOT_FOUND'|'EC2_SUBNET_IP_EXHAUSTION'|'IAM_ASSUME_ROLE_ACCESS_DENIED'|'INTERNAL_ERROR',
'message': 'string',
'resourceIds': [
'string',
]
},
]
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
acmCertificateArn (string) --
The Amazon Resource Name (ARN) of the ACM certificate.
status (string) --
The status of the certificate association.
associatedAt (datetime) --
The timestamp of when the certificate was associated.
updatedAt (datetime) --
The timestamp of when the certificate association was last updated.
errorDetails (list) --
The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
(dict) --
Describes one cause of a failure of a resource or an update, with an error code, a description, and the IDs of the resources involved.
code (string) --
The error code for what failed.
message (string) --
A description of the failure.
resourceIds (list) --
The IDs of the resources involved, such as a subnet or security group.
(string) --
{'errorDetails': [{'code': 'VPC_NOT_FOUND | EC2_SUBNET_NOT_FOUND | '
'EC2_SECURITY_GROUP_NOT_FOUND | '
'EC2_SUBNET_IP_EXHAUSTION | '
'IAM_ASSUME_ROLE_ACCESS_DENIED | INTERNAL_ERROR',
'message': 'string',
'resourceIds': ['string']}],
'flows': [{'name': 'string',
'pipeline': {'phased': {'phases': [{'modules': [{'activationPercentage': 'float',
'configurationValues': 'string',
'failureMode': 'OPEN '
'| '
'CLOSED',
'moduleVersionArn': 'string',
'name': 'string',
'selectedActions': ['FILTER '
'| '
'ENRICH_REQUEST_EXT '
'| '
'ENRICH_REQUEST_HEADERS '
'| '
'OBSERVE']}]}]},
'sequential': {'modules': [{'activationPercentage': 'float',
'configurationValues': 'string',
'failureMode': 'OPEN | '
'CLOSED',
'moduleVersionArn': 'string',
'name': 'string',
'selectedActions': ['FILTER '
'| '
'ENRICH_REQUEST_EXT '
'| '
'ENRICH_REQUEST_HEADERS '
'| '
'OBSERVE']}]}}}],
'lockToken': 'string',
'status': {'DELETE_FAILED', 'CREATE_FAILED'}}
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'|'CREATE_FAILED'|'DELETE_FAILED',
'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'
},
'logSettings': {
'applicationLogs': {
'sampling': {
'errorLog': 123.0,
'filterLog': 123.0
}
}
},
'connectivityType': 'DEFAULT'|'PUBLIC_INGRESS'|'PUBLIC_EGRESS'|'EXTERNAL_INBOUND',
'errorDetails': [
{
'code': 'VPC_NOT_FOUND'|'EC2_SUBNET_NOT_FOUND'|'EC2_SECURITY_GROUP_NOT_FOUND'|'EC2_SUBNET_IP_EXHAUSTION'|'IAM_ASSUME_ROLE_ACCESS_DENIED'|'INTERNAL_ERROR',
'message': 'string',
'resourceIds': [
'string',
]
},
],
'lockToken': 'string',
'flows': [
{
'name': 'string',
'pipeline': {
'sequential': {
'modules': [
{
'name': 'string',
'moduleVersionArn': 'string',
'selectedActions': [
'FILTER'|'ENRICH_REQUEST_EXT'|'ENRICH_REQUEST_HEADERS'|'OBSERVE',
],
'failureMode': 'OPEN'|'CLOSED',
'activationPercentage': ...,
'configurationValues': 'string'
},
]
},
'phased': {
'phases': [
{
'modules': [
{
'name': 'string',
'moduleVersionArn': 'string',
'selectedActions': [
'FILTER'|'ENRICH_REQUEST_EXT'|'ENRICH_REQUEST_HEADERS'|'OBSERVE',
],
'failureMode': 'OPEN'|'CLOSED',
'activationPercentage': ...,
'configurationValues': '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) --
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.
connectivityType (string) --
The connectivity type of the link.
errorDetails (list) --
The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
(dict) --
Describes one cause of a failure of a resource or an update, with an error code, a description, and the IDs of the resources involved.
code (string) --
The error code for what failed.
message (string) --
A description of the failure.
resourceIds (list) --
The IDs of the resources involved, such as a subnet or security group.
(string) --
lockToken (string) --
The link's concurrency token. Pass it to PutLinkFlows unchanged; it changes whenever the link does.
flows (list) --
The link's active flows, in the form PutLinkFlows takes. Empty when the link has no modules, and absent when its modules were set with UpdateLinkModuleFlow.
(dict) --
One flow on a link: a set of modules that runs on the link's bid requests.
name (string) --
The flow's name, unique within the link.
pipeline (dict) --
The pipeline that the flow's modules run in. In a sequential pipeline, each module sees the previous module's output. In a phased pipeline, a phase's modules see the prior phase's output, not each other's.
sequential (dict) --
Modules run in list order. Use it when each module needs the previous module's output.
modules (list) --
In execution order.
(dict) --
A version attached to a flow, with its settings.
name (string) --
The module's name, unique within the flow.
moduleVersionArn (string) --
The version to attach. It must be ACTIVE and available to you (see ListAvailableModuleVersions). You can keep a version that's already in the link's flows after it's deprecated, but you can't give it a higher share of traffic.
selectedActions (list) --
The capabilities to turn on, chosen from the version's configurableActions. If the version exposes one, it's the default. If the version exposes more than one, this field is required. If it exposes none, omit this field.
(string) --
A capability that you can turn on when you attach a version, such as FILTER or OBSERVE. Each capability needs a minimum permission.
failureMode (string) --
Specifies what happens when the module fails – when its call fails or times out, or when an express module's dataset is stale. The default is OPEN.
activationPercentage (float) --
The percentage of the flow's requests that the module runs on. The flow skips the module on the rest of the requests. The default is 100.
configurationValues (string) --
RTB Fabric validates the value against the version's configurationSchema and rejects a value that fails with ValidationException. Omit it when the schema is empty or fully defaulted.
phased (dict) --
Phases run in order; a phase's modules run concurrently on the same input. Use it when a phase's modules don't depend on each other.
phases (list) --
At most 8 modules in total across the phases; more fails with ValidationException.
(dict) --
One phase of a phased pipeline. Its modules run concurrently on the previous phase's output.
modules (list) --
At most one MUTATE_REQUEST_BODY module.
(dict) --
A version attached to a flow, with its settings.
name (string) --
The module's name, unique within the flow.
moduleVersionArn (string) --
The version to attach. It must be ACTIVE and available to you (see ListAvailableModuleVersions). You can keep a version that's already in the link's flows after it's deprecated, but you can't give it a higher share of traffic.
selectedActions (list) --
The capabilities to turn on, chosen from the version's configurableActions. If the version exposes one, it's the default. If the version exposes more than one, this field is required. If it exposes none, omit this field.
(string) --
A capability that you can turn on when you attach a version, such as FILTER or OBSERVE. Each capability needs a minimum permission.
failureMode (string) --
Specifies what happens when the module fails – when its call fails or times out, or when an express module's dataset is stale. The default is OPEN.
activationPercentage (float) --
The percentage of the flow's requests that the module runs on. The flow skips the module on the rest of the requests. The default is 100.
configurationValues (string) --
RTB Fabric validates the value against the version's configurationSchema and rejects a value that fails with ValidationException. Omit it when the schema is empty or fully defaulted.
{'errorDetails': [{'code': 'VPC_NOT_FOUND | EC2_SUBNET_NOT_FOUND | '
'EC2_SECURITY_GROUP_NOT_FOUND | '
'EC2_SUBNET_IP_EXHAUSTION | '
'IAM_ASSUME_ROLE_ACCESS_DENIED | INTERNAL_ERROR',
'message': 'string',
'resourceIds': ['string']}],
'flows': [{'name': 'string',
'pipeline': {'phased': {'phases': [{'modules': [{'activationPercentage': 'float',
'configurationValues': 'string',
'failureMode': 'OPEN '
'| '
'CLOSED',
'moduleVersionArn': 'string',
'name': 'string',
'selectedActions': ['FILTER '
'| '
'ENRICH_REQUEST_EXT '
'| '
'ENRICH_REQUEST_HEADERS '
'| '
'OBSERVE']}]}]},
'sequential': {'modules': [{'activationPercentage': 'float',
'configurationValues': 'string',
'failureMode': 'OPEN | '
'CLOSED',
'moduleVersionArn': 'string',
'name': 'string',
'selectedActions': ['FILTER '
'| '
'ENRICH_REQUEST_EXT '
'| '
'ENRICH_REQUEST_HEADERS '
'| '
'OBSERVE']}]}}}],
'lockToken': 'string',
'status': {'DELETE_FAILED', 'CREATE_FAILED'}}
Retrieves information about a link between gateways.
Returns detailed information about the link configuration, status, and associated gateways.
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'|'CREATE_FAILED'|'DELETE_FAILED',
'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'
},
'logSettings': {
'applicationLogs': {
'sampling': {
'errorLog': 123.0,
'filterLog': 123.0
}
}
},
'connectivityType': 'DEFAULT'|'PUBLIC_INGRESS'|'PUBLIC_EGRESS'|'EXTERNAL_INBOUND',
'errorDetails': [
{
'code': 'VPC_NOT_FOUND'|'EC2_SUBNET_NOT_FOUND'|'EC2_SECURITY_GROUP_NOT_FOUND'|'EC2_SUBNET_IP_EXHAUSTION'|'IAM_ASSUME_ROLE_ACCESS_DENIED'|'INTERNAL_ERROR',
'message': 'string',
'resourceIds': [
'string',
]
},
],
'linkId': 'string',
'tags': {
'string': 'string'
},
'httpResponderAllowed': True|False,
'timeoutInMillis': 123,
'lockToken': 'string',
'flows': [
{
'name': 'string',
'pipeline': {
'sequential': {
'modules': [
{
'name': 'string',
'moduleVersionArn': 'string',
'selectedActions': [
'FILTER'|'ENRICH_REQUEST_EXT'|'ENRICH_REQUEST_HEADERS'|'OBSERVE',
],
'failureMode': 'OPEN'|'CLOSED',
'activationPercentage': ...,
'configurationValues': 'string'
},
]
},
'phased': {
'phases': [
{
'modules': [
{
'name': 'string',
'moduleVersionArn': 'string',
'selectedActions': [
'FILTER'|'ENRICH_REQUEST_EXT'|'ENRICH_REQUEST_HEADERS'|'OBSERVE',
],
'failureMode': 'OPEN'|'CLOSED',
'activationPercentage': ...,
'configurationValues': '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.
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.
connectivityType (string) --
The connectivity type of the link.
errorDetails (list) --
The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
(dict) --
Describes one cause of a failure of a resource or an update, with an error code, a description, and the IDs of the resources involved.
code (string) --
The error code for what failed.
message (string) --
A description of the failure.
resourceIds (list) --
The IDs of the resources involved, such as a subnet or security group.
(string) --
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) --
httpResponderAllowed (boolean) --
Boolean to specify if an HTTP responder is allowed.
timeoutInMillis (integer) --
The timeout value in milliseconds.
lockToken (string) --
The link's concurrency token. Pass it to PutLinkFlows unchanged; it changes whenever the link does.
flows (list) --
The link's active flows, in the form PutLinkFlows takes. Empty when the link has no modules, and absent when its modules were set with UpdateLinkModuleFlow.
(dict) --
One flow on a link: a set of modules that runs on the link's bid requests.
name (string) --
The flow's name, unique within the link.
pipeline (dict) --
The pipeline that the flow's modules run in. In a sequential pipeline, each module sees the previous module's output. In a phased pipeline, a phase's modules see the prior phase's output, not each other's.
sequential (dict) --
Modules run in list order. Use it when each module needs the previous module's output.
modules (list) --
In execution order.
(dict) --
A version attached to a flow, with its settings.
name (string) --
The module's name, unique within the flow.
moduleVersionArn (string) --
The version to attach. It must be ACTIVE and available to you (see ListAvailableModuleVersions). You can keep a version that's already in the link's flows after it's deprecated, but you can't give it a higher share of traffic.
selectedActions (list) --
The capabilities to turn on, chosen from the version's configurableActions. If the version exposes one, it's the default. If the version exposes more than one, this field is required. If it exposes none, omit this field.
(string) --
A capability that you can turn on when you attach a version, such as FILTER or OBSERVE. Each capability needs a minimum permission.
failureMode (string) --
Specifies what happens when the module fails – when its call fails or times out, or when an express module's dataset is stale. The default is OPEN.
activationPercentage (float) --
The percentage of the flow's requests that the module runs on. The flow skips the module on the rest of the requests. The default is 100.
configurationValues (string) --
RTB Fabric validates the value against the version's configurationSchema and rejects a value that fails with ValidationException. Omit it when the schema is empty or fully defaulted.
phased (dict) --
Phases run in order; a phase's modules run concurrently on the same input. Use it when a phase's modules don't depend on each other.
phases (list) --
At most 8 modules in total across the phases; more fails with ValidationException.
(dict) --
One phase of a phased pipeline. Its modules run concurrently on the previous phase's output.
modules (list) --
At most one MUTATE_REQUEST_BODY module.
(dict) --
A version attached to a flow, with its settings.
name (string) --
The module's name, unique within the flow.
moduleVersionArn (string) --
The version to attach. It must be ACTIVE and available to you (see ListAvailableModuleVersions). You can keep a version that's already in the link's flows after it's deprecated, but you can't give it a higher share of traffic.
selectedActions (list) --
The capabilities to turn on, chosen from the version's configurableActions. If the version exposes one, it's the default. If the version exposes more than one, this field is required. If it exposes none, omit this field.
(string) --
A capability that you can turn on when you attach a version, such as FILTER or OBSERVE. Each capability needs a minimum permission.
failureMode (string) --
Specifies what happens when the module fails – when its call fails or times out, or when an express module's dataset is stale. The default is OPEN.
activationPercentage (float) --
The percentage of the flow's requests that the module runs on. The flow skips the module on the rest of the requests. The default is 100.
configurationValues (string) --
RTB Fabric validates the value against the version's configurationSchema and rejects a value that fails with ValidationException. Omit it when the schema is empty or fully defaulted.
{'errorDetails': [{'code': 'VPC_NOT_FOUND | EC2_SUBNET_NOT_FOUND | '
'EC2_SECURITY_GROUP_NOT_FOUND | '
'EC2_SUBNET_IP_EXHAUSTION | '
'IAM_ASSUME_ROLE_ACCESS_DENIED | INTERNAL_ERROR',
'message': 'string',
'resourceIds': ['string']}],
'status': {'CREATE_FAILED', 'DELETE_FAILED'}}
Retrieves the details of a routing rule for a link.
See also: AWS API Documentation
Request Syntax
client.get_link_routing_rule(
gatewayId='string',
linkId='string',
ruleId='string'
)
string
[REQUIRED]
The unique identifier of the gateway.
string
[REQUIRED]
The unique identifier of the link.
string
[REQUIRED]
The unique identifier of the routing rule.
dict
Response Syntax
{
'gatewayId': 'string',
'linkId': 'string',
'ruleId': 'string',
'priority': 123,
'conditions': {
'hostHeader': 'string',
'hostHeaderWildcard': 'string',
'pathPrefix': 'string',
'pathExact': 'string',
'queryStringEquals': {
'key': 'string',
'value': 'string'
},
'queryStringExists': 'string'
},
'status': 'CREATION_IN_PROGRESS'|'ACTIVE'|'UPDATE_IN_PROGRESS'|'DELETION_IN_PROGRESS'|'DELETED'|'FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'errorDetails': [
{
'code': 'VPC_NOT_FOUND'|'EC2_SUBNET_NOT_FOUND'|'EC2_SECURITY_GROUP_NOT_FOUND'|'EC2_SUBNET_IP_EXHAUSTION'|'IAM_ASSUME_ROLE_ACCESS_DENIED'|'INTERNAL_ERROR',
'message': 'string',
'resourceIds': [
'string',
]
},
]
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
linkId (string) --
The unique identifier of the link.
ruleId (string) --
The unique identifier of the routing rule.
priority (integer) --
The priority of the routing rule.
conditions (dict) --
The conditions for the routing rule.
hostHeader (string) --
The exact host header value to match.
hostHeaderWildcard (string) --
A wildcard pattern for host header matching (for example, *.example.com).
pathPrefix (string) --
The path prefix to match. The request path must start with this value. Must start with /.
pathExact (string) --
The exact path to match. Must start with /.
queryStringEquals (dict) --
A query string key-value pair that must be present and match exactly.
key (string) --
The key of the query string parameter to match. Must contain only RFC 3986 unreserved characters.
value (string) --
The value of the query string parameter to match. Must contain only RFC 3986 unreserved characters.
queryStringExists (string) --
A query string key that must be present in the request (any value is accepted).
status (string) --
The status of the routing rule.
createdAt (datetime) --
The timestamp of when the routing rule was created.
updatedAt (datetime) --
The timestamp of when the routing rule was last updated.
tags (dict) --
A map of the key-value pairs for the tag or tags assigned to the specified resource.
(string) --
(string) --
errorDetails (list) --
The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
(dict) --
Describes one cause of a failure of a resource or an update, with an error code, a description, and the IDs of the resources involved.
code (string) --
The error code for what failed.
message (string) --
A description of the failure.
resourceIds (list) --
The IDs of the resources involved, such as a subnet or security group.
(string) --
{'errorDetails': [{'code': 'VPC_NOT_FOUND | EC2_SUBNET_NOT_FOUND | '
'EC2_SECURITY_GROUP_NOT_FOUND | '
'EC2_SUBNET_IP_EXHAUSTION | '
'IAM_ASSUME_ROLE_ACCESS_DENIED | INTERNAL_ERROR',
'message': 'string',
'resourceIds': ['string']}],
'flows': [{'name': 'string',
'pipeline': {'phased': {'phases': [{'modules': [{'activationPercentage': 'float',
'configurationValues': 'string',
'failureMode': 'OPEN '
'| '
'CLOSED',
'moduleVersionArn': 'string',
'name': 'string',
'selectedActions': ['FILTER '
'| '
'ENRICH_REQUEST_EXT '
'| '
'ENRICH_REQUEST_HEADERS '
'| '
'OBSERVE']}]}]},
'sequential': {'modules': [{'activationPercentage': 'float',
'configurationValues': 'string',
'failureMode': 'OPEN | '
'CLOSED',
'moduleVersionArn': 'string',
'name': 'string',
'selectedActions': ['FILTER '
'| '
'ENRICH_REQUEST_EXT '
'| '
'ENRICH_REQUEST_HEADERS '
'| '
'OBSERVE']}]}}}],
'lockToken': 'string',
'status': {'DELETE_FAILED', 'CREATE_FAILED'}}
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'|'CREATE_FAILED'|'DELETE_FAILED',
'publicEndpoint': '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'
},
'logSettings': {
'applicationLogs': {
'sampling': {
'errorLog': 123.0,
'filterLog': 123.0
}
}
},
'connectivityType': 'DEFAULT'|'PUBLIC_INGRESS'|'PUBLIC_EGRESS'|'EXTERNAL_INBOUND',
'errorDetails': [
{
'code': 'VPC_NOT_FOUND'|'EC2_SUBNET_NOT_FOUND'|'EC2_SECURITY_GROUP_NOT_FOUND'|'EC2_SUBNET_IP_EXHAUSTION'|'IAM_ASSUME_ROLE_ACCESS_DENIED'|'INTERNAL_ERROR',
'message': 'string',
'resourceIds': [
'string',
]
},
],
'lockToken': 'string',
'flows': [
{
'name': 'string',
'pipeline': {
'sequential': {
'modules': [
{
'name': 'string',
'moduleVersionArn': 'string',
'selectedActions': [
'FILTER'|'ENRICH_REQUEST_EXT'|'ENRICH_REQUEST_HEADERS'|'OBSERVE',
],
'failureMode': 'OPEN'|'CLOSED',
'activationPercentage': ...,
'configurationValues': 'string'
},
]
},
'phased': {
'phases': [
{
'modules': [
{
'name': 'string',
'moduleVersionArn': 'string',
'selectedActions': [
'FILTER'|'ENRICH_REQUEST_EXT'|'ENRICH_REQUEST_HEADERS'|'OBSERVE',
],
'failureMode': 'OPEN'|'CLOSED',
'activationPercentage': ...,
'configurationValues': '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.
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) --
Describes the 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.
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) --
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.
connectivityType (string) --
The connectivity type of the link.
errorDetails (list) --
The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
(dict) --
Describes one cause of a failure of a resource or an update, with an error code, a description, and the IDs of the resources involved.
code (string) --
The error code for what failed.
message (string) --
A description of the failure.
resourceIds (list) --
The IDs of the resources involved, such as a subnet or security group.
(string) --
lockToken (string) --
The link's concurrency token. Pass it to PutLinkFlows unchanged; it changes whenever the link does.
flows (list) --
The link's active flows, in the form PutLinkFlows takes. Empty when the link has no modules, and absent when its modules were set with UpdateLinkModuleFlow.
(dict) --
One flow on a link: a set of modules that runs on the link's bid requests.
name (string) --
The flow's name, unique within the link.
pipeline (dict) --
The pipeline that the flow's modules run in. In a sequential pipeline, each module sees the previous module's output. In a phased pipeline, a phase's modules see the prior phase's output, not each other's.
sequential (dict) --
Modules run in list order. Use it when each module needs the previous module's output.
modules (list) --
In execution order.
(dict) --
A version attached to a flow, with its settings.
name (string) --
The module's name, unique within the flow.
moduleVersionArn (string) --
The version to attach. It must be ACTIVE and available to you (see ListAvailableModuleVersions). You can keep a version that's already in the link's flows after it's deprecated, but you can't give it a higher share of traffic.
selectedActions (list) --
The capabilities to turn on, chosen from the version's configurableActions. If the version exposes one, it's the default. If the version exposes more than one, this field is required. If it exposes none, omit this field.
(string) --
A capability that you can turn on when you attach a version, such as FILTER or OBSERVE. Each capability needs a minimum permission.
failureMode (string) --
Specifies what happens when the module fails – when its call fails or times out, or when an express module's dataset is stale. The default is OPEN.
activationPercentage (float) --
The percentage of the flow's requests that the module runs on. The flow skips the module on the rest of the requests. The default is 100.
configurationValues (string) --
RTB Fabric validates the value against the version's configurationSchema and rejects a value that fails with ValidationException. Omit it when the schema is empty or fully defaulted.
phased (dict) --
Phases run in order; a phase's modules run concurrently on the same input. Use it when a phase's modules don't depend on each other.
phases (list) --
At most 8 modules in total across the phases; more fails with ValidationException.
(dict) --
One phase of a phased pipeline. Its modules run concurrently on the previous phase's output.
modules (list) --
At most one MUTATE_REQUEST_BODY module.
(dict) --
A version attached to a flow, with its settings.
name (string) --
The module's name, unique within the flow.
moduleVersionArn (string) --
The version to attach. It must be ACTIVE and available to you (see ListAvailableModuleVersions). You can keep a version that's already in the link's flows after it's deprecated, but you can't give it a higher share of traffic.
selectedActions (list) --
The capabilities to turn on, chosen from the version's configurableActions. If the version exposes one, it's the default. If the version exposes more than one, this field is required. If it exposes none, omit this field.
(string) --
A capability that you can turn on when you attach a version, such as FILTER or OBSERVE. Each capability needs a minimum permission.
failureMode (string) --
Specifies what happens when the module fails – when its call fails or times out, or when an express module's dataset is stale. The default is OPEN.
activationPercentage (float) --
The percentage of the flow's requests that the module runs on. The flow skips the module on the rest of the requests. The default is 100.
configurationValues (string) --
RTB Fabric validates the value against the version's configurationSchema and rejects a value that fails with ValidationException. Omit it when the schema is empty or fully defaulted.
{'errorDetails': [{'code': 'VPC_NOT_FOUND | EC2_SUBNET_NOT_FOUND | '
'EC2_SECURITY_GROUP_NOT_FOUND | '
'EC2_SUBNET_IP_EXHAUSTION | '
'IAM_ASSUME_ROLE_ACCESS_DENIED | INTERNAL_ERROR',
'message': 'string',
'resourceIds': ['string']}],
'status': {'DELETE_FAILED', 'CREATE_FAILED'}}
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'|'CREATE_FAILED'|'DELETE_FAILED',
'domainName': 'string',
'description': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'errorDetails': [
{
'code': 'VPC_NOT_FOUND'|'EC2_SUBNET_NOT_FOUND'|'EC2_SECURITY_GROUP_NOT_FOUND'|'EC2_SUBNET_IP_EXHAUSTION'|'IAM_ASSUME_ROLE_ACCESS_DENIED'|'INTERNAL_ERROR',
'message': 'string',
'resourceIds': [
'string',
]
},
],
'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.
errorDetails (list) --
The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
(dict) --
Describes one cause of a failure of a resource or an update, with an error code, a description, and the IDs of the resources involved.
code (string) --
The error code for what failed.
message (string) --
A description of the failure.
resourceIds (list) --
The IDs of the resources involved, such as a subnet or security group.
(string) --
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.
{'errorDetails': [{'code': 'VPC_NOT_FOUND | EC2_SUBNET_NOT_FOUND | '
'EC2_SECURITY_GROUP_NOT_FOUND | '
'EC2_SUBNET_IP_EXHAUSTION | '
'IAM_ASSUME_ROLE_ACCESS_DENIED | INTERNAL_ERROR',
'message': 'string',
'resourceIds': ['string']}],
'status': {'DELETE_FAILED', 'CREATE_FAILED'}}
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'|'CREATE_FAILED'|'DELETE_FAILED',
'description': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'errorDetails': [
{
'code': 'VPC_NOT_FOUND'|'EC2_SUBNET_NOT_FOUND'|'EC2_SECURITY_GROUP_NOT_FOUND'|'EC2_SUBNET_IP_EXHAUSTION'|'IAM_ASSUME_ROLE_ACCESS_DENIED'|'INTERNAL_ERROR',
'message': 'string',
'resourceIds': [
'string',
]
},
],
'domainName': 'string',
'port': 123,
'protocol': 'HTTP'|'HTTPS',
'listenerConfig': {
'protocols': [
'HTTP'|'HTTPS',
]
},
'trustStoreConfiguration': {
'certificateAuthorityCertificates': [
'string',
]
},
'managedEndpointConfiguration': {
'autoScalingGroups': {
'autoScalingGroupNames': [
'string',
],
'roleArn': 'string',
'healthCheckConfig': {
'port': 123,
'path': 'string',
'protocol': 'HTTP'|'HTTPS',
'timeoutMs': 123,
'intervalSeconds': 123,
'statusCodeMatcher': 'string',
'healthyThresholdCount': 123,
'unhealthyThresholdCount': 123
}
},
'eksEndpoints': {
'endpointsResourceName': 'string',
'endpointsResourceNamespace': 'string',
'clusterApiServerEndpointUri': 'string',
'clusterApiServerCaCertificateChain': 'string',
'clusterName': 'string',
'roleArn': 'string'
}
},
'gatewayId': 'string',
'tags': {
'string': 'string'
},
'activeLinksCount': 123,
'totalLinksCount': 123,
'linksRequestedCount': 123,
'gatewayType': 'EXTERNAL'|'INTERNAL',
'externalInboundEndpoint': 'string',
'clientRoutingPolicy': 'AVAILABILITY_ZONE_AFFINITY'|'ANY_AVAILABILITY_ZONE'
}
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.
errorDetails (list) --
The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
(dict) --
Describes one cause of a failure of a resource or an update, with an error code, a description, and the IDs of the resources involved.
code (string) --
The error code for what failed.
message (string) --
A description of the failure.
resourceIds (list) --
The IDs of the resources involved, such as a subnet or security group.
(string) --
domainName (string) --
The domain name of the responder gateway.
port (integer) --
The networking port.
protocol (string) --
The networking protocol.
listenerConfig (dict) --
The listener configuration for the responder gateway.
protocols (list) --
The protocol for connections from clients to the gateway
(string) --
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.
healthCheckConfig (dict) --
The health check configuration for the Auto Scaling group managed endpoint.
port (integer) --
The port to use for health check probes. Valid range is 80 to 65535.
path (string) --
The destination path for the health check request. Must start with /.
protocol (string) --
The protocol to use for health check probes.
timeoutMs (integer) --
The timeout for each health check probe, in milliseconds. Valid range is 100 to 5000.
intervalSeconds (integer) --
The interval between health check probes, in seconds. Valid range is 5 to 60.
statusCodeMatcher (string) --
The expected HTTP status code or status code pattern from healthy instances. Supports a single code (for example, 200), a range (for example, 200-299), or a comma-separated list (for example, 200,204).
healthyThresholdCount (integer) --
The number of consecutive successful health checks required before an instance is considered healthy. Valid range is 2 to 10.
unhealthyThresholdCount (integer) --
The number of consecutive failed health checks required before an instance is considered unhealthy. Valid range is 2 to 10.
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.
linksRequestedCount (integer) --
The count of requested links waiting for the responder gateway to accept or reject.
gatewayType (string) --
The type of gateway. Valid values are EXTERNAL or INTERNAL.
externalInboundEndpoint (string) --
The external inbound endpoint for the responder gateway.
clientRoutingPolicy (string) --
The client routing policy of the gateway. This policy controls which Availability Zones RTB Fabric uses to reach the gateway for the requester gateways that send traffic to it. RTB Fabric omits this member if the gateway has never had a client routing policy. An omitted value means that the gateway uses AVAILABILITY_ZONE_AFFINITY. For more information, see Configuring Availability Zone affinity in the Amazon Web Services RTB Fabric User Guide.
{'rules': {'errorDetails': [{'code': 'VPC_NOT_FOUND | EC2_SUBNET_NOT_FOUND | '
'EC2_SECURITY_GROUP_NOT_FOUND | '
'EC2_SUBNET_IP_EXHAUSTION | '
'IAM_ASSUME_ROLE_ACCESS_DENIED | '
'INTERNAL_ERROR',
'message': 'string',
'resourceIds': ['string']}],
'status': {'CREATE_FAILED', 'DELETE_FAILED'}}}
Lists the routing rules for a link.
See also: AWS API Documentation
Request Syntax
client.list_link_routing_rules(
gatewayId='string',
linkId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique identifier of the gateway.
string
[REQUIRED]
The unique identifier of the link.
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
{
'rules': [
{
'ruleId': 'string',
'priority': 123,
'conditions': {
'hostHeader': 'string',
'hostHeaderWildcard': 'string',
'pathPrefix': 'string',
'pathExact': 'string',
'queryStringEquals': {
'key': 'string',
'value': 'string'
},
'queryStringExists': 'string'
},
'status': 'CREATION_IN_PROGRESS'|'ACTIVE'|'UPDATE_IN_PROGRESS'|'DELETION_IN_PROGRESS'|'DELETED'|'FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'errorDetails': [
{
'code': 'VPC_NOT_FOUND'|'EC2_SUBNET_NOT_FOUND'|'EC2_SECURITY_GROUP_NOT_FOUND'|'EC2_SUBNET_IP_EXHAUSTION'|'IAM_ASSUME_ROLE_ACCESS_DENIED'|'INTERNAL_ERROR',
'message': 'string',
'resourceIds': [
'string',
]
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
rules (list) --
The list of routing rules for the link.
(dict) --
A summary of a link routing rule.
ruleId (string) --
The unique identifier of the routing rule.
priority (integer) --
The priority of the routing rule.
conditions (dict) --
The conditions for the routing rule.
hostHeader (string) --
The exact host header value to match.
hostHeaderWildcard (string) --
A wildcard pattern for host header matching (for example, *.example.com).
pathPrefix (string) --
The path prefix to match. The request path must start with this value. Must start with /.
pathExact (string) --
The exact path to match. Must start with /.
queryStringEquals (dict) --
A query string key-value pair that must be present and match exactly.
key (string) --
The key of the query string parameter to match. Must contain only RFC 3986 unreserved characters.
value (string) --
The value of the query string parameter to match. Must contain only RFC 3986 unreserved characters.
queryStringExists (string) --
A query string key that must be present in the request (any value is accepted).
status (string) --
The status of the routing rule.
createdAt (datetime) --
The timestamp of when the routing rule was created.
updatedAt (datetime) --
The timestamp of when the routing rule was last updated.
errorDetails (list) --
The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
(dict) --
Describes one cause of a failure of a resource or an update, with an error code, a description, and the IDs of the resources involved.
code (string) --
The error code for what failed.
message (string) --
A description of the failure.
resourceIds (list) --
The IDs of the resources involved, such as a subnet or security group.
(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.
{'links': {'errorDetails': [{'code': 'VPC_NOT_FOUND | EC2_SUBNET_NOT_FOUND | '
'EC2_SECURITY_GROUP_NOT_FOUND | '
'EC2_SUBNET_IP_EXHAUSTION | '
'IAM_ASSUME_ROLE_ACCESS_DENIED | '
'INTERNAL_ERROR',
'message': 'string',
'resourceIds': ['string']}],
'status': {'DELETE_FAILED', 'CREATE_FAILED'}}}
Lists links associated with gateways.
Returns a list of all links for the specified gateways, 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'|'CREATE_FAILED'|'DELETE_FAILED',
'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'
},
'logSettings': {
'applicationLogs': {
'sampling': {
'errorLog': 123.0,
'filterLog': 123.0
}
}
},
'connectivityType': 'DEFAULT'|'PUBLIC_INGRESS'|'PUBLIC_EGRESS'|'EXTERNAL_INBOUND',
'errorDetails': [
{
'code': 'VPC_NOT_FOUND'|'EC2_SUBNET_NOT_FOUND'|'EC2_SECURITY_GROUP_NOT_FOUND'|'EC2_SUBNET_IP_EXHAUSTION'|'IAM_ASSUME_ROLE_ACCESS_DENIED'|'INTERNAL_ERROR',
'message': 'string',
'resourceIds': [
'string',
]
},
],
'linkId': 'string',
'tags': {
'string': 'string'
},
'publicEndpoint': '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.
logSettings (dict) --
Describes the settings for a link log.
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.
connectivityType (string) --
The connectivity type of the link.
errorDetails (list) --
The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
(dict) --
Describes one cause of a failure of a resource or an update, with an error code, a description, and the IDs of the resources involved.
code (string) --
The error code for what failed.
message (string) --
A description of the failure.
resourceIds (list) --
The IDs of the resources involved, such as a subnet or security group.
(string) --
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) --
publicEndpoint (string) --
The public endpoint of the outbound link.
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.
{'errorDetails': [{'code': 'VPC_NOT_FOUND | EC2_SUBNET_NOT_FOUND | '
'EC2_SECURITY_GROUP_NOT_FOUND | '
'EC2_SUBNET_IP_EXHAUSTION | '
'IAM_ASSUME_ROLE_ACCESS_DENIED | INTERNAL_ERROR',
'message': 'string',
'resourceIds': ['string']}],
'status': {'DELETE_FAILED', 'CREATE_FAILED'}}
Rejects a link request between gateways.
When a requester gateway requests to link with a responder gateway, 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'|'CREATE_FAILED'|'DELETE_FAILED',
'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'
},
'logSettings': {
'applicationLogs': {
'sampling': {
'errorLog': 123.0,
'filterLog': 123.0
}
}
},
'connectivityType': 'DEFAULT'|'PUBLIC_INGRESS'|'PUBLIC_EGRESS'|'EXTERNAL_INBOUND',
'errorDetails': [
{
'code': 'VPC_NOT_FOUND'|'EC2_SUBNET_NOT_FOUND'|'EC2_SECURITY_GROUP_NOT_FOUND'|'EC2_SUBNET_IP_EXHAUSTION'|'IAM_ASSUME_ROLE_ACCESS_DENIED'|'INTERNAL_ERROR',
'message': 'string',
'resourceIds': [
'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.
logSettings (dict) --
Describes the settings for a link log.
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.
connectivityType (string) --
The connectivity type of the link.
errorDetails (list) --
The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
(dict) --
Describes one cause of a failure of a resource or an update, with an error code, a description, and the IDs of the resources involved.
code (string) --
The error code for what failed.
message (string) --
A description of the failure.
resourceIds (list) --
The IDs of the resources involved, such as a subnet or security group.
(string) --
linkId (string) --
The unique identifier of the link.
{'clientToken': 'string'}
Response {'status': {'DELETE_FAILED', 'CREATE_FAILED'}, 'updateId': 'string'}
Updates the configuration of a link between gateways.
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
}
}
},
timeoutInMillis=123,
clientToken='string'
)
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.
integer
The timeout value in milliseconds.
string
A unique, case-sensitive identifier for the request. The SDK generates one when you don't.
This field is autopopulated if not provided.
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'|'CREATE_FAILED'|'DELETE_FAILED',
'updateId': 'string'
}
Response Structure
(dict) --
linkId (string) --
The unique identifier of the link.
status (string) --
The status of the request.
updateId (string) --
The ID of the update this call started.
{'status': {'DELETE_FAILED', 'CREATE_FAILED'}, 'updateId': 'string'}
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]
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
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'|'CREATE_FAILED'|'DELETE_FAILED',
'updateId': '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.
updateId (string) --
The ID of the update this call started.
{'clientToken': 'string'}
Response {'status': {'CREATE_FAILED', 'DELETE_FAILED'}, 'updateId': 'string'}
Updates a routing rule for a link.
See also: AWS API Documentation
Request Syntax
client.update_link_routing_rule(
gatewayId='string',
linkId='string',
ruleId='string',
priority=123,
conditions={
'hostHeader': 'string',
'hostHeaderWildcard': 'string',
'pathPrefix': 'string',
'pathExact': 'string',
'queryStringEquals': {
'key': 'string',
'value': 'string'
},
'queryStringExists': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The unique identifier of the gateway.
string
[REQUIRED]
The unique identifier of the link.
string
[REQUIRED]
The unique identifier of the routing rule.
integer
[REQUIRED]
The updated priority of the routing rule. Lower numbers are evaluated first. Valid values are 1 to 1000. Priority must be unique among non-deleted rules within a link.
dict
[REQUIRED]
The updated conditions for the routing rule. All specified fields must match for the rule to apply. At least one condition field must be set.
hostHeader (string) --
The exact host header value to match.
hostHeaderWildcard (string) --
A wildcard pattern for host header matching (for example, *.example.com).
pathPrefix (string) --
The path prefix to match. The request path must start with this value. Must start with /.
pathExact (string) --
The exact path to match. Must start with /.
queryStringEquals (dict) --
A query string key-value pair that must be present and match exactly.
key (string) -- [REQUIRED]
The key of the query string parameter to match. Must contain only RFC 3986 unreserved characters.
value (string) -- [REQUIRED]
The value of the query string parameter to match. Must contain only RFC 3986 unreserved characters.
queryStringExists (string) --
A query string key that must be present in the request (any value is accepted).
string
A unique, case-sensitive identifier for the request. The SDK generates one when you don't.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ruleId': 'string',
'status': 'CREATION_IN_PROGRESS'|'ACTIVE'|'UPDATE_IN_PROGRESS'|'DELETION_IN_PROGRESS'|'DELETED'|'FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
'updatedAt': datetime(2015, 1, 1),
'updateId': 'string'
}
Response Structure
(dict) --
ruleId (string) --
The unique identifier of the routing rule.
status (string) --
The status of the routing rule.
updatedAt (datetime) --
The timestamp of when the routing rule was last updated.
updateId (string) --
The ID of the update this call started.
{'status': {'DELETE_FAILED', 'CREATE_FAILED'}}
Updates a requester gateway.
See also: AWS API Documentation
Request Syntax
client.update_requester_gateway(
clientToken='string',
gatewayId='string',
description='string'
)
string
[REQUIRED]
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
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'|'CREATE_FAILED'|'DELETE_FAILED'
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
status (string) --
The status of the request.
{'status': {'DELETE_FAILED', 'CREATE_FAILED'}, 'updateId': 'string'}
Updates the description, Auto Scaling group managed endpoint configuration, trust store configuration, and client routing policy of a responder gateway. This operation also updates the protocols list in the listener configuration.
You cannot change the domainName, port, and protocol values that you set when you create a responder gateway. To change any of them, delete the gateway and create a new one.
See also: AWS API Documentation
Request Syntax
client.update_responder_gateway(
domainName='string',
port=123,
protocol='HTTP'|'HTTPS',
listenerConfig={
'protocols': [
'HTTP'|'HTTPS',
]
},
trustStoreConfiguration={
'certificateAuthorityCertificates': [
'string',
]
},
managedEndpointConfiguration={
'autoScalingGroups': {
'autoScalingGroupNames': [
'string',
],
'roleArn': 'string',
'healthCheckConfig': {
'port': 123,
'path': 'string',
'protocol': 'HTTP'|'HTTPS',
'timeoutMs': 123,
'intervalSeconds': 123,
'statusCodeMatcher': 'string',
'healthyThresholdCount': 123,
'unhealthyThresholdCount': 123
}
},
'eksEndpoints': {
'endpointsResourceName': 'string',
'endpointsResourceNamespace': 'string',
'clusterApiServerEndpointUri': 'string',
'clusterApiServerCaCertificateChain': 'string',
'clusterName': 'string',
'roleArn': 'string'
}
},
clientToken='string',
gatewayId='string',
description='string',
clientRoutingPolicy='AVAILABILITY_ZONE_AFFINITY'|'ANY_AVAILABILITY_ZONE'
)
string
Domain name for the responder gateway. This operation does not change the domain name of an existing gateway. To use a different domain name, delete the gateway and create a new one.
integer
[REQUIRED]
Networking port to use. This operation does not change the port of an existing gateway. To use a different port, delete the gateway and create a new one.
string
[REQUIRED]
Networking protocol to use. This operation does not change the protocol of an existing gateway. To use a different protocol, delete the gateway and create a new one.
dict
The listener configuration for the responder gateway.
protocols (list) -- [REQUIRED]
The protocol for connections from clients to the gateway
(string) --
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.
healthCheckConfig (dict) --
The health check configuration for the Auto Scaling group managed endpoint.
port (integer) -- [REQUIRED]
The port to use for health check probes. Valid range is 80 to 65535.
path (string) -- [REQUIRED]
The destination path for the health check request. Must start with /.
protocol (string) --
The protocol to use for health check probes.
timeoutMs (integer) --
The timeout for each health check probe, in milliseconds. Valid range is 100 to 5000.
intervalSeconds (integer) --
The interval between health check probes, in seconds. Valid range is 5 to 60.
statusCodeMatcher (string) --
The expected HTTP status code or status code pattern from healthy instances. Supports a single code (for example, 200), a range (for example, 200-299), or a comma-separated list (for example, 200,204).
healthyThresholdCount (integer) --
The number of consecutive successful health checks required before an instance is considered healthy. Valid range is 2 to 10.
unhealthyThresholdCount (integer) --
The number of consecutive failed health checks required before an instance is considered unhealthy. Valid range is 2 to 10.
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]
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier of the gateway.
string
An optional description for the responder gateway.
string
The client routing policy of the gateway. This policy controls which Availability Zones RTB Fabric uses to reach the gateway for the requester gateways that send traffic to it. Valid values are the following:
AVAILABILITY_ZONE_AFFINITY: RTB Fabric routes each requester's traffic to gateway capacity in the requester's own Availability Zone when the gateway has capacity available there. Otherwise, RTB Fabric routes the traffic to gateway capacity in the other Availability Zones of the gateway.
ANY_AVAILABILITY_ZONE: RTB Fabric routes each requester's traffic to gateway capacity in every Availability Zone that the subnets of the gateway span. The Availability Zone that the requester is in does not change this.
If you don't specify a value, the gateway keeps its current client routing policy. Changing the policy sets the gateway status to PENDING_UPDATE until the change is complete. RTB Fabric does not support partial Availability Zone affinity, so PARTIAL_AVAILABILITY_ZONE_AFFINITY is not a valid value. For more information, see Configuring Availability Zone affinity in the Amazon Web Services RTB Fabric User Guide.
dict
Response Syntax
{
'gatewayId': 'string',
'status': 'PENDING_CREATION'|'ACTIVE'|'PENDING_DELETION'|'DELETED'|'ERROR'|'PENDING_UPDATE'|'ISOLATED'|'PENDING_ISOLATION'|'PENDING_RESTORATION'|'CREATE_FAILED'|'DELETE_FAILED',
'clientRoutingPolicy': 'AVAILABILITY_ZONE_AFFINITY'|'ANY_AVAILABILITY_ZONE',
'updateId': 'string'
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
status (string) --
The status of the request.
clientRoutingPolicy (string) --
The client routing policy of the gateway. If the operation changed this policy, the gateway uses the new policy after its status returns to ACTIVE. For more information, see Configuring Availability Zone affinity in the Amazon Web Services RTB Fabric User Guide.
updateId (string) --
The ID of the update this call started.