@aws-sdk/client-rtbfabric 3.915.0

package/dist-types/commands/RejectLinkCommand.d.ts

@@ -0,0 +1,215 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { RejectLinkRequest, RejectLinkResponse } from "../models/models_0";
+import { RTBFabricClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RTBFabricClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link RejectLinkCommand}.
+ */
+export interface RejectLinkCommandInput extends RejectLinkRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link RejectLinkCommand}.
+ */
+export interface RejectLinkCommandOutput extends RejectLinkResponse, __MetadataBearer {
+}
+declare const RejectLinkCommand_base: {
+    new (input: RejectLinkCommandInput): import("@smithy/smithy-client").CommandImpl<RejectLinkCommandInput, RejectLinkCommandOutput, RTBFabricClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: RejectLinkCommandInput): import("@smithy/smithy-client").CommandImpl<RejectLinkCommandInput, RejectLinkCommandOutput, RTBFabricClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <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>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { RTBFabricClient, RejectLinkCommand } from "@aws-sdk/client-rtbfabric"; // ES Modules import
+ * // const { RTBFabricClient, RejectLinkCommand } = require("@aws-sdk/client-rtbfabric"); // CommonJS import
+ * // import type { RTBFabricClientConfig } from "@aws-sdk/client-rtbfabric";
+ * const config = {}; // type is RTBFabricClientConfig
+ * const client = new RTBFabricClient(config);
+ * const input = { // RejectLinkRequest
+ *   gatewayId: "STRING_VALUE", // required
+ *   linkId: "STRING_VALUE", // required
+ * };
+ * const command = new RejectLinkCommand(input);
+ * const response = await client.send(command);
+ * // { // RejectLinkResponse
+ * //   gatewayId: "STRING_VALUE", // required
+ * //   peerGatewayId: "STRING_VALUE", // required
+ * //   status: "PENDING_CREATION" || "PENDING_REQUEST" || "REQUESTED" || "ACCEPTED" || "ACTIVE" || "REJECTED" || "FAILED" || "PENDING_DELETION" || "DELETED" || "PENDING_UPDATE" || "PENDING_ISOLATION" || "ISOLATED" || "PENDING_RESTORATION", // required
+ * //   createdAt: new Date("TIMESTAMP"), // required
+ * //   updatedAt: new Date("TIMESTAMP"), // required
+ * //   direction: "RESPONSE" || "REQUEST",
+ * //   flowModules: [ // ModuleConfigurationList
+ * //     { // ModuleConfiguration
+ * //       version: "STRING_VALUE",
+ * //       name: "STRING_VALUE", // required
+ * //       dependsOn: [ // FlowModuleNameList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       moduleParameters: { // ModuleParameters Union: only one key present
+ * //         noBid: { // NoBidModuleParameters
+ * //           reason: "STRING_VALUE",
+ * //           reasonCode: Number("int"),
+ * //           passThroughPercentage: Number("float"),
+ * //         },
+ * //         openRtbAttribute: { // OpenRtbAttributeModuleParameters
+ * //           filterType: "INCLUDE" || "EXCLUDE", // required
+ * //           filterConfiguration: [ // FilterConfiguration // required
+ * //             { // Filter
+ * //               criteria: [ // FilterCriteria // required
+ * //                 { // FilterCriterion
+ * //                   path: "STRING_VALUE", // required
+ * //                   values: [ // ValueList // required
+ * //                     "STRING_VALUE",
+ * //                   ],
+ * //                 },
+ * //               ],
+ * //             },
+ * //           ],
+ * //           action: { // Action Union: only one key present
+ * //             noBid: { // NoBidAction
+ * //               noBidReasonCode: Number("int"),
+ * //             },
+ * //             headerTag: { // HeaderTagAction
+ * //               name: "STRING_VALUE", // required
+ * //               value: "STRING_VALUE", // required
+ * //             },
+ * //           },
+ * //           holdbackPercentage: Number("float"), // required
+ * //         },
+ * //       },
+ * //     },
+ * //   ],
+ * //   pendingFlowModules: [
+ * //     {
+ * //       version: "STRING_VALUE",
+ * //       name: "STRING_VALUE", // required
+ * //       dependsOn: [
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       moduleParameters: {//  Union: only one key present
+ * //         noBid: {
+ * //           reason: "STRING_VALUE",
+ * //           reasonCode: Number("int"),
+ * //           passThroughPercentage: Number("float"),
+ * //         },
+ * //         openRtbAttribute: {
+ * //           filterType: "INCLUDE" || "EXCLUDE", // required
+ * //           filterConfiguration: [ // required
+ * //             {
+ * //               criteria: [ // required
+ * //                 {
+ * //                   path: "STRING_VALUE", // required
+ * //                   values: [ // required
+ * //                     "STRING_VALUE",
+ * //                   ],
+ * //                 },
+ * //               ],
+ * //             },
+ * //           ],
+ * //           action: {//  Union: only one key present
+ * //             noBid: {
+ * //               noBidReasonCode: Number("int"),
+ * //             },
+ * //             headerTag: {
+ * //               name: "STRING_VALUE", // required
+ * //               value: "STRING_VALUE", // required
+ * //             },
+ * //           },
+ * //           holdbackPercentage: Number("float"), // required
+ * //         },
+ * //       },
+ * //     },
+ * //   ],
+ * //   attributes: { // LinkAttributes
+ * //     responderErrorMasking: [ // ResponderErrorMasking
+ * //       { // ResponderErrorMaskingForHttpCode
+ * //         httpCode: "STRING_VALUE", // required
+ * //         action: "NO_BID" || "PASSTHROUGH", // required
+ * //         loggingTypes: [ // ResponderErrorMaskingLoggingTypes // required
+ * //           "NONE" || "METRIC" || "RESPONSE",
+ * //         ],
+ * //         responseLoggingPercentage: Number("float"),
+ * //       },
+ * //     ],
+ * //     customerProvidedId: "STRING_VALUE",
+ * //   },
+ * //   linkId: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param RejectLinkCommandInput - {@link RejectLinkCommandInput}
+ * @returns {@link RejectLinkCommandOutput}
+ * @see {@link RejectLinkCommandInput} for command's `input` shape.
+ * @see {@link RejectLinkCommandOutput} for command's `response` shape.
+ * @see {@link RTBFabricClientResolvedConfig | config} for RTBFabricClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request could not be completed because you do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request could not be completed because of a conflict in the current state of the resource.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request could not be completed because of an internal server error. Try your call again.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request could not be completed because the resource does not exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request could not be completed because it fails satisfy the constraints specified by the service.</p>
+ *
+ * @throws {@link RTBFabricServiceException}
+ * <p>Base exception class for all service exceptions from RTBFabric service.</p>
+ *
+ *
+ * @example Reject a link request
+ * ```javascript
+ * // Rejects a requested link request
+ * const input = {
+ *   gatewayId: "rtb-gw-12345678",
+ *   linkId: "link-87654321"
+ * };
+ * const command = new RejectLinkCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   createdAt: "2024-01-15T10:30:00Z",
+ *   gatewayId: "rtb-gw-12345678",
+ *   linkId: "link-87654321",
+ *   peerGatewayId: "rtb-gw-87654321",
+ *   status: "REJECTED",
+ *   updatedAt: "2024-01-15T10:35:00Z"
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class RejectLinkCommand extends RejectLinkCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: RejectLinkRequest;
+            output: RejectLinkResponse;
+        };
+        sdk: {
+            input: RejectLinkCommandInput;
+            output: RejectLinkCommandOutput;
+        };
+    };
+}

package/dist-types/commands/TagResourceCommand.d.ts

@@ -0,0 +1,107 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
+import { RTBFabricClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RTBFabricClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link TagResourceCommand}.
+ */
+export interface TagResourceCommandInput extends TagResourceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link TagResourceCommand}.
+ */
+export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
+}
+declare const TagResourceCommand_base: {
+    new (input: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, RTBFabricClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, RTBFabricClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Assigns one or more tags (key-value pairs) to the specified resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { RTBFabricClient, TagResourceCommand } from "@aws-sdk/client-rtbfabric"; // ES Modules import
+ * // const { RTBFabricClient, TagResourceCommand } = require("@aws-sdk/client-rtbfabric"); // CommonJS import
+ * // import type { RTBFabricClientConfig } from "@aws-sdk/client-rtbfabric";
+ * const config = {}; // type is RTBFabricClientConfig
+ * const client = new RTBFabricClient(config);
+ * const input = { // TagResourceRequest
+ *   resourceArn: "STRING_VALUE", // required
+ *   tags: { // TagsMap // required
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ * };
+ * const command = new TagResourceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
+ * @see {@link TagResourceCommandInput} for command's `input` shape.
+ * @see {@link TagResourceCommandOutput} for command's `response` shape.
+ * @see {@link RTBFabricClientResolvedConfig | config} for RTBFabricClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request could not be completed because you do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request could not be completed because of an internal server error. Try your call again.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request could not be completed because the resource does not exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request could not be completed because it fails satisfy the constraints specified by the service.</p>
+ *
+ * @throws {@link RTBFabricServiceException}
+ * <p>Base exception class for all service exceptions from RTBFabric service.</p>
+ *
+ *
+ * @example Add tags to a resource
+ * ```javascript
+ * // Adds tags to a resource
+ * const input = {
+ *   resourceArn: "arn:aws:rtbfabric:us-east-1:123456789012:gateway/rtb-gw-12345678",
+ *   tags: {
+ *     Environment: "Production",
+ *     Team: "RTB"
+ *   }
+ * };
+ * const command = new TagResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class TagResourceCommand extends TagResourceCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: TagResourceRequest;
+            output: {};
+        };
+        sdk: {
+            input: TagResourceCommandInput;
+            output: TagResourceCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -0,0 +1,107 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
+import { RTBFabricClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RTBFabricClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UntagResourceCommand}.
+ */
+export interface UntagResourceCommandInput extends UntagResourceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UntagResourceCommand}.
+ */
+export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
+}
+declare const UntagResourceCommand_base: {
+    new (input: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, RTBFabricClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, RTBFabricClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Removes a tag or tags from a resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { RTBFabricClient, UntagResourceCommand } from "@aws-sdk/client-rtbfabric"; // ES Modules import
+ * // const { RTBFabricClient, UntagResourceCommand } = require("@aws-sdk/client-rtbfabric"); // CommonJS import
+ * // import type { RTBFabricClientConfig } from "@aws-sdk/client-rtbfabric";
+ * const config = {}; // type is RTBFabricClientConfig
+ * const client = new RTBFabricClient(config);
+ * const input = { // UntagResourceRequest
+ *   resourceArn: "STRING_VALUE", // required
+ *   tagKeys: [ // TagKeyList // required
+ *     "STRING_VALUE",
+ *   ],
+ * };
+ * const command = new UntagResourceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
+ * @see {@link UntagResourceCommandInput} for command's `input` shape.
+ * @see {@link UntagResourceCommandOutput} for command's `response` shape.
+ * @see {@link RTBFabricClientResolvedConfig | config} for RTBFabricClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request could not be completed because you do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request could not be completed because of an internal server error. Try your call again.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request could not be completed because the resource does not exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request could not be completed because it fails satisfy the constraints specified by the service.</p>
+ *
+ * @throws {@link RTBFabricServiceException}
+ * <p>Base exception class for all service exceptions from RTBFabric service.</p>
+ *
+ *
+ * @example Remove tags from a resource
+ * ```javascript
+ * // Removes tags from a resource
+ * const input = {
+ *   resourceArn: "arn:aws:rtbfabric:us-east-1:123456789012:gateway/rtb-gw-12345678",
+ *   tagKeys: [
+ *     "Environment",
+ *     "Team"
+ *   ]
+ * };
+ * const command = new UntagResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class UntagResourceCommand extends UntagResourceCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UntagResourceRequest;
+            output: {};
+        };
+        sdk: {
+            input: UntagResourceCommandInput;
+            output: UntagResourceCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateLinkCommand.d.ts

@@ -0,0 +1,127 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateLinkRequest, UpdateLinkResponse } from "../models/models_0";
+import { RTBFabricClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RTBFabricClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateLinkCommand}.
+ */
+export interface UpdateLinkCommandInput extends UpdateLinkRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateLinkCommand}.
+ */
+export interface UpdateLinkCommandOutput extends UpdateLinkResponse, __MetadataBearer {
+}
+declare const UpdateLinkCommand_base: {
+    new (input: UpdateLinkCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateLinkCommandInput, UpdateLinkCommandOutput, RTBFabricClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateLinkCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateLinkCommandInput, UpdateLinkCommandOutput, RTBFabricClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates the configuration of a link between RTB applications.</p> <p>Allows you to modify settings and parameters for an existing link.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { RTBFabricClient, UpdateLinkCommand } from "@aws-sdk/client-rtbfabric"; // ES Modules import
+ * // const { RTBFabricClient, UpdateLinkCommand } = require("@aws-sdk/client-rtbfabric"); // CommonJS import
+ * // import type { RTBFabricClientConfig } from "@aws-sdk/client-rtbfabric";
+ * const config = {}; // type is RTBFabricClientConfig
+ * const client = new RTBFabricClient(config);
+ * const input = { // UpdateLinkRequest
+ *   gatewayId: "STRING_VALUE", // required
+ *   linkId: "STRING_VALUE", // required
+ *   logSettings: { // LinkLogSettings
+ *     applicationLogs: { // LinkApplicationLogConfiguration
+ *       sampling: { // LinkApplicationLogSampling
+ *         errorLog: Number("double"), // required
+ *         filterLog: Number("double"), // required
+ *       },
+ *     },
+ *   },
+ * };
+ * const command = new UpdateLinkCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateLinkResponse
+ * //   linkId: "STRING_VALUE", // required
+ * //   status: "PENDING_CREATION" || "PENDING_REQUEST" || "REQUESTED" || "ACCEPTED" || "ACTIVE" || "REJECTED" || "FAILED" || "PENDING_DELETION" || "DELETED" || "PENDING_UPDATE" || "PENDING_ISOLATION" || "ISOLATED" || "PENDING_RESTORATION", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateLinkCommandInput - {@link UpdateLinkCommandInput}
+ * @returns {@link UpdateLinkCommandOutput}
+ * @see {@link UpdateLinkCommandInput} for command's `input` shape.
+ * @see {@link UpdateLinkCommandOutput} for command's `response` shape.
+ * @see {@link RTBFabricClientResolvedConfig | config} for RTBFabricClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request could not be completed because you do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request could not be completed because of a conflict in the current state of the resource.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request could not be completed because of an internal server error. Try your call again.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request could not be completed because the resource does not exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request could not be completed because it fails satisfy the constraints specified by the service.</p>
+ *
+ * @throws {@link RTBFabricServiceException}
+ * <p>Base exception class for all service exceptions from RTBFabric service.</p>
+ *
+ *
+ * @example Update link settings
+ * ```javascript
+ * // Updates configuration settings for an existing link
+ * const input = {
+ *   gatewayId: "rtb-gw-12345678",
+ *   linkId: "link-87654321",
+ *   logSettings: {
+ *     applicationLogs: {
+ *       sampling: {
+ *         errorLog: 100.0,
+ *         filterLog: 10.0
+ *       }
+ *     }
+ *   }
+ * };
+ * const command = new UpdateLinkCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   linkId: "link-87654321",
+ *   status: "ACTIVE"
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class UpdateLinkCommand extends UpdateLinkCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateLinkRequest;
+            output: UpdateLinkResponse;
+        };
+        sdk: {
+            input: UpdateLinkCommandInput;
+            output: UpdateLinkCommandOutput;
+        };
+    };
+}