2026/05/13 - RTBFabric - 9 new api methods
Changes Customers can now configure custom domain names for their RTB Fabric gateways. This enables partners to use their own branded domain for RTB traffic instead of the default rtbfabric endpoint
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)
}
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.
Associates an ACM certificate with a responder gateway.
See also: AWS API Documentation
Request Syntax
client.associate_certificate(
gatewayId='string',
acmCertificateArn='string',
clientToken='string'
)
string
[REQUIRED]
The unique identifier of the gateway.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the ACM certificate to associate.
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.
dict
Response Syntax
{
'gatewayId': 'string',
'acmCertificateArn': 'string',
'status': 'PENDING_ASSOCIATION'|'ASSOCIATED'|'PENDING_DISASSOCIATION'|'DISASSOCIATED'|'FAILED'
}
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.
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'
}
Response Structure
(dict) --
ruleId (string) --
The unique identifier of the routing rule.
status (string) --
The status of the routing rule.
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',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
rules (list) --
The list of routing rules for the link.
(dict) --
Summary of a routing rule for list responses
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) --
Exact host match — RFC 3986 unreserved characters
hostHeaderWildcard (string) --
Wildcard host pattern (e.g., *.example.com) — RFC 3986 unreserved plus *
pathPrefix (string) --
Path prefix matching — strict starts-with, no wildcard (preferred for new rules). Must start with /; RFC 3986 unreserved plus /
pathExact (string) --
Exact path match — must start with /; RFC 3986 unreserved plus /
queryStringEquals (dict) --
Query string key=value pair match (single pair)
key (string) --
RFC 3986 unreserved characters
value (string) --
RFC 3986 unreserved characters
queryStringExists (string) --
Query string key presence check (any value accepted) — RFC 3986 unreserved characters
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.
nextToken (string) --
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Updates a 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'
}
)
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) --
Exact host match — RFC 3986 unreserved characters
hostHeaderWildcard (string) --
Wildcard host pattern (e.g., *.example.com) — RFC 3986 unreserved plus *
pathPrefix (string) --
Path prefix matching — strict starts-with, no wildcard (preferred for new rules). Must start with /; RFC 3986 unreserved plus /
pathExact (string) --
Exact path match — must start with /; RFC 3986 unreserved plus /
queryStringEquals (dict) --
Query string key=value pair match (single pair)
key (string) -- [REQUIRED]
RFC 3986 unreserved characters
value (string) -- [REQUIRED]
RFC 3986 unreserved characters
queryStringExists (string) --
Query string key presence check (any value accepted) — RFC 3986 unreserved characters
dict
Response Syntax
{
'ruleId': 'string',
'status': 'CREATION_IN_PROGRESS'|'ACTIVE'|'UPDATE_IN_PROGRESS'|'DELETION_IN_PROGRESS'|'DELETED'|'FAILED',
'updatedAt': datetime(2015, 1, 1)
}
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.
Removes a certificate association from a responder gateway.
See also: AWS API Documentation
Request Syntax
client.disassociate_certificate(
gatewayId='string',
acmCertificateArn='string'
)
string
[REQUIRED]
The unique identifier of the gateway.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the ACM certificate to disassociate.
dict
Response Syntax
{
'gatewayId': 'string',
'acmCertificateArn': 'string',
'status': 'PENDING_ASSOCIATION'|'ASSOCIATED'|'PENDING_DISASSOCIATION'|'DISASSOCIATED'|'FAILED'
}
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.
Lists the certificate associations for a responder gateway.
See also: AWS API Documentation
Request Syntax
client.list_certificate_associations(
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
{
'certificateAssociations': [
{
'acmCertificateArn': 'string',
'status': 'PENDING_ASSOCIATION'|'ASSOCIATED'|'PENDING_DISASSOCIATION'|'DISASSOCIATED'|'FAILED',
'associatedAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
certificateAssociations (list) --
The list of certificate associations for the gateway.
(dict) --
Describes a summary of a certificate association.
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.
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.
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) --
Exact host match — RFC 3986 unreserved characters
hostHeaderWildcard (string) --
Wildcard host pattern (e.g., *.example.com) — RFC 3986 unreserved plus *
pathPrefix (string) --
Path prefix matching — strict starts-with, no wildcard (preferred for new rules). Must start with /; RFC 3986 unreserved plus /
pathExact (string) --
Exact path match — must start with /; RFC 3986 unreserved plus /
queryStringEquals (dict) --
Query string key=value pair match (single pair)
key (string) -- [REQUIRED]
RFC 3986 unreserved characters
value (string) -- [REQUIRED]
RFC 3986 unreserved characters
queryStringExists (string) --
Query string key presence check (any value accepted) — RFC 3986 unreserved characters
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',
'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.
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',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
gatewayId (string) --
The unique identifier of the gateway.
linkId (string) --
The unique identifier of the link.
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) --
Exact host match — RFC 3986 unreserved characters
hostHeaderWildcard (string) --
Wildcard host pattern (e.g., *.example.com) — RFC 3986 unreserved plus *
pathPrefix (string) --
Path prefix matching — strict starts-with, no wildcard (preferred for new rules). Must start with /; RFC 3986 unreserved plus /
pathExact (string) --
Exact path match — must start with /; RFC 3986 unreserved plus /
queryStringEquals (dict) --
Query string key=value pair match (single pair)
key (string) --
RFC 3986 unreserved characters
value (string) --
RFC 3986 unreserved characters
queryStringExists (string) --
Query string key presence check (any value accepted) — RFC 3986 unreserved characters
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) --