@aws-sdk/client-supplychain 3.661.0 → 3.662.0

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

@@ -124,6 +124,98 @@ declare const CreateDataIntegrationFlowCommand_base: {
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
  *
  * @public
+ * @example Successful CreateDataIntegrationFlow for s3 to dataset flow
+ * ```javascript
+ * //
+ * const input = {
+ *   "name": "testStagingFlow",
+ *   "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d",
+ *   "sources": [
+ *     {
+ *       "s3Source": {
+ *         "bucketName": "aws-supply-chain-data-b8c7bb28-a576-4334-b481-6d6e8e47371f",
+ *         "prefix": "example-prefix"
+ *       },
+ *       "sourceName": "testSourceName",
+ *       "sourceType": "S3"
+ *     }
+ *   ],
+ *   "tags": {
+ *     "tagKey1": "tagValue1"
+ *   },
+ *   "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"
+ *   }
+ * };
+ * const command = new CreateDataIntegrationFlowCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "name": "testStagingFlow",
+ *   "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d"
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ * @example Successful CreateDataIntegrationFlow for dataset to dataset flow
+ * ```javascript
+ * //
+ * const input = {
+ *   "name": "trading-partner",
+ *   "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d",
+ *   "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"
+ *     }
+ *   ],
+ *   "tags": {
+ *     "tagKey1": "tagValue1"
+ *   },
+ *   "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"
+ *   }
+ * };
+ * const command = new CreateDataIntegrationFlowCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "name": "trading-partner",
+ *   "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d"
+ * }
+ * *\/
+ * // example id: example-2
+ * ```
+ *
  */
 export declare class CreateDataIntegrationFlowCommand extends CreateDataIntegrationFlowCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -110,6 +110,273 @@ declare const CreateDataLakeDatasetCommand_base: {
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
  *
  * @public
+ * @example Create an AWS Supply Chain inbound order dataset
+ * ```javascript
+ * //
+ * const input = {
+ *   "name": "inbound_order",
+ *   "description": "This is an AWS Supply Chain inbound order dataset",
+ *   "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *   "namespace": "asc",
+ *   "tags": {
+ *     "tagKey1": "tagValue1",
+ *     "tagKey2": "tagValue2"
+ *   }
+ * };
+ * const command = new CreateDataLakeDatasetCommand(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 Create a custom dataset
+ * ```javascript
+ * //
+ * const input = {
+ *   "name": "my_dataset",
+ *   "description": "This is a custom dataset",
+ *   "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *   "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
+ *       }
+ *     ]
+ *   },
+ *   "tags": {
+ *     "tagKey1": "tagValue1",
+ *     "tagKey2": "tagValue2"
+ *   }
+ * };
+ * const command = new CreateDataLakeDatasetCommand(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 CreateDataLakeDatasetCommand extends CreateDataLakeDatasetCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -78,6 +78,24 @@ declare const DeleteDataIntegrationFlowCommand_base: {
  * <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. */

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

@@ -80,6 +80,46 @@ declare const DeleteDataLakeDatasetCommand_base: {
  * <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. */

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

@@ -125,6 +125,50 @@ declare const GetDataIntegrationFlowCommand_base: {
  * <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. */