2026/09/10 - RTBFabric - 3 updated api methods
Changes AWS RTB Fabric now lets you control how traffic is routed to your responder gateway across Availability Zones. Set the new clientRoutingPolicy parameter to keep traffic within the same Availability Zone or distribute traffic across all Availability Zones.
{'clientRoutingPolicy': 'AVAILABILITY_ZONE_AFFINITY | ANY_AVAILABILITY_ZONE'}
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',
'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.
{'clientRoutingPolicy': 'AVAILABILITY_ZONE_AFFINITY | ANY_AVAILABILITY_ZONE'}
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,
'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.
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.
{'clientRoutingPolicy': 'AVAILABILITY_ZONE_AFFINITY | ANY_AVAILABILITY_ZONE'}
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',
'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.
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.