Modules - AWS RTB Fabric
Built-in modulesConfiguring modulesTroubleshooting

Modules

Modules are configurable components that process RTB traffic flowing through your links. You can use modules to implement rate limiting, filtering, error handling, and other traffic management capabilities. RTB Fabric provides built-in modules that are available at no additional charge, and you can configure them using the RTB Fabric API.

On a link details page, choose the Modules tab to view information about modules that have been configured for the current link. RTB Fabric only supports viewing modules in the console. You can configure modules with the RTB Fabric API using the UpdateLinkModuleFlow operation.

Important

Modules can only be configured on active links. Ensure both gateways are in ACTIVE status and the link is ACTIVE before attempting module configuration.

Built-in modules

RTB Fabric provides the following built-in modules that you can configure for your links:

  • Rate Limiter Module – Controls the rate of requests flowing through the link by limiting transactions per second (TPS). This module helps protect downstream systems from traffic spikes and ensures consistent performance under varying load conditions. Configure using the rateLimiterModule name.

  • OpenRTB Attribute Module – Filters RTB requests based on OpenRTB protocol attributes with configurable actions and holdback percentages. This module enables traffic filtering, A/B testing, and custom response handling. Configure using the openRtbAttributeModule name.

All built-in modules are available at no additional charge. You can configure multiple modules on a single link, and they will be applied in the order you specify during configuration.

Configuring modules

Module configuration is only available through the RTB Fabric API. You cannot configure modules using the RTB Fabric console. Use the UpdateLinkModuleFlow API operation to add, modify, or remove modules from your links.

Rate Limiter Module

The following example shows how to add a QPS rate limiter module to a link using the AWS Command Line Interface (AWS CLI).

Add a QPS rate limiter module to a link

$ aws rtbfabric update-link-module-flow \
--gateway-id rtb-gw-source123 \
--link-id link-abc456def \
--client-token "unique-update-token-789" \
--modules '[
    {
        "name": "rate-limiter-module",
        "version": "1.0.0",
        "dependsOn": [],
        "moduleParameters": {
            "rateLimiter": {
                "tps": 1000.0
            }
        }
    }
]' \
--region us-east-1

OpenRTB Attribute Module

The following example shows how to add an OpenRTB attribute module to a link using the AWS Command Line Interface (AWS CLI).

Add an OpenRTB attribute module to a link

$ aws rtbfabric update-link-module-flow \
--gateway-id rtb-gw-abc123 \
--link-id link-xyz789 \
--modules '[
    {
        "name": "openRtbAttributeModule",
        "version": "20251204-105817",
        "dependsOn": [],
        "moduleParameters": {
            "openRtbAttribute": {
                "filterType": "INCLUDE",
                "filterConfiguration": [],
                "action": {
                    "noBid": {
                        "noBidReasonCode": 1
                    }
                },
                "holdbackPercentage": 10.0
            }
        }
    }
]' \
--region us-east-1

Configuring Multiple Modules

The following example shows how to configure multiple modules on a single link using the AWS Command Line Interface (AWS CLI).

Configure multiple modules on a link

$ aws rtbfabric update-link-module-flow \
--gateway-id rtb-gw-abc123 \
--link-id link-xyz789 \
--modules '[
    {
        "name": "rateLimiterModule",
        "version": "20251204-105817",
        "dependsOn": [],
        "moduleParameters": {
            "rateLimiter": {
                "tps": 1000.0
            }
        }
    },
    {
        "name": "openRtbAttributeModule",
        "version": "20251204-105817",
        "dependsOn": ["rateLimiterModule"],
        "moduleParameters": {
            "openRtbAttribute": {
                "filterType": "INCLUDE",
                "filterConfiguration": [],
                "action": {
                    "noBid": {
                        "noBidReasonCode": 1
                    }
                },
                "holdbackPercentage": 10.0
            }
        }
    }
]' \
--region us-east-1

Viewing Module Configuration

The following example shows how to retrieve the current module configuration for a link using the AWS Command Line Interface (AWS CLI).

View module configuration for a link

$ aws rtbfabric get-link \
--gateway-id rtb-gw-abc123 \
--link-id link-xyz789 \
--region us-east-1

The response includes:

  • flowModules - Currently active module configuration

  • pendingFlowModules - Module configuration pending activation (if any)

Removing Modules

The following example shows how to remove all modules from a link using the AWS Command Line Interface (AWS CLI).

Remove all modules from a link

$ aws rtbfabric update-link-module-flow \
--gateway-id rtb-gw-abc123 \
--link-id link-xyz789 \
--modules '[]' \
--region us-east-1

Troubleshooting

Common Issues:

  • "Resource not ready to be used yet" - Wait for gateways and links to reach ACTIVE status before configuring modules.

  • Module configuration not applied - Check the pendingFlowModules field in the link response to see if configuration is still being processed.

  • Invalid module parameters - Verify parameter names and value types match the module specification exactly.

The following example shows how to check link and module status using the AWS Command Line Interface (AWS CLI).

Check link and module status

$ aws rtbfabric get-link \
--gateway-id <gateway-id> \
--link-id <link-id> \
--query '{Active:flowModules,Pending:pendingFlowModules}' \
--region us-east-1