feat(client-supplychain): This release includes API SendDataIntegrationEvent for AWS Supply Chain

awstools · awstools · commit 8c32c69a73df · 2024-04-10T18:15:00.000Z
diff --git a/clients/client-supplychain/README.md b/clients/client-supplychain/README.md
@@ -225,3 +225,11 @@ GetBillOfMaterialsImportJob
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/supplychain/command/GetBillOfMaterialsImportJobCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-supplychain/Interface/GetBillOfMaterialsImportJobCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-supplychain/Interface/GetBillOfMaterialsImportJobCommandOutput/)
 
 </details>
+<details>
+<summary>
+SendDataIntegrationEvent
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/supplychain/command/SendDataIntegrationEventCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-supplychain/Interface/SendDataIntegrationEventCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-supplychain/Interface/SendDataIntegrationEventCommandOutput/)
+
+</details>
diff --git a/clients/client-supplychain/src/SupplyChain.ts b/clients/client-supplychain/src/SupplyChain.ts
@@ -12,11 +12,17 @@ import {
   GetBillOfMaterialsImportJobCommandInput,
   GetBillOfMaterialsImportJobCommandOutput,
 } from "./commands/GetBillOfMaterialsImportJobCommand";
+import {
+  SendDataIntegrationEventCommand,
+  SendDataIntegrationEventCommandInput,
+  SendDataIntegrationEventCommandOutput,
+} from "./commands/SendDataIntegrationEventCommand";
 import { SupplyChainClient, SupplyChainClientConfig } from "./SupplyChainClient";
 
 const commands = {
   CreateBillOfMaterialsImportJobCommand,
   GetBillOfMaterialsImportJobCommand,
+  SendDataIntegrationEventCommand,
 };
 
 export interface SupplyChain {
@@ -53,6 +59,23 @@ export interface SupplyChain {
     options: __HttpHandlerOptions,
     cb: (err: any, data?: GetBillOfMaterialsImportJobCommandOutput) => void
   ): void;
+
+  /**
+   * @see {@link SendDataIntegrationEventCommand}
+   */
+  sendDataIntegrationEvent(
+    args: SendDataIntegrationEventCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<SendDataIntegrationEventCommandOutput>;
+  sendDataIntegrationEvent(
+    args: SendDataIntegrationEventCommandInput,
+    cb: (err: any, data?: SendDataIntegrationEventCommandOutput) => void
+  ): void;
+  sendDataIntegrationEvent(
+    args: SendDataIntegrationEventCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: SendDataIntegrationEventCommandOutput) => void
+  ): void;
 }
 
 /**
diff --git a/clients/client-supplychain/src/SupplyChainClient.ts b/clients/client-supplychain/src/SupplyChainClient.ts
@@ -61,6 +61,10 @@ import {
   GetBillOfMaterialsImportJobCommandInput,
   GetBillOfMaterialsImportJobCommandOutput,
 } from "./commands/GetBillOfMaterialsImportJobCommand";
+import {
+  SendDataIntegrationEventCommandInput,
+  SendDataIntegrationEventCommandOutput,
+} from "./commands/SendDataIntegrationEventCommand";
 import {
   ClientInputEndpointParameters,
   ClientResolvedEndpointParameters,
@@ -75,12 +79,18 @@ export { __Client };
 /**
  * @public
  */
-export type ServiceInputTypes = CreateBillOfMaterialsImportJobCommandInput | GetBillOfMaterialsImportJobCommandInput;
+export type ServiceInputTypes =
+  | CreateBillOfMaterialsImportJobCommandInput
+  | GetBillOfMaterialsImportJobCommandInput
+  | SendDataIntegrationEventCommandInput;
 
 /**
  * @public
  */
-export type ServiceOutputTypes = CreateBillOfMaterialsImportJobCommandOutput | GetBillOfMaterialsImportJobCommandOutput;
+export type ServiceOutputTypes =
+  | CreateBillOfMaterialsImportJobCommandOutput
+  | GetBillOfMaterialsImportJobCommandOutput
+  | SendDataIntegrationEventCommandOutput;
 
 /**
  * @public
diff --git a/clients/client-supplychain/src/commands/SendDataIntegrationEventCommand.ts b/clients/client-supplychain/src/commands/SendDataIntegrationEventCommand.ts
@@ -0,0 +1,111 @@
+// smithy-typescript generated code
+import { getEndpointPlugin } from "@smithy/middleware-endpoint";
+import { getSerdePlugin } from "@smithy/middleware-serde";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+
+import { commonParams } from "../endpoint/EndpointParameters";
+import {
+  SendDataIntegrationEventRequest,
+  SendDataIntegrationEventRequestFilterSensitiveLog,
+  SendDataIntegrationEventResponse,
+} from "../models/models_0";
+import { de_SendDataIntegrationEventCommand, se_SendDataIntegrationEventCommand } from "../protocols/Aws_restJson1";
+import { ServiceInputTypes, ServiceOutputTypes, SupplyChainClientResolvedConfig } from "../SupplyChainClient";
+
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link SendDataIntegrationEventCommand}.
+ */
+export interface SendDataIntegrationEventCommandInput extends SendDataIntegrationEventRequest {}
+/**
+ * @public
+ *
+ * The output of {@link SendDataIntegrationEventCommand}.
+ */
+export interface SendDataIntegrationEventCommandOutput extends SendDataIntegrationEventResponse, __MetadataBearer {}
+
+/**
+ * <p>Send transactional data events with real-time data for analysis or monitoring.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SupplyChainClient, SendDataIntegrationEventCommand } from "@aws-sdk/client-supplychain"; // ES Modules import
+ * // const { SupplyChainClient, SendDataIntegrationEventCommand } = require("@aws-sdk/client-supplychain"); // CommonJS import
+ * const client = new SupplyChainClient(config);
+ * const input = { // SendDataIntegrationEventRequest
+ *   instanceId: "STRING_VALUE", // required
+ *   eventType: "scn.data.forecast" || "scn.data.inventorylevel" || "scn.data.inboundorder" || "scn.data.inboundorderline" || "scn.data.inboundorderlineschedule" || "scn.data.outboundorderline" || "scn.data.outboundshipment" || "scn.data.processheader" || "scn.data.processoperation" || "scn.data.processproduct" || "scn.data.reservation" || "scn.data.shipment" || "scn.data.shipmentstop" || "scn.data.shipmentstoporder" || "scn.data.supplyplan", // required
+ *   data: "STRING_VALUE", // required
+ *   eventGroupId: "STRING_VALUE", // required
+ *   eventTimestamp: new Date("TIMESTAMP"),
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new SendDataIntegrationEventCommand(input);
+ * const response = await client.send(command);
+ * // { // SendDataIntegrationEventResponse
+ * //   eventId: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param SendDataIntegrationEventCommandInput - {@link SendDataIntegrationEventCommandInput}
+ * @returns {@link SendDataIntegrationEventCommandOutput}
+ * @see {@link SendDataIntegrationEventCommandInput} for command's `input` shape.
+ * @see {@link SendDataIntegrationEventCommandOutput} for command's `response` shape.
+ * @see {@link SupplyChainClientResolvedConfig | config} for SupplyChainClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have the required privileges to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Updating or deleting a resource can cause an inconsistent state.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error during processing of request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource which does not exist.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Request would cause a service quota to be exceeded.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input does not satisfy the constraints specified by an AWS service.</p>
+ *
+ * @throws {@link SupplyChainServiceException}
+ * <p>Base exception class for all service exceptions from SupplyChain service.</p>
+ *
+ * @public
+ */
+export class SendDataIntegrationEventCommand extends $Command
+  .classBuilder<
+    SendDataIntegrationEventCommandInput,
+    SendDataIntegrationEventCommandOutput,
+    SupplyChainClientResolvedConfig,
+    ServiceInputTypes,
+    ServiceOutputTypes
+  >()
+  .ep({
+    ...commonParams,
+  })
+  .m(function (this: any, Command: any, cs: any, config: SupplyChainClientResolvedConfig, o: any) {
+    return [
+      getSerdePlugin(config, this.serialize, this.deserialize),
+      getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
+    ];
+  })
+  .s("GalaxyPublicAPIGateway", "SendDataIntegrationEvent", {})
+  .n("SupplyChainClient", "SendDataIntegrationEventCommand")
+  .f(SendDataIntegrationEventRequestFilterSensitiveLog, void 0)
+  .ser(se_SendDataIntegrationEventCommand)
+  .de(de_SendDataIntegrationEventCommand)
+  .build() {}
diff --git a/clients/client-supplychain/src/commands/index.ts b/clients/client-supplychain/src/commands/index.ts
@@ -1,3 +1,4 @@
 // smithy-typescript generated code
 export * from "./CreateBillOfMaterialsImportJobCommand";
 export * from "./GetBillOfMaterialsImportJobCommand";
+export * from "./SendDataIntegrationEventCommand";
diff --git a/clients/client-supplychain/src/models/models_0.ts b/clients/client-supplychain/src/models/models_0.ts
@@ -1,5 +1,5 @@
 // smithy-typescript generated code
-import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client";
 
 import { SupplyChainServiceException as __BaseException } from "./SupplyChainServiceException";
 
@@ -265,3 +265,92 @@ export interface GetBillOfMaterialsImportJobResponse {
    */
   job: BillOfMaterialsImportJob | undefined;
 }
+
+/**
+ * @public
+ * @enum
+ */
+export const DataIntegrationEventType = {
+  FORECAST: "scn.data.forecast",
+  INBOUND_ORDER: "scn.data.inboundorder",
+  INBOUND_ORDER_LINE: "scn.data.inboundorderline",
+  INBOUND_ORDER_LINE_SCHEDULE: "scn.data.inboundorderlineschedule",
+  INVENTORY_LEVEL: "scn.data.inventorylevel",
+  OUTBOUND_ORDER_LINE: "scn.data.outboundorderline",
+  OUTBOUND_SHIPMENT: "scn.data.outboundshipment",
+  PROCESS_HEADER: "scn.data.processheader",
+  PROCESS_OPERATION: "scn.data.processoperation",
+  PROCESS_PRODUCT: "scn.data.processproduct",
+  RESERVATION: "scn.data.reservation",
+  SHIPMENT: "scn.data.shipment",
+  SHIPMENT_STOP: "scn.data.shipmentstop",
+  SHIPMENT_STOP_ORDER: "scn.data.shipmentstoporder",
+  SUPPLY_PLAN: "scn.data.supplyplan",
+} as const;
+
+/**
+ * @public
+ */
+export type DataIntegrationEventType = (typeof DataIntegrationEventType)[keyof typeof DataIntegrationEventType];
+
+/**
+ * <p>The request parameters for SendDataIntegrationEvent.</p>
+ * @public
+ */
+export interface SendDataIntegrationEventRequest {
+  /**
+   * <p>The AWS Supply Chain instance identifier.</p>
+   * @public
+   */
+  instanceId: string | undefined;
+
+  /**
+   * <p>The data event type.</p>
+   * @public
+   */
+  eventType: DataIntegrationEventType | undefined;
+
+  /**
+   * <p>The data payload of the event.</p>
+   * @public
+   */
+  data: string | undefined;
+
+  /**
+   * <p>Event identifier (for example, orderId for InboundOrder) used for data sharing or partitioning.</p>
+   * @public
+   */
+  eventGroupId: string | undefined;
+
+  /**
+   * <p>The event timestamp (in epoch seconds).</p>
+   * @public
+   */
+  eventTimestamp?: Date;
+
+  /**
+   * <p>The idempotent client token.</p>
+   * @public
+   */
+  clientToken?: string;
+}
+
+/**
+ * <p>The response parameters for SendDataIntegrationEvent.</p>
+ * @public
+ */
+export interface SendDataIntegrationEventResponse {
+  /**
+   * <p>The unique event identifier.</p>
+   * @public
+   */
+  eventId: string | undefined;
+}
+
+/**
+ * @internal
+ */
+export const SendDataIntegrationEventRequestFilterSensitiveLog = (obj: SendDataIntegrationEventRequest): any => ({
+  ...obj,
+  ...(obj.data && { data: SENSITIVE_STRING }),
+});
diff --git a/clients/client-supplychain/src/protocols/Aws_restJson1.ts b/clients/client-supplychain/src/protocols/Aws_restJson1.ts
@@ -29,6 +29,10 @@ import {
   GetBillOfMaterialsImportJobCommandInput,
   GetBillOfMaterialsImportJobCommandOutput,
 } from "../commands/GetBillOfMaterialsImportJobCommand";
+import {
+  SendDataIntegrationEventCommandInput,
+  SendDataIntegrationEventCommandOutput,
+} from "../commands/SendDataIntegrationEventCommand";
 import {
   AccessDeniedException,
   ConflictException,
@@ -81,6 +85,33 @@ export const se_GetBillOfMaterialsImportJobCommand = async (
   return b.build();
 };
 
+/**
+ * serializeAws_restJson1SendDataIntegrationEventCommand
+ */
+export const se_SendDataIntegrationEventCommand = async (
+  input: SendDataIntegrationEventCommandInput,
+  context: __SerdeContext
+): Promise<__HttpRequest> => {
+  const b = rb(input, context);
+  const headers: any = {
+    "content-type": "application/json",
+  };
+  b.bp("/api-data/data-integration/instance/{instanceId}/data-integration-events");
+  b.p("instanceId", () => input.instanceId!, "{instanceId}", false);
+  let body: any;
+  body = JSON.stringify(
+    take(input, {
+      clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
+      data: [],
+      eventGroupId: [],
+      eventTimestamp: (_) => Math.round(_.getTime() / 1000),
+      eventType: [],
+    })
+  );
+  b.m("POST").h(headers).b(body);
+  return b.build();
+};
+
 /**
  * deserializeAws_restJson1CreateBillOfMaterialsImportJobCommand
  */
@@ -123,6 +154,27 @@ export const de_GetBillOfMaterialsImportJobCommand = async (
   return contents;
 };
 
+/**
+ * deserializeAws_restJson1SendDataIntegrationEventCommand
+ */
+export const de_SendDataIntegrationEventCommand = async (
+  output: __HttpResponse,
+  context: __SerdeContext
+): Promise<SendDataIntegrationEventCommandOutput> => {
+  if (output.statusCode !== 200 && output.statusCode >= 300) {
+    return de_CommandError(output, context);
+  }
+  const contents: any = map({
+    $metadata: deserializeMetadata(output),
+  });
+  const data: Record<string, any> = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
+  const doc = take(data, {
+    eventId: __expectString,
+  });
+  Object.assign(contents, doc);
+  return contents;
+};
+
 /**
  * deserialize_Aws_restJson1CommandError
  */
diff --git a/codegen/sdk-codegen/aws-models/supplychain.json b/codegen/sdk-codegen/aws-models/supplychain.json
