@aws-sdk/client-supplychain 3.658.1 → 3.662.0

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

@@ -0,0 +1,344 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GetDataLakeDatasetRequest, GetDataLakeDatasetResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, SupplyChainClientResolvedConfig } from "../SupplyChainClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetDataLakeDatasetCommand}.
+ */
+export interface GetDataLakeDatasetCommandInput extends GetDataLakeDatasetRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetDataLakeDatasetCommand}.
+ */
+export interface GetDataLakeDatasetCommandOutput extends GetDataLakeDatasetResponse, __MetadataBearer {
+}
+declare const GetDataLakeDatasetCommand_base: {
+    new (input: GetDataLakeDatasetCommandInput): import("@smithy/smithy-client").CommandImpl<GetDataLakeDatasetCommandInput, GetDataLakeDatasetCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetDataLakeDatasetCommandInput): import("@smithy/smithy-client").CommandImpl<GetDataLakeDatasetCommandInput, GetDataLakeDatasetCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Get a data lake dataset.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SupplyChainClient, GetDataLakeDatasetCommand } from "@aws-sdk/client-supplychain"; // ES Modules import
+ * // const { SupplyChainClient, GetDataLakeDatasetCommand } = require("@aws-sdk/client-supplychain"); // CommonJS import
+ * const client = new SupplyChainClient(config);
+ * const input = { // GetDataLakeDatasetRequest
+ *   instanceId: "STRING_VALUE", // required
+ *   namespace: "STRING_VALUE", // required
+ *   name: "STRING_VALUE", // required
+ * };
+ * const command = new GetDataLakeDatasetCommand(input);
+ * const response = await client.send(command);
+ * // { // GetDataLakeDatasetResponse
+ * //   dataset: { // DataLakeDataset
+ * //     instanceId: "STRING_VALUE", // required
+ * //     namespace: "STRING_VALUE", // required
+ * //     name: "STRING_VALUE", // required
+ * //     arn: "STRING_VALUE", // required
+ * //     schema: { // DataLakeDatasetSchema
+ * //       name: "STRING_VALUE", // required
+ * //       fields: [ // DataLakeDatasetSchemaFieldList // required
+ * //         { // DataLakeDatasetSchemaField
+ * //           name: "STRING_VALUE", // required
+ * //           type: "INT" || "DOUBLE" || "STRING" || "TIMESTAMP", // required
+ * //           isRequired: true || false, // required
+ * //         },
+ * //       ],
+ * //     },
+ * //     description: "STRING_VALUE",
+ * //     createdTime: new Date("TIMESTAMP"), // required
+ * //     lastModifiedTime: new Date("TIMESTAMP"), // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetDataLakeDatasetCommandInput - {@link GetDataLakeDatasetCommandInput}
+ * @returns {@link GetDataLakeDatasetCommandOutput}
+ * @see {@link GetDataLakeDatasetCommandInput} for command's `input` shape.
+ * @see {@link GetDataLakeDatasetCommandOutput} 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 Get properties of an existing AWS Supply Chain inbound order dataset
+ * ```javascript
+ * //
+ * const input = {
+ *   "name": "inbound_order",
+ *   "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *   "namespace": "asc"
+ * };
+ * const command = new GetDataLakeDatasetCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "dataset": {
+ *     "name": "inbound_order",
+ *     "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/asc/datasets/inbound_order",
+ *     "createdTime": 1727116807.751,
+ *     "description": "This is an AWS Supply Chain inbound order dataset",
+ *     "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *     "lastModifiedTime": 1727116807.751,
+ *     "namespace": "asc",
+ *     "schema": {
+ *       "name": "InboundOrder",
+ *       "fields": [
+ *         {
+ *           "name": "id",
+ *           "type": "STRING",
+ *           "isRequired": true
+ *         },
+ *         {
+ *           "name": "tpartner_id",
+ *           "type": "STRING",
+ *           "isRequired": true
+ *         },
+ *         {
+ *           "name": "connection_id",
+ *           "type": "STRING",
+ *           "isRequired": true
+ *         },
+ *         {
+ *           "name": "order_type",
+ *           "type": "STRING",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "order_status",
+ *           "type": "STRING",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "inbound_order_url",
+ *           "type": "STRING",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "order_creation_date",
+ *           "type": "TIMESTAMP",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "company_id",
+ *           "type": "STRING",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "to_site_id",
+ *           "type": "STRING",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "order_currency_uom",
+ *           "type": "STRING",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "vendor_currency_uom",
+ *           "type": "STRING",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "exchange_rate",
+ *           "type": "DOUBLE",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "exchange_rate_date",
+ *           "type": "TIMESTAMP",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "incoterm",
+ *           "type": "STRING",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "incoterm2",
+ *           "type": "STRING",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "incoterm_location_1",
+ *           "type": "STRING",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "incoterm_location_2",
+ *           "type": "STRING",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "submitted_date",
+ *           "type": "TIMESTAMP",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "agreement_start_date",
+ *           "type": "TIMESTAMP",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "agreement_end_date",
+ *           "type": "TIMESTAMP",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "shipping_instr_code",
+ *           "type": "STRING",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "payment_terms_code",
+ *           "type": "STRING",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "std_terms_agreement",
+ *           "type": "STRING",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "std_terms_agreement_ver",
+ *           "type": "STRING",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "agreement_number",
+ *           "type": "STRING",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "source",
+ *           "type": "STRING",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "source_update_dttm",
+ *           "type": "TIMESTAMP",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "source_event_id",
+ *           "type": "STRING",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "db_creation_dttm",
+ *           "type": "TIMESTAMP",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "db_updation_dttm",
+ *           "type": "TIMESTAMP",
+ *           "isRequired": false
+ *         }
+ *       ]
+ *     }
+ *   }
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ * @example Get proporties of an existing custom dataset
+ * ```javascript
+ * //
+ * const input = {
+ *   "name": "my_dataset",
+ *   "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *   "namespace": "default"
+ * };
+ * const command = new GetDataLakeDatasetCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "dataset": {
+ *     "name": "my_dataset",
+ *     "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/default/datasets/my_dataset",
+ *     "createdTime": 1727116807.751,
+ *     "description": "This is a custom dataset",
+ *     "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *     "lastModifiedTime": 1727116807.751,
+ *     "namespace": "default",
+ *     "schema": {
+ *       "name": "MyDataset",
+ *       "fields": [
+ *         {
+ *           "name": "id",
+ *           "type": "INT",
+ *           "isRequired": true
+ *         },
+ *         {
+ *           "name": "description",
+ *           "type": "STRING",
+ *           "isRequired": true
+ *         },
+ *         {
+ *           "name": "price",
+ *           "type": "DOUBLE",
+ *           "isRequired": false
+ *         },
+ *         {
+ *           "name": "creation_time",
+ *           "type": "TIMESTAMP",
+ *           "isRequired": false
+ *         }
+ *       ]
+ *     }
+ *   }
+ * }
+ * *\/
+ * // example id: example-2
+ * ```
+ *
+ */
+export declare class GetDataLakeDatasetCommand extends GetDataLakeDatasetCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetDataLakeDatasetRequest;
+            output: GetDataLakeDatasetResponse;
+        };
+        sdk: {
+            input: GetDataLakeDatasetCommandInput;
+            output: GetDataLakeDatasetCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,224 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListDataIntegrationFlowsRequest, ListDataIntegrationFlowsResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, SupplyChainClientResolvedConfig } from "../SupplyChainClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListDataIntegrationFlowsCommand}.
+ */
+export interface ListDataIntegrationFlowsCommandInput extends ListDataIntegrationFlowsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListDataIntegrationFlowsCommand}.
+ */
+export interface ListDataIntegrationFlowsCommandOutput extends ListDataIntegrationFlowsResponse, __MetadataBearer {
+}
+declare const ListDataIntegrationFlowsCommand_base: {
+    new (input: ListDataIntegrationFlowsCommandInput): import("@smithy/smithy-client").CommandImpl<ListDataIntegrationFlowsCommandInput, ListDataIntegrationFlowsCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListDataIntegrationFlowsCommandInput): import("@smithy/smithy-client").CommandImpl<ListDataIntegrationFlowsCommandInput, ListDataIntegrationFlowsCommandOutput, SupplyChainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists all the DataIntegrationFlows in a paginated way.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SupplyChainClient, ListDataIntegrationFlowsCommand } from "@aws-sdk/client-supplychain"; // ES Modules import
+ * // const { SupplyChainClient, ListDataIntegrationFlowsCommand } = require("@aws-sdk/client-supplychain"); // CommonJS import
+ * const client = new SupplyChainClient(config);
+ * const input = { // ListDataIntegrationFlowsRequest
+ *   instanceId: "STRING_VALUE", // required
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
+ * const command = new ListDataIntegrationFlowsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListDataIntegrationFlowsResponse
+ * //   flows: [ // DataIntegrationFlowList // required
+ * //     { // 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
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListDataIntegrationFlowsCommandInput - {@link ListDataIntegrationFlowsCommandInput}
+ * @returns {@link ListDataIntegrationFlowsCommandOutput}
+ * @see {@link ListDataIntegrationFlowsCommandInput} for command's `input` shape.
+ * @see {@link ListDataIntegrationFlowsCommandOutput} 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 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 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 SupplyChainServiceException}
+ * <p>Base exception class for all service exceptions from SupplyChain service.</p>
+ *
+ * @public
+ * @example Successful ListDataIntegrationFlow
+ * ```javascript
+ * //
+ * const input = {
+ *   "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d"
+ * };
+ * const command = new ListDataIntegrationFlowsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "flows": [
+ *     {
+ *       "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"
+ *       }
+ *     },
+ *     {
+ *       "name": "trading-partner",
+ *       "createdTime": 17235763506.88,
+ *       "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d",
+ *       "lastModifiedTime": 17235763506.88,
+ *       "sources": [
+ *         {
+ *           "datasetSource": {
+ *             "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset1"
+ *           },
+ *           "sourceName": "testSourceName1",
+ *           "sourceType": "DATASET"
+ *         },
+ *         {
+ *           "datasetSource": {
+ *             "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset2"
+ *           },
+ *           "sourceName": "testSourceName2",
+ *           "sourceType": "DATASET"
+ *         }
+ *       ],
+ *       "target": {
+ *         "datasetTarget": {
+ *           "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner"
+ *         },
+ *         "targetType": "DATASET"
+ *       },
+ *       "transformation": {
+ *         "sqlTransformation": {
+ *           "query": "SELECT S1.id AS id, S1.poc_org_unit_description AS description, S1.company_id AS company_id, S1.tpartner_type AS tpartner_type, S1.geo_id AS geo_id, S1.eff_start_date AS eff_start_date, S1.eff_end_date AS eff_end_date FROM testSourceName1 AS S1 LEFT JOIN testSourceName2 as S2 ON S1.id=S2.id"
+ *         },
+ *         "transformationType": "SQL"
+ *       }
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ */
+export declare class ListDataIntegrationFlowsCommand extends ListDataIntegrationFlowsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListDataIntegrationFlowsRequest;
+            output: ListDataIntegrationFlowsResponse;
+        };
+        sdk: {
+            input: ListDataIntegrationFlowsCommandInput;
+            output: ListDataIntegrationFlowsCommandOutput;
+        };
+    };
+}