@aws-sdk/client-supplychain 3.774.0 → 3.777.0

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

@@ -109,274 +109,273 @@ declare const CreateDataLakeDatasetCommand_base: {
  * @throws {@link SupplyChainServiceException}
  * <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"
+ *   description: "This is an AWS Supply Chain inbound order dataset",
+ *   instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *   name: "inbound_order",
+ *   namespace: "asc",
+ *   tags: {
+ *     tagKey1: "tagValue1",
+ *     tagKey2: "tagValue2"
  *   }
  * };
  * const command = new CreateDataLakeDatasetCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "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": [
+ *   dataset: {
+ *     arn: "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/asc/datasets/inbound_order",
+ *     createdTime: 1.727116807751E9,
+ *     description: "This is an AWS Supply Chain inbound order dataset",
+ *     instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *     lastModifiedTime: 1.727116807751E9,
+ *     name: "inbound_order",
+ *     namespace: "asc",
+ *     schema: {
+ *       fields: [
  *         {
- *           "name": "id",
- *           "type": "STRING",
- *           "isRequired": true
+ *           isRequired: true,
+ *           name: "id",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "tpartner_id",
- *           "type": "STRING",
- *           "isRequired": true
+ *           isRequired: true,
+ *           name: "tpartner_id",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "connection_id",
- *           "type": "STRING",
- *           "isRequired": true
+ *           isRequired: true,
+ *           name: "connection_id",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "order_type",
- *           "type": "STRING",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "order_type",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "order_status",
- *           "type": "STRING",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "order_status",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "inbound_order_url",
- *           "type": "STRING",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "inbound_order_url",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "order_creation_date",
- *           "type": "TIMESTAMP",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "order_creation_date",
+ *           type: "TIMESTAMP"
  *         },
  *         {
- *           "name": "company_id",
- *           "type": "STRING",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "company_id",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "to_site_id",
- *           "type": "STRING",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "to_site_id",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "order_currency_uom",
- *           "type": "STRING",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "order_currency_uom",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "vendor_currency_uom",
- *           "type": "STRING",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "vendor_currency_uom",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "exchange_rate",
- *           "type": "DOUBLE",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "exchange_rate",
+ *           type: "DOUBLE"
  *         },
  *         {
- *           "name": "exchange_rate_date",
- *           "type": "TIMESTAMP",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "exchange_rate_date",
+ *           type: "TIMESTAMP"
  *         },
  *         {
- *           "name": "incoterm",
- *           "type": "STRING",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "incoterm",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "incoterm2",
- *           "type": "STRING",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "incoterm2",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "incoterm_location_1",
- *           "type": "STRING",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "incoterm_location_1",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "incoterm_location_2",
- *           "type": "STRING",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "incoterm_location_2",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "submitted_date",
- *           "type": "TIMESTAMP",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "submitted_date",
+ *           type: "TIMESTAMP"
  *         },
  *         {
- *           "name": "agreement_start_date",
- *           "type": "TIMESTAMP",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "agreement_start_date",
+ *           type: "TIMESTAMP"
  *         },
  *         {
- *           "name": "agreement_end_date",
- *           "type": "TIMESTAMP",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "agreement_end_date",
+ *           type: "TIMESTAMP"
  *         },
  *         {
- *           "name": "shipping_instr_code",
- *           "type": "STRING",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "shipping_instr_code",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "payment_terms_code",
- *           "type": "STRING",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "payment_terms_code",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "std_terms_agreement",
- *           "type": "STRING",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "std_terms_agreement",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "std_terms_agreement_ver",
- *           "type": "STRING",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "std_terms_agreement_ver",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "agreement_number",
- *           "type": "STRING",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "agreement_number",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "source",
- *           "type": "STRING",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "source",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "source_update_dttm",
- *           "type": "TIMESTAMP",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "source_update_dttm",
+ *           type: "TIMESTAMP"
  *         },
  *         {
- *           "name": "source_event_id",
- *           "type": "STRING",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "source_event_id",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "db_creation_dttm",
- *           "type": "TIMESTAMP",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "db_creation_dttm",
+ *           type: "TIMESTAMP"
  *         },
  *         {
- *           "name": "db_updation_dttm",
- *           "type": "TIMESTAMP",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "db_updation_dttm",
+ *           type: "TIMESTAMP"
  *         }
- *       ]
+ *       ],
+ *       name: "InboundOrder"
  *     }
  *   }
  * }
  * *\/
- * // 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": [
+ *   description: "This is a custom dataset",
+ *   instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *   name: "my_dataset",
+ *   namespace: "default",
+ *   schema: {
+ *     fields: [
  *       {
- *         "name": "id",
- *         "type": "INT",
- *         "isRequired": true
+ *         isRequired: true,
+ *         name: "id",
+ *         type: "INT"
  *       },
  *       {
- *         "name": "description",
- *         "type": "STRING",
- *         "isRequired": true
+ *         isRequired: true,
+ *         name: "description",
+ *         type: "STRING"
  *       },
  *       {
- *         "name": "price",
- *         "type": "DOUBLE",
- *         "isRequired": false
+ *         isRequired: false,
+ *         name: "price",
+ *         type: "DOUBLE"
  *       },
  *       {
- *         "name": "creation_time",
- *         "type": "TIMESTAMP",
- *         "isRequired": false
+ *         isRequired: false,
+ *         name: "creation_time",
+ *         type: "TIMESTAMP"
  *       }
- *     ]
+ *     ],
+ *     name: "MyDataset"
  *   },
- *   "tags": {
- *     "tagKey1": "tagValue1",
- *     "tagKey2": "tagValue2"
+ *   tags: {
+ *     tagKey1: "tagValue1",
+ *     tagKey2: "tagValue2"
  *   }
  * };
  * const command = new CreateDataLakeDatasetCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "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": [
+ *   dataset: {
+ *     arn: "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/default/datasets/my_dataset",
+ *     createdTime: 1.727116807751E9,
+ *     description: "This is a custom dataset",
+ *     instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *     lastModifiedTime: 1.727116807751E9,
+ *     name: "my_dataset",
+ *     namespace: "default",
+ *     schema: {
+ *       fields: [
  *         {
- *           "name": "id",
- *           "type": "INT",
- *           "isRequired": true
+ *           isRequired: true,
+ *           name: "id",
+ *           type: "INT"
  *         },
  *         {
- *           "name": "description",
- *           "type": "STRING",
- *           "isRequired": true
+ *           isRequired: true,
+ *           name: "description",
+ *           type: "STRING"
  *         },
  *         {
- *           "name": "price",
- *           "type": "DOUBLE",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "price",
+ *           type: "DOUBLE"
  *         },
  *         {
- *           "name": "creation_time",
- *           "type": "TIMESTAMP",
- *           "isRequired": false
+ *           isRequired: false,
+ *           name: "creation_time",
+ *           type: "TIMESTAMP"
  *         }
- *       ]
+ *       ],
+ *       name: "MyDataset"
  *     }
  *   }
  * }
  * *\/
- * // example id: example-2
  * ```
  *
+ * @public
  */
 export declare class CreateDataLakeDatasetCommand extends CreateDataLakeDatasetCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -95,61 +95,60 @@ declare const CreateInstanceCommand_base: {
  * @throws {@link SupplyChainServiceException}
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
  *
- * @public
+ *
  * @example Successful CreateInstance request with all input data
  * ```javascript
  * //
  * const input = {
- *   "instanceDescription": "example instance description",
- *   "instanceName": "example instance name",
- *   "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
- *   "tags": {
- *     "tagKey1": "tagValue1"
+ *   instanceDescription: "example instance description",
+ *   instanceName: "example instance name",
+ *   kmsKeyArn: "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
+ *   tags: {
+ *     tagKey1: "tagValue1"
  *   }
  * };
  * const command = new CreateInstanceCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "instance": {
- *     "awsAccountId": "123456789012",
- *     "createdTime": 172615383136,
- *     "instanceDescription": "example instance description",
- *     "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
- *     "instanceName": "example instance name",
- *     "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
- *     "lastModifiedTime": 172615383136,
- *     "state": "Initializing",
- *     "versionNumber": 2
+ *   instance: {
+ *     awsAccountId: "123456789012",
+ *     createdTime: 172615383136,
+ *     instanceDescription: "example instance description",
+ *     instanceId: "9e193580-7cc5-45f7-9609-c43ba0ada793",
+ *     instanceName: "example instance name",
+ *     kmsKeyArn: "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
+ *     lastModifiedTime: 172615383136,
+ *     state: "Initializing",
+ *     versionNumber: 2.0
  *   }
  * }
  * *\/
- * // example id: example-1
  * ```
  *
  * @example Successful CreateInstance request with no input data
  * ```javascript
  * //
- * const input = {};
+ * const input = { /* empty *\/ };
  * const command = new CreateInstanceCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "instance": {
- *     "awsAccountId": "123456789012",
- *     "createdTime": 172615383136,
- *     "instanceDescription": "",
- *     "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
- *     "kmsKeyArn": "arn:aws:kms:us-west-2:456789012345:key/7372eb6d-874c-4212-8d49-7804282d33a8",
- *     "lastModifiedTime": 172615383136,
- *     "state": "Initializing",
- *     "versionNumber": 2
+ *   instance: {
+ *     awsAccountId: "123456789012",
+ *     createdTime: 172615383136,
+ *     instanceDescription: "",
+ *     instanceId: "9e193580-7cc5-45f7-9609-c43ba0ada793",
+ *     kmsKeyArn: "arn:aws:kms:us-west-2:456789012345:key/7372eb6d-874c-4212-8d49-7804282d33a8",
+ *     lastModifiedTime: 172615383136,
+ *     state: "Initializing",
+ *     versionNumber: 2.0
  *   }
  * }
  * *\/
- * // example id: example-2
  * ```
  *
+ * @public
  */
 export declare class CreateInstanceCommand extends CreateInstanceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -77,25 +77,25 @@ declare const DeleteDataIntegrationFlowCommand_base: {
  * @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"
+ *   instanceId: "8850c54e-e187-4fa7-89d4-6370f165174d",
+ *   name: "testStagingFlow"
  * };
  * const command = new DeleteDataIntegrationFlowCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "name": "testStagingFlow",
- *   "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d"
+ *   instanceId: "8850c54e-e187-4fa7-89d4-6370f165174d",
+ *   name: "testStagingFlow"
  * }
  * *\/
- * // example id: example-1
  * ```
  *
+ * @public
  */
 export declare class DeleteDataIntegrationFlowCommand extends DeleteDataIntegrationFlowCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -79,47 +79,46 @@ declare const DeleteDataLakeDatasetCommand_base: {
  * @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"
+ *   instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *   name: "inbound_order",
+ *   namespace: "asc"
  * };
  * const command = new DeleteDataLakeDatasetCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "name": "inbound_order",
- *   "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
- *   "namespace": "asc"
+ *   instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *   name: "inbound_order",
+ *   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"
+ *   instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *   name: "my_dataset",
+ *   namespace: "default"
  * };
  * const command = new DeleteDataLakeDatasetCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "name": "my_dataset",
- *   "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
- *   "namespace": "default"
+ *   instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
+ *   name: "my_dataset",
+ *   namespace: "default"
  * }
  * *\/
- * // example id: example-2
  * ```
  *
+ * @public
  */
 export declare class DeleteDataLakeDatasetCommand extends DeleteDataLakeDatasetCommand_base {
     /** @internal type navigation helper, not in runtime. */