npm - @aws-sdk/client-supplychain - Versions diffs - 3.661.0 → 3.664.0 - Mend

@aws-sdk/client-supplychain 3.661.0 → 3.664.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (22) hide show

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

@@ -96,6 +96,238 @@ declare const GetDataLakeDatasetCommand_base: {
  * <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. */

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

@@ -129,6 +129,85 @@ declare const ListDataIntegrationFlowsCommand_base: {
  * <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. */

package/dist-types/commands/ListDataLakeDatasetsCommand.d.ts CHANGED Viewed

@@ -100,6 +100,267 @@ declare const ListDataLakeDatasetsCommand_base: {
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
  *
  * @public
+ * @example List AWS Supply Chain datasets
+ * ```javascript
+ * //
+ * const input = {
+ *   "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *   "namespace": "asc"
+ * };
+ * const command = new ListDataLakeDatasetsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "datasets": [
+ *     {
+ *       "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 List custom datasets using pagination
+ * ```javascript
+ * //
+ * const input = {
+ *   "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *   "maxResults": 2,
+ *   "namespace": "default",
+ *   "nextToken": "next_token_returned_from_previous_list_request"
+ * };
+ * const command = new ListDataLakeDatasetsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "datasets": [
+ *     {
+ *       "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
+ *           }
+ *         ]
+ *       }
+ *     },
+ *     {
+ *       "name": "my_dataset_2",
+ *       "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/default/datasets/my_dataset_2",
+ *       "createdTime": 1727116907.751,
+ *       "description": "This is a custom dataset 2",
+ *       "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *       "lastModifiedTime": 1727116907.751,
+ *       "namespace": "default",
+ *       "schema": {
+ *         "name": "MyDataset2",
+ *         "fields": [
+ *           {
+ *             "name": "id",
+ *             "type": "INT",
+ *             "isRequired": true
+ *           },
+ *           {
+ *             "name": "description",
+ *             "type": "STRING",
+ *             "isRequired": true
+ *           }
+ *         ]
+ *       }
+ *     }
+ *   ],
+ *   "nextToken": "next_token_for_next_list_request"
+ * }
+ * *\/
+ * // example id: example-2
+ * ```
+ *
  */
 export declare class ListDataLakeDatasetsCommand extends ListDataLakeDatasetsCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/ListTagsForResourceCommand.d.ts CHANGED Viewed

@@ -78,6 +78,24 @@ declare const ListTagsForResourceCommand_base: {
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
  *
  * @public
+ * @example Successful ListTagsForResource
+ * ```javascript
+ * //
+ * const input = {
+ *   "resourceArn": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/data-integration-flows/my_flow1"
+ * };
+ * const command = new ListTagsForResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "tags": {
+ *     "tagKey1": "tagValue1"
+ *   }
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -77,6 +77,20 @@ declare const TagResourceCommand_base: {
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
  *
  * @public
+ * @example Successful TagResource
+ * ```javascript
+ * //
+ * const input = {
+ *   "resourceArn": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/data-integration-flows/my_flow1",
+ *   "tags": {
+ *     "tagKey1": "tagValue1"
+ *   }
+ * };
+ * const command = new TagResourceCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class TagResourceCommand extends TagResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -77,6 +77,20 @@ declare const UntagResourceCommand_base: {
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
  *
  * @public
+ * @example Successful UntagResource
+ * ```javascript
+ * //
+ * const input = {
+ *   "resourceArn": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/data-integration-flows/my_flow1",
+ *   "tagKeys": [
+ *     "tagKey1"
+ *   ]
+ * };
+ * const command = new UntagResourceCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class UntagResourceCommand extends UntagResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */