AWS rtb-fabric documentation change
Summary
Updated documentation for OpenRTB attribute module configuration, including restructuring CLI command examples, removing endpoint URLs, and adding explicit region parameters. Added new sections for configuring multiple modules, retrieving configurations, removing modules, and checking status.
Security assessment
Changes focus on improving CLI command examples and documentation structure. No security vulnerabilities, fixes, or security features are mentioned. Removed endpoint URL doesn't indicate security remediation but rather standard documentation cleanup.
Diff
diff --git a/rtb-fabric/latest/userguide/modules.md b/rtb-fabric/latest/userguide/modules.md index 2fdfc3bb9..3949b4f15 100644 --- a//rtb-fabric/latest/userguide/modules.md +++ b//rtb-fabric/latest/userguide/modules.md @@ -68 +67,0 @@ The following example shows how to add a QPS rate limiter module to a link using - --endpoint-url https://rtbfabric.us-east-1.amazonaws.com \ @@ -73 +72 @@ The following example shows how to add a QPS rate limiter module to a link using -The OpenRTB attribute module filters RTB requests based on OpenRTB protocol attributes. +The following example shows how to add an OpenRTB attribute module to a link using the AWS Command Line Interface (AWS CLI). @@ -75 +74 @@ The OpenRTB attribute module filters RTB requests based on OpenRTB protocol attr -**Parameters:** +**Add an OpenRTB attribute module to a link** @@ -77 +75,0 @@ The OpenRTB attribute module filters RTB requests based on OpenRTB protocol attr - * `filterType` (String, required) - `INCLUDE` or `EXCLUDE` @@ -79,16 +77 @@ The OpenRTB attribute module filters RTB requests based on OpenRTB protocol attr - * `filterConfiguration` (Array, required) - Collection of filters. Empty array means no filters applied. - - * `action` (Object, required) - Action to perform on filtered requests: - - * No-Bid: `{"noBid": {"noBidReasonCode": <integer>}}` - - * Header Tag: `{"headerTag": {"name": "<string>", "value": "<string>"}}` - - * `holdbackPercentage` (Float, required) - Percentage (0.0-100.0) of requests to pass through regardless of filters - - - - - - aws rtbfabric update-link-module-flow \ - --region us-east-1 \ + $ aws rtbfabric update-link-module-flow \ @@ -115 +98,2 @@ The OpenRTB attribute module filters RTB requests based on OpenRTB protocol attr - ]' + ]' \ + --region us-east-1 @@ -119 +103 @@ The OpenRTB attribute module filters RTB requests based on OpenRTB protocol attr -You can configure multiple modules on a single link. Modules execute in the order specified, with the `dependsOn` field controlling execution dependencies. +The following example shows how to configure multiple modules on a single link using the AWS Command Line Interface (AWS CLI). @@ -120,0 +105 @@ You can configure multiple modules on a single link. Modules execute in the orde +**Configure multiple modules on a link** @@ -122,2 +107,2 @@ You can configure multiple modules on a single link. Modules execute in the orde - aws rtbfabric update-link-module-flow \ - --region us-east-1 \ + + $ aws rtbfabric update-link-module-flow \ @@ -154 +139,2 @@ You can configure multiple modules on a single link. Modules execute in the orde - ]' + ]' \ + --region us-east-1 @@ -158 +144,3 @@ You can configure multiple modules on a single link. Modules execute in the orde -Retrieve the current module configuration for a link using the `GetLink` operation: +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** @@ -161,2 +149 @@ Retrieve the current module configuration for a link using the `GetLink` operati - aws rtbfabric get-link \ - --region us-east-1 \ + $ aws rtbfabric get-link \ @@ -164 +151,2 @@ Retrieve the current module configuration for a link using the `GetLink` operati - --link-id link-xyz789 + --link-id link-xyz789 \ + --region us-east-1 @@ -177 +165,3 @@ The response includes: -To remove all modules from a link, pass an empty modules array: +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** @@ -180,2 +170 @@ To remove all modules from a link, pass an empty modules array: - aws rtbfabric update-link-module-flow \ - --region us-east-1 \ + $ aws rtbfabric update-link-module-flow \ @@ -184 +173,2 @@ To remove all modules from a link, pass an empty modules array: - --modules '[]' + --modules '[]' \ + --region us-east-1 @@ -199 +189 @@ To remove all modules from a link, pass an empty modules array: -Check link and module status: +The following example shows how to check link and module status using the AWS Command Line Interface (AWS CLI). @@ -200,0 +191 @@ Check link and module status: +**Check link and module status** @@ -202,2 +192,0 @@ Check link and module status: - # Check link status - aws rtbfabric get-link --region us-east-1 --gateway-id <gateway-id> --link-id <link-id> --query 'status' @@ -205,2 +194,5 @@ Check link and module status: - # Check module configuration - aws rtbfabric get-link --region us-east-1 --gateway-id <gateway-id> --link-id <link-id> --query '{Active:flowModules,Pending:pendingFlowModules}' + $ aws rtbfabric get-link \ + --gateway-id <gateway-id> \ + --link-id <link-id> \ + --query '{Active:flowModules,Pending:pendingFlowModules}' \ + --region us-east-1