@aws-sdk/client-supplychain 3.658.1 → 3.662.0

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

@@ -0,0 +1,112 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { DeleteDataIntegrationFlowRequest, DeleteDataIntegrationFlowResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, SupplyChainClientResolvedConfig } from "../SupplyChainClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteDataIntegrationFlowCommand}.
+ */
+export interface DeleteDataIntegrationFlowCommandInput extends DeleteDataIntegrationFlowRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteDataIntegrationFlowCommand}.
+ */
+export interface DeleteDataIntegrationFlowCommandOutput extends DeleteDataIntegrationFlowResponse, __MetadataBearer {
+}
+declare const DeleteDataIntegrationFlowCommand_base: {
+    new (input: DeleteDataIntegrationFlowCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteDataIntegrationFlowCommandInput, DeleteDataIntegrationFlowCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: DeleteDataIntegrationFlowCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteDataIntegrationFlowCommandInput, DeleteDataIntegrationFlowCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Delete the DataIntegrationFlow.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SupplyChainClient, DeleteDataIntegrationFlowCommand } from "@aws-sdk/client-supplychain"; // ES Modules import
+ * // const { SupplyChainClient, DeleteDataIntegrationFlowCommand } = require("@aws-sdk/client-supplychain"); // CommonJS import
+ * const client = new SupplyChainClient(config);
+ * const input = { // DeleteDataIntegrationFlowRequest
+ *   instanceId: "STRING_VALUE", // required
+ *   name: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteDataIntegrationFlowCommand(input);
+ * const response = await client.send(command);
+ * // { // DeleteDataIntegrationFlowResponse
+ * //   instanceId: "STRING_VALUE", // required
+ * //   name: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param DeleteDataIntegrationFlowCommandInput - {@link DeleteDataIntegrationFlowCommandInput}
+ * @returns {@link DeleteDataIntegrationFlowCommandOutput}
+ * @see {@link DeleteDataIntegrationFlowCommandInput} for command's `input` shape.
+ * @see {@link DeleteDataIntegrationFlowCommandOutput} 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 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 ThrottlingException} (client fault)
+ *  <p>Request was denied due to request throttling.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Updating or deleting a resource can cause an inconsistent state.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Request would cause a service quota to be exceeded.</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
+ * @example Successful DeleteDataIntegrationFlow
+ * ```javascript
+ * //
+ * const input = {
+ *   "name": "testStagingFlow",
+ *   "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d"
+ * };
+ * const command = new DeleteDataIntegrationFlowCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "name": "testStagingFlow",
+ *   "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d"
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ */
+export declare class DeleteDataIntegrationFlowCommand extends DeleteDataIntegrationFlowCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DeleteDataIntegrationFlowRequest;
+            output: DeleteDataIntegrationFlowResponse;
+        };
+        sdk: {
+            input: DeleteDataIntegrationFlowCommandInput;
+            output: DeleteDataIntegrationFlowCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,136 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { DeleteDataLakeDatasetRequest, DeleteDataLakeDatasetResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, SupplyChainClientResolvedConfig } from "../SupplyChainClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteDataLakeDatasetCommand}.
+ */
+export interface DeleteDataLakeDatasetCommandInput extends DeleteDataLakeDatasetRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteDataLakeDatasetCommand}.
+ */
+export interface DeleteDataLakeDatasetCommandOutput extends DeleteDataLakeDatasetResponse, __MetadataBearer {
+}
+declare const DeleteDataLakeDatasetCommand_base: {
+    new (input: DeleteDataLakeDatasetCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteDataLakeDatasetCommandInput, DeleteDataLakeDatasetCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: DeleteDataLakeDatasetCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteDataLakeDatasetCommandInput, DeleteDataLakeDatasetCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Delete a data lake dataset.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SupplyChainClient, DeleteDataLakeDatasetCommand } from "@aws-sdk/client-supplychain"; // ES Modules import
+ * // const { SupplyChainClient, DeleteDataLakeDatasetCommand } = require("@aws-sdk/client-supplychain"); // CommonJS import
+ * const client = new SupplyChainClient(config);
+ * const input = { // DeleteDataLakeDatasetRequest
+ *   instanceId: "STRING_VALUE", // required
+ *   namespace: "STRING_VALUE", // required
+ *   name: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteDataLakeDatasetCommand(input);
+ * const response = await client.send(command);
+ * // { // DeleteDataLakeDatasetResponse
+ * //   instanceId: "STRING_VALUE", // required
+ * //   namespace: "STRING_VALUE", // required
+ * //   name: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param DeleteDataLakeDatasetCommandInput - {@link DeleteDataLakeDatasetCommandInput}
+ * @returns {@link DeleteDataLakeDatasetCommandOutput}
+ * @see {@link DeleteDataLakeDatasetCommandInput} for command's `input` shape.
+ * @see {@link DeleteDataLakeDatasetCommandOutput} 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 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 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 ConflictException} (client fault)
+ *  <p>Updating or deleting a resource can cause an inconsistent state.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Request would cause a service quota to be exceeded.</p>
+ *
+ * @throws {@link SupplyChainServiceException}
+ * <p>Base exception class for all service exceptions from SupplyChain service.</p>
+ *
+ * @public
+ * @example Delete an AWS Supply Chain inbound_order dataset
+ * ```javascript
+ * //
+ * const input = {
+ *   "name": "inbound_order",
+ *   "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *   "namespace": "asc"
+ * };
+ * const command = new DeleteDataLakeDatasetCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "name": "inbound_order",
+ *   "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *   "namespace": "asc"
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ * @example Delete a custom dataset
+ * ```javascript
+ * //
+ * const input = {
+ *   "name": "my_dataset",
+ *   "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *   "namespace": "default"
+ * };
+ * const command = new DeleteDataLakeDatasetCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "name": "my_dataset",
+ *   "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *   "namespace": "default"
+ * }
+ * *\/
+ * // example id: example-2
+ * ```
+ *
+ */
+export declare class DeleteDataLakeDatasetCommand extends DeleteDataLakeDatasetCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DeleteDataLakeDatasetRequest;
+            output: DeleteDataLakeDatasetResponse;
+        };
+        sdk: {
+            input: DeleteDataLakeDatasetCommandInput;
+            output: DeleteDataLakeDatasetCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,185 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GetDataIntegrationFlowRequest, GetDataIntegrationFlowResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, SupplyChainClientResolvedConfig } from "../SupplyChainClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetDataIntegrationFlowCommand}.
+ */
+export interface GetDataIntegrationFlowCommandInput extends GetDataIntegrationFlowRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetDataIntegrationFlowCommand}.
+ */
+export interface GetDataIntegrationFlowCommandOutput extends GetDataIntegrationFlowResponse, __MetadataBearer {
+}
+declare const GetDataIntegrationFlowCommand_base: {
+    new (input: GetDataIntegrationFlowCommandInput): import("@smithy/smithy-client").CommandImpl<GetDataIntegrationFlowCommandInput, GetDataIntegrationFlowCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetDataIntegrationFlowCommandInput): import("@smithy/smithy-client").CommandImpl<GetDataIntegrationFlowCommandInput, GetDataIntegrationFlowCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>View the DataIntegrationFlow details.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SupplyChainClient, GetDataIntegrationFlowCommand } from "@aws-sdk/client-supplychain"; // ES Modules import
+ * // const { SupplyChainClient, GetDataIntegrationFlowCommand } = require("@aws-sdk/client-supplychain"); // CommonJS import
+ * const client = new SupplyChainClient(config);
+ * const input = { // GetDataIntegrationFlowRequest
+ *   instanceId: "STRING_VALUE", // required
+ *   name: "STRING_VALUE", // required
+ * };
+ * const command = new GetDataIntegrationFlowCommand(input);
+ * const response = await client.send(command);
+ * // { // GetDataIntegrationFlowResponse
+ * //   flow: { // DataIntegrationFlow
+ * //     instanceId: "STRING_VALUE", // required
+ * //     name: "STRING_VALUE", // required
+ * //     sources: [ // DataIntegrationFlowSourceList // required
+ * //       { // DataIntegrationFlowSource
+ * //         sourceType: "S3" || "DATASET", // required
+ * //         sourceName: "STRING_VALUE", // required
+ * //         s3Source: { // DataIntegrationFlowS3SourceConfiguration
+ * //           bucketName: "STRING_VALUE", // required
+ * //           prefix: "STRING_VALUE", // required
+ * //           options: { // DataIntegrationFlowS3Options
+ * //             fileType: "CSV" || "PARQUET" || "JSON",
+ * //           },
+ * //         },
+ * //         datasetSource: { // DataIntegrationFlowDatasetSourceConfiguration
+ * //           datasetIdentifier: "STRING_VALUE", // required
+ * //           options: { // DataIntegrationFlowDatasetOptions
+ * //             loadType: "INCREMENTAL" || "REPLACE",
+ * //             dedupeRecords: true || false,
+ * //           },
+ * //         },
+ * //       },
+ * //     ],
+ * //     transformation: { // DataIntegrationFlowTransformation
+ * //       transformationType: "SQL" || "NONE", // required
+ * //       sqlTransformation: { // DataIntegrationFlowSQLTransformationConfiguration
+ * //         query: "STRING_VALUE", // required
+ * //       },
+ * //     },
+ * //     target: { // DataIntegrationFlowTarget
+ * //       targetType: "S3" || "DATASET", // required
+ * //       s3Target: { // DataIntegrationFlowS3TargetConfiguration
+ * //         bucketName: "STRING_VALUE", // required
+ * //         prefix: "STRING_VALUE", // required
+ * //         options: {
+ * //           fileType: "CSV" || "PARQUET" || "JSON",
+ * //         },
+ * //       },
+ * //       datasetTarget: { // DataIntegrationFlowDatasetTargetConfiguration
+ * //         datasetIdentifier: "STRING_VALUE", // required
+ * //         options: {
+ * //           loadType: "INCREMENTAL" || "REPLACE",
+ * //           dedupeRecords: true || false,
+ * //         },
+ * //       },
+ * //     },
+ * //     createdTime: new Date("TIMESTAMP"), // required
+ * //     lastModifiedTime: new Date("TIMESTAMP"), // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetDataIntegrationFlowCommandInput - {@link GetDataIntegrationFlowCommandInput}
+ * @returns {@link GetDataIntegrationFlowCommandOutput}
+ * @see {@link GetDataIntegrationFlowCommandInput} for command's `input` shape.
+ * @see {@link GetDataIntegrationFlowCommandOutput} 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 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 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 ConflictException} (client fault)
+ *  <p>Updating or deleting a resource can cause an inconsistent state.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Request would cause a service quota to be exceeded.</p>
+ *
+ * @throws {@link SupplyChainServiceException}
+ * <p>Base exception class for all service exceptions from SupplyChain service.</p>
+ *
+ * @public
+ * @example Successful GetDataIntegrationFlow
+ * ```javascript
+ * //
+ * const input = {
+ *   "name": "testStagingFlow",
+ *   "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d"
+ * };
+ * const command = new GetDataIntegrationFlowCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "flow": {
+ *     "name": "testStagingFlow",
+ *     "createdTime": 1724956400.44,
+ *     "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d",
+ *     "lastModifiedTime": 1724956400.44,
+ *     "sources": [
+ *       {
+ *         "s3Source": {
+ *           "bucketName": "aws-supply-chain-data-b8c7bb28-a576-4334-b481-6d6e8e47371f",
+ *           "prefix": "example-prefix"
+ *         },
+ *         "sourceName": "testSourceName",
+ *         "sourceType": "S3"
+ *       }
+ *     ],
+ *     "target": {
+ *       "datasetTarget": {
+ *         "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset"
+ *       },
+ *       "targetType": "DATASET"
+ *     },
+ *     "transformation": {
+ *       "sqlTransformation": {
+ *         "query": "SELECT * FROM testSourceName"
+ *       },
+ *       "transformationType": "SQL"
+ *     }
+ *   }
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ */
+export declare class GetDataIntegrationFlowCommand extends GetDataIntegrationFlowCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetDataIntegrationFlowRequest;
+            output: GetDataIntegrationFlowResponse;
+        };
+        sdk: {
+            input: GetDataIntegrationFlowCommandInput;
+            output: GetDataIntegrationFlowCommandOutput;
+        };
+    };
+}