Skip to content

Commit f2bd79e

Browse files
author
awstools
committed
docs(client-rtbfabric): RTB Fabric documentation update.
1 parent b01ec9b commit f2bd79e

File tree

9 files changed

+16
-16
lines changed

9 files changed

+16
-16
lines changed

clients/client-rtbfabric/src/commands/AcceptLinkCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface AcceptLinkCommandInput extends AcceptLinkRequest {}
2828
export interface AcceptLinkCommandOutput extends AcceptLinkResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Accepts a link request between RTB applications.</p> <p>When a requester RTB application requests to link with a responder RTB application, the responder can use this operation to accept the link request and establish the connection.</p>
31+
* <p>Accepts a link request between gateways.</p> <p>When a requester gateway requests to link with a responder gateway, the responder can use this operation to accept the link request and establish the connection.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-rtbfabric/src/commands/CreateLinkCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface CreateLinkCommandInput extends CreateLinkRequest {}
2828
export interface CreateLinkCommandOutput extends CreateLinkResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a new link between RTB applications.</p> <p>Establishes a connection that allows RTB applications to communicate and exchange bid requests and responses.</p>
31+
* <p>Creates a new link between gateways.</p> <p>Establishes a connection that allows gateways to communicate and exchange bid requests and responses.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-rtbfabric/src/commands/CreateResponderGatewayCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface CreateResponderGatewayCommandInput extends CreateResponderGatew
3232
export interface CreateResponderGatewayCommandOutput extends CreateResponderGatewayResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Creates a responder gateway.</p>
35+
* <p>Creates a responder gateway.</p> <important> <p>A domain name or managed endpoint is required.</p> </important>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.
3838
* ```javascript

clients/client-rtbfabric/src/commands/DeleteLinkCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface DeleteLinkCommandInput extends DeleteLinkRequest {}
2828
export interface DeleteLinkCommandOutput extends DeleteLinkResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes a link between RTB applications.</p> <p>Permanently removes the connection between RTB applications. This action cannot be undone.</p>
31+
* <p>Deletes a link between gateways.</p> <p>Permanently removes the connection between gateways. This action cannot be undone.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-rtbfabric/src/commands/GetLinkCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface GetLinkCommandInput extends GetLinkRequest {}
2828
export interface GetLinkCommandOutput extends GetLinkResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Retrieves information about a link between RTB applications.</p> <p>Returns detailed information about the link configuration, status, and associated RTB applications.</p>
31+
* <p>Retrieves information about a link between gateways.</p> <p>Returns detailed information about the link configuration, status, and associated gateways.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-rtbfabric/src/commands/ListLinksCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface ListLinksCommandInput extends ListLinksRequest {}
2828
export interface ListLinksCommandOutput extends ListLinksResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Lists links associated with an RTB application.</p> <p>Returns a list of all links for the specified RTB application, including their status and configuration details.</p>
31+
* <p>Lists links associated with gateways.</p> <p>Returns a list of all links for the specified gateways, including their status and configuration details.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-rtbfabric/src/commands/RejectLinkCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface RejectLinkCommandInput extends RejectLinkRequest {}
2828
export interface RejectLinkCommandOutput extends RejectLinkResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Rejects a link request between RTB applications.</p> <p>When a requester RTB application requests to link with a responder RTB application, the responder can use this operation to decline the link request.</p>
31+
* <p>Rejects a link request between gateways.</p> <p>When a requester gateway requests to link with a responder gateway, the responder can use this operation to decline the link request.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-rtbfabric/src/commands/UpdateLinkCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface UpdateLinkCommandInput extends UpdateLinkRequest {}
2828
export interface UpdateLinkCommandOutput extends UpdateLinkResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Updates the configuration of a link between RTB applications.</p> <p>Allows you to modify settings and parameters for an existing link.</p>
31+
* <p>Updates the configuration of a link between gateways.</p> <p>Allows you to modify settings and parameters for an existing link.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

codegen/sdk-codegen/aws-models/rtbfabric.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
}
3131
],
3232
"traits": {
33-
"smithy.api#documentation": "<p>Accepts a link request between RTB applications.</p> <p>When a requester RTB application requests to link with a responder RTB application, the responder can use this operation to accept the link request and establish the connection.</p>",
33+
"smithy.api#documentation": "<p>Accepts a link request between gateways.</p> <p>When a requester gateway requests to link with a responder gateway, the responder can use this operation to accept the link request and establish the connection.</p>",
3434
"smithy.api#examples": [
3535
{
3636
"title": "Accept a link request",
@@ -482,7 +482,7 @@
482482
}
483483
],
484484
"traits": {
485-
"smithy.api#documentation": "<p>Creates a new link between RTB applications.</p> <p>Establishes a connection that allows RTB applications to communicate and exchange bid requests and responses.</p>",
485+
"smithy.api#documentation": "<p>Creates a new link between gateways.</p> <p>Establishes a connection that allows gateways to communicate and exchange bid requests and responses.</p>",
486486
"smithy.api#examples": [
487487
{
488488
"title": "Create a new link",
@@ -996,7 +996,7 @@
996996
}
997997
],
998998
"traits": {
999-
"smithy.api#documentation": "<p>Creates a responder gateway.</p>",
999+
"smithy.api#documentation": "<p>Creates a responder gateway.</p> <important> <p>A domain name or managed endpoint is required.</p> </important>",
10001000
"smithy.api#examples": [
10011001
{
10021002
"title": "Create a responder gateway",
@@ -1312,7 +1312,7 @@
13121312
}
13131313
],
13141314
"traits": {
1315-
"smithy.api#documentation": "<p>Deletes a link between RTB applications.</p> <p>Permanently removes the connection between RTB applications. This action cannot be undone.</p>",
1315+
"smithy.api#documentation": "<p>Deletes a link between gateways.</p> <p>Permanently removes the connection between gateways. This action cannot be undone.</p>",
13161316
"smithy.api#examples": [
13171317
{
13181318
"title": "Delete a link",
@@ -2140,7 +2140,7 @@
21402140
}
21412141
],
21422142
"traits": {
2143-
"smithy.api#documentation": "<p>Retrieves information about a link between RTB applications.</p> <p>Returns detailed information about the link configuration, status, and associated RTB applications.</p>",
2143+
"smithy.api#documentation": "<p>Retrieves information about a link between gateways.</p> <p>Returns detailed information about the link configuration, status, and associated gateways.</p>",
21442144
"smithy.api#examples": [
21452145
{
21462146
"title": "Get link details",
@@ -3461,7 +3461,7 @@
34613461
}
34623462
],
34633463
"traits": {
3464-
"smithy.api#documentation": "<p>Lists links associated with an RTB application.</p> <p>Returns a list of all links for the specified RTB application, including their status and configuration details.</p>",
3464+
"smithy.api#documentation": "<p>Lists links associated with gateways.</p> <p>Returns a list of all links for the specified gateways, including their status and configuration details.</p>",
34653465
"smithy.api#examples": [
34663466
{
34673467
"title": "List links for a gateway",
@@ -4957,7 +4957,7 @@
49574957
}
49584958
],
49594959
"traits": {
4960-
"smithy.api#documentation": "<p>Rejects a link request between RTB applications.</p> <p>When a requester RTB application requests to link with a responder RTB application, the responder can use this operation to decline the link request.</p>",
4960+
"smithy.api#documentation": "<p>Rejects a link request between gateways.</p> <p>When a requester gateway requests to link with a responder gateway, the responder can use this operation to decline the link request.</p>",
49614961
"smithy.api#examples": [
49624962
{
49634963
"title": "Reject a link request",
@@ -5797,7 +5797,7 @@
57975797
}
57985798
],
57995799
"traits": {
5800-
"smithy.api#documentation": "<p>Updates the configuration of a link between RTB applications.</p> <p>Allows you to modify settings and parameters for an existing link.</p>",
5800+
"smithy.api#documentation": "<p>Updates the configuration of a link between gateways.</p> <p>Allows you to modify settings and parameters for an existing link.</p>",
58015801
"smithy.api#examples": [
58025802
{
58035803
"title": "Update link settings",

0 commit comments

Comments
 (0)