2026/04/10 - RTBFabric - 3 updated api methods
Changes Adds optional health check configuration for Responder Gateways with ASG Managed Endpoints. When provided, RTB Fabric continuously probes customers' instance IPs and routes traffic only to healthy ones, reducing errors during deployments, scaling events, and instance failures.
{'managedEndpointConfiguration': {'autoScalingGroups': {'healthCheckConfig': {'healthyThresholdCount': 'integer',
'intervalSeconds': 'integer',
'path': 'string',
'port': 'integer',
'protocol': 'HTTP '
'| '
'HTTPS',
'statusCodeMatcher': 'string',
'timeoutMs': 'integer',
'unhealthyThresholdCount': 'integer'}}}}
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'
)
string
[REQUIRED]
The unique identifier of the Virtual Private Cloud (VPC).
list
[REQUIRED]
The unique identifiers of the subnets.
(string) --
list
[REQUIRED]
The unique identifiers of the security groups.
(string) --
string
The domain name for the responder gateway.
integer
[REQUIRED]
The networking port to use.
string
[REQUIRED]
The networking protocol to use.
dict
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]
The unique client token.
This field is autopopulated if not provided.
string
An optional description for the responder gateway.
dict
A map of the key-value pairs of the tag or tags to assign to the resource.
(string) --
(string) --
string
The type of gateway. Valid values are EXTERNAL or INTERNAL.
dict
Response Syntax
{
'gatewayId': 'string',
'status': 'PENDING_CREATION'|'ACTIVE'|'PENDING_DELETION'|'DELETED'|'ERROR'|'PENDING_UPDATE'|'ISOLATED'|'PENDING_ISOLATION'|'PENDING_RESTORATION',
'listenerConfig': {
'protocols': [
'HTTP'|'HTTPS',
]
},
'externalInboundEndpoint': 'string'
}
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.
{'managedEndpointConfiguration': {'autoScalingGroups': {'healthCheckConfig': {'healthyThresholdCount': 'integer',
'intervalSeconds': 'integer',
'path': 'string',
'port': 'integer',
'protocol': 'HTTP '
'| '
'HTTPS',
'statusCodeMatcher': 'string',
'timeoutMs': 'integer',
'unhealthyThresholdCount': 'integer'}}}}
Retrieves information about a responder gateway.
See also: AWS API Documentation
Request Syntax
client.get_responder_gateway(
gatewayId='string'
)
string
[REQUIRED]
The unique identifier of the gateway.
dict
Response Syntax
{
'vpcId': 'string',
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'status': 'PENDING_CREATION'|'ACTIVE'|'PENDING_DELETION'|'DELETED'|'ERROR'|'PENDING_UPDATE'|'ISOLATED'|'PENDING_ISOLATION'|'PENDING_RESTORATION',
'description': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'domainName': 'string',
'port': 123,
'protocol': 'HTTP'|'HTTPS',
'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,
'inboundLinksCount': 123,
'gatewayType': 'EXTERNAL'|'INTERNAL',
'externalInboundEndpoint': 'string'
}
Response Structure
(dict) --
vpcId (string) --
The unique identifier of the Virtual Private Cloud (VPC).
subnetIds (list) --
The unique identifiers of the subnets.
(string) --
securityGroupIds (list) --
The unique identifiers of the security groups.
(string) --
status (string) --
The status of the request.
description (string) --
The description of the responder gateway.
createdAt (datetime) --
The timestamp of when the responder gateway was created.
updatedAt (datetime) --
The timestamp of when the responder gateway was updated.
domainName (string) --
The domain name of the responder gateway.
port (integer) --
The networking port.
protocol (string) --
The networking protocol.
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.
inboundLinksCount (integer) --
The count of inbound links for the responder gateway.
gatewayType (string) --
The type of gateway. Valid values are EXTERNAL or INTERNAL.
externalInboundEndpoint (string) --
The external inbound endpoint for the responder gateway.
{'managedEndpointConfiguration': {'autoScalingGroups': {'healthCheckConfig': {'healthyThresholdCount': 'integer',
'intervalSeconds': 'integer',
'path': 'string',
'port': 'integer',
'protocol': 'HTTP '
'| '
'HTTPS',
'statusCodeMatcher': 'string',
'timeoutMs': 'integer',
'unhealthyThresholdCount': 'integer'}}}}
Updates a responder gateway.
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'
)
string
The domain name for the responder gateway.
integer
[REQUIRED]
The networking port to use.
string
[REQUIRED]
The networking protocol to use.
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]
The unique client token.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier of the gateway.
string
An optional description for the responder gateway.
dict
Response Syntax
{
'gatewayId': 'string',
'status': 'PENDING_CREATION'|'ACTIVE'|'PENDING_DELETION'|'DELETED'|'ERROR'|'PENDING_UPDATE'|'ISOLATED'|'PENDING_ISOLATION'|'PENDING_RESTORATION'
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
status (string) --
The status of the request.