@aws-sdk/client-supplychain 3.775.0 → 3.782.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.
@@ -78,25 +78,25 @@ declare const CreateBillOfMaterialsImportJobCommand_base: {
78
78
  * @throws {@link SupplyChainServiceException}
79
79
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
80
80
  *
81
- * @public
81
+ *
82
82
  * @example Invoke CreateBillOfMaterialsImportJob
83
83
  * ```javascript
84
84
  * //
85
85
  * const input = {
86
- * "clientToken": "550e8400-e29b-41d4-a716-446655440000",
87
- * "instanceId": "60f82bbd-71f7-4fcd-a941-472f574c5243",
88
- * "s3uri": "s3://mybucketname/pathelemene/file.csv"
86
+ * clientToken: "550e8400-e29b-41d4-a716-446655440000",
87
+ * instanceId: "60f82bbd-71f7-4fcd-a941-472f574c5243",
88
+ * s3uri: "s3://mybucketname/pathelemene/file.csv"
89
89
  * };
90
90
  * const command = new CreateBillOfMaterialsImportJobCommand(input);
91
91
  * const response = await client.send(command);
92
- * /* response ==
92
+ * /* response is
93
93
  * {
94
- * "jobId": "f79b359b-1515-4436-a3bf-bae7b33e47b4"
94
+ * jobId: "f79b359b-1515-4436-a3bf-bae7b33e47b4"
95
95
  * }
96
96
  * *\/
97
- * // example id: example-1
98
97
  * ```
99
98
  *
99
+ * @public
100
100
  */
101
101
  export declare class CreateBillOfMaterialsImportJobCommand extends CreateBillOfMaterialsImportJobCommand_base {
102
102
  /** @internal type navigation helper, not in runtime. */
@@ -123,99 +123,98 @@ declare const CreateDataIntegrationFlowCommand_base: {
123
123
  * @throws {@link SupplyChainServiceException}
124
124
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
125
125
  *
126
- * @public
126
+ *
127
127
  * @example Successful CreateDataIntegrationFlow for s3 to dataset flow
128
128
  * ```javascript
129
129
  * //
130
130
  * const input = {
131
- * "name": "testStagingFlow",
132
- * "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d",
133
- * "sources": [
131
+ * instanceId: "8850c54e-e187-4fa7-89d4-6370f165174d",
132
+ * name: "testStagingFlow",
133
+ * sources: [
134
134
  * {
135
- * "s3Source": {
136
- * "bucketName": "aws-supply-chain-data-b8c7bb28-a576-4334-b481-6d6e8e47371f",
137
- * "prefix": "example-prefix"
135
+ * s3Source: {
136
+ * bucketName: "aws-supply-chain-data-b8c7bb28-a576-4334-b481-6d6e8e47371f",
137
+ * prefix: "example-prefix"
138
138
  * },
139
- * "sourceName": "testSourceName",
140
- * "sourceType": "S3"
139
+ * sourceName: "testSourceName",
140
+ * sourceType: "S3"
141
141
  * }
142
142
  * ],
143
- * "tags": {
144
- * "tagKey1": "tagValue1"
143
+ * tags: {
144
+ * tagKey1: "tagValue1"
145
145
  * },
146
- * "target": {
147
- * "datasetTarget": {
148
- * "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset"
146
+ * target: {
147
+ * datasetTarget: {
148
+ * datasetIdentifier: "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset"
149
149
  * },
150
- * "targetType": "DATASET"
150
+ * targetType: "DATASET"
151
151
  * },
152
- * "transformation": {
153
- * "sqlTransformation": {
154
- * "query": "SELECT * FROM testSourceName"
152
+ * transformation: {
153
+ * sqlTransformation: {
154
+ * query: "SELECT * FROM testSourceName"
155
155
  * },
156
- * "transformationType": "SQL"
156
+ * transformationType: "SQL"
157
157
  * }
158
158
  * };
159
159
  * const command = new CreateDataIntegrationFlowCommand(input);
160
160
  * const response = await client.send(command);
161
- * /* response ==
161
+ * /* response is
162
162
  * {
163
- * "name": "testStagingFlow",
164
- * "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d"
163
+ * instanceId: "8850c54e-e187-4fa7-89d4-6370f165174d",
164
+ * name: "testStagingFlow"
165
165
  * }
166
166
  * *\/
167
- * // example id: example-1
168
167
  * ```
169
168
  *
170
169
  * @example Successful CreateDataIntegrationFlow for dataset to dataset flow
171
170
  * ```javascript
172
171
  * //
173
172
  * const input = {
174
- * "name": "trading-partner",
175
- * "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d",
176
- * "sources": [
173
+ * instanceId: "8850c54e-e187-4fa7-89d4-6370f165174d",
174
+ * name: "trading-partner",
175
+ * sources: [
177
176
  * {
178
- * "datasetSource": {
179
- * "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset1"
177
+ * datasetSource: {
178
+ * datasetIdentifier: "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset1"
180
179
  * },
181
- * "sourceName": "testSourceName1",
182
- * "sourceType": "DATASET"
180
+ * sourceName: "testSourceName1",
181
+ * sourceType: "DATASET"
183
182
  * },
184
183
  * {
185
- * "datasetSource": {
186
- * "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset2"
184
+ * datasetSource: {
185
+ * datasetIdentifier: "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset2"
187
186
  * },
188
- * "sourceName": "testSourceName2",
189
- * "sourceType": "DATASET"
187
+ * sourceName: "testSourceName2",
188
+ * sourceType: "DATASET"
190
189
  * }
191
190
  * ],
192
- * "tags": {
193
- * "tagKey1": "tagValue1"
191
+ * tags: {
192
+ * tagKey1: "tagValue1"
194
193
  * },
195
- * "target": {
196
- * "datasetTarget": {
197
- * "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner"
194
+ * target: {
195
+ * datasetTarget: {
196
+ * datasetIdentifier: "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner"
198
197
  * },
199
- * "targetType": "DATASET"
198
+ * targetType: "DATASET"
200
199
  * },
201
- * "transformation": {
202
- * "sqlTransformation": {
203
- * "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"
200
+ * transformation: {
201
+ * sqlTransformation: {
202
+ * 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"
204
203
  * },
205
- * "transformationType": "SQL"
204
+ * transformationType: "SQL"
206
205
  * }
207
206
  * };
208
207
  * const command = new CreateDataIntegrationFlowCommand(input);
209
208
  * const response = await client.send(command);
210
- * /* response ==
209
+ * /* response is
211
210
  * {
212
- * "name": "trading-partner",
213
- * "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d"
211
+ * instanceId: "8850c54e-e187-4fa7-89d4-6370f165174d",
212
+ * name: "trading-partner"
214
213
  * }
215
214
  * *\/
216
- * // example id: example-2
217
215
  * ```
218
216
  *
217
+ * @public
219
218
  */
220
219
  export declare class CreateDataIntegrationFlowCommand extends CreateDataIntegrationFlowCommand_base {
221
220
  /** @internal type navigation helper, not in runtime. */
@@ -109,274 +109,273 @@ declare const CreateDataLakeDatasetCommand_base: {
109
109
  * @throws {@link SupplyChainServiceException}
110
110
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
111
111
  *
112
- * @public
112
+ *
113
113
  * @example Create an AWS Supply Chain inbound order dataset
114
114
  * ```javascript
115
115
  * //
116
116
  * const input = {
117
- * "name": "inbound_order",
118
- * "description": "This is an AWS Supply Chain inbound order dataset",
119
- * "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
120
- * "namespace": "asc",
121
- * "tags": {
122
- * "tagKey1": "tagValue1",
123
- * "tagKey2": "tagValue2"
117
+ * description: "This is an AWS Supply Chain inbound order dataset",
118
+ * instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
119
+ * name: "inbound_order",
120
+ * namespace: "asc",
121
+ * tags: {
122
+ * tagKey1: "tagValue1",
123
+ * tagKey2: "tagValue2"
124
124
  * }
125
125
  * };
126
126
  * const command = new CreateDataLakeDatasetCommand(input);
127
127
  * const response = await client.send(command);
128
- * /* response ==
128
+ * /* response is
129
129
  * {
130
- * "dataset": {
131
- * "name": "inbound_order",
132
- * "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/asc/datasets/inbound_order",
133
- * "createdTime": 1727116807.751,
134
- * "description": "This is an AWS Supply Chain inbound order dataset",
135
- * "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
136
- * "lastModifiedTime": 1727116807.751,
137
- * "namespace": "asc",
138
- * "schema": {
139
- * "name": "InboundOrder",
140
- * "fields": [
130
+ * dataset: {
131
+ * arn: "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/asc/datasets/inbound_order",
132
+ * createdTime: 1.727116807751E9,
133
+ * description: "This is an AWS Supply Chain inbound order dataset",
134
+ * instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
135
+ * lastModifiedTime: 1.727116807751E9,
136
+ * name: "inbound_order",
137
+ * namespace: "asc",
138
+ * schema: {
139
+ * fields: [
141
140
  * {
142
- * "name": "id",
143
- * "type": "STRING",
144
- * "isRequired": true
141
+ * isRequired: true,
142
+ * name: "id",
143
+ * type: "STRING"
145
144
  * },
146
145
  * {
147
- * "name": "tpartner_id",
148
- * "type": "STRING",
149
- * "isRequired": true
146
+ * isRequired: true,
147
+ * name: "tpartner_id",
148
+ * type: "STRING"
150
149
  * },
151
150
  * {
152
- * "name": "connection_id",
153
- * "type": "STRING",
154
- * "isRequired": true
151
+ * isRequired: true,
152
+ * name: "connection_id",
153
+ * type: "STRING"
155
154
  * },
156
155
  * {
157
- * "name": "order_type",
158
- * "type": "STRING",
159
- * "isRequired": false
156
+ * isRequired: false,
157
+ * name: "order_type",
158
+ * type: "STRING"
160
159
  * },
161
160
  * {
162
- * "name": "order_status",
163
- * "type": "STRING",
164
- * "isRequired": false
161
+ * isRequired: false,
162
+ * name: "order_status",
163
+ * type: "STRING"
165
164
  * },
166
165
  * {
167
- * "name": "inbound_order_url",
168
- * "type": "STRING",
169
- * "isRequired": false
166
+ * isRequired: false,
167
+ * name: "inbound_order_url",
168
+ * type: "STRING"
170
169
  * },
171
170
  * {
172
- * "name": "order_creation_date",
173
- * "type": "TIMESTAMP",
174
- * "isRequired": false
171
+ * isRequired: false,
172
+ * name: "order_creation_date",
173
+ * type: "TIMESTAMP"
175
174
  * },
176
175
  * {
177
- * "name": "company_id",
178
- * "type": "STRING",
179
- * "isRequired": false
176
+ * isRequired: false,
177
+ * name: "company_id",
178
+ * type: "STRING"
180
179
  * },
181
180
  * {
182
- * "name": "to_site_id",
183
- * "type": "STRING",
184
- * "isRequired": false
181
+ * isRequired: false,
182
+ * name: "to_site_id",
183
+ * type: "STRING"
185
184
  * },
186
185
  * {
187
- * "name": "order_currency_uom",
188
- * "type": "STRING",
189
- * "isRequired": false
186
+ * isRequired: false,
187
+ * name: "order_currency_uom",
188
+ * type: "STRING"
190
189
  * },
191
190
  * {
192
- * "name": "vendor_currency_uom",
193
- * "type": "STRING",
194
- * "isRequired": false
191
+ * isRequired: false,
192
+ * name: "vendor_currency_uom",
193
+ * type: "STRING"
195
194
  * },
196
195
  * {
197
- * "name": "exchange_rate",
198
- * "type": "DOUBLE",
199
- * "isRequired": false
196
+ * isRequired: false,
197
+ * name: "exchange_rate",
198
+ * type: "DOUBLE"
200
199
  * },
201
200
  * {
202
- * "name": "exchange_rate_date",
203
- * "type": "TIMESTAMP",
204
- * "isRequired": false
201
+ * isRequired: false,
202
+ * name: "exchange_rate_date",
203
+ * type: "TIMESTAMP"
205
204
  * },
206
205
  * {
207
- * "name": "incoterm",
208
- * "type": "STRING",
209
- * "isRequired": false
206
+ * isRequired: false,
207
+ * name: "incoterm",
208
+ * type: "STRING"
210
209
  * },
211
210
  * {
212
- * "name": "incoterm2",
213
- * "type": "STRING",
214
- * "isRequired": false
211
+ * isRequired: false,
212
+ * name: "incoterm2",
213
+ * type: "STRING"
215
214
  * },
216
215
  * {
217
- * "name": "incoterm_location_1",
218
- * "type": "STRING",
219
- * "isRequired": false
216
+ * isRequired: false,
217
+ * name: "incoterm_location_1",
218
+ * type: "STRING"
220
219
  * },
221
220
  * {
222
- * "name": "incoterm_location_2",
223
- * "type": "STRING",
224
- * "isRequired": false
221
+ * isRequired: false,
222
+ * name: "incoterm_location_2",
223
+ * type: "STRING"
225
224
  * },
226
225
  * {
227
- * "name": "submitted_date",
228
- * "type": "TIMESTAMP",
229
- * "isRequired": false
226
+ * isRequired: false,
227
+ * name: "submitted_date",
228
+ * type: "TIMESTAMP"
230
229
  * },
231
230
  * {
232
- * "name": "agreement_start_date",
233
- * "type": "TIMESTAMP",
234
- * "isRequired": false
231
+ * isRequired: false,
232
+ * name: "agreement_start_date",
233
+ * type: "TIMESTAMP"
235
234
  * },
236
235
  * {
237
- * "name": "agreement_end_date",
238
- * "type": "TIMESTAMP",
239
- * "isRequired": false
236
+ * isRequired: false,
237
+ * name: "agreement_end_date",
238
+ * type: "TIMESTAMP"
240
239
  * },
241
240
  * {
242
- * "name": "shipping_instr_code",
243
- * "type": "STRING",
244
- * "isRequired": false
241
+ * isRequired: false,
242
+ * name: "shipping_instr_code",
243
+ * type: "STRING"
245
244
  * },
246
245
  * {
247
- * "name": "payment_terms_code",
248
- * "type": "STRING",
249
- * "isRequired": false
246
+ * isRequired: false,
247
+ * name: "payment_terms_code",
248
+ * type: "STRING"
250
249
  * },
251
250
  * {
252
- * "name": "std_terms_agreement",
253
- * "type": "STRING",
254
- * "isRequired": false
251
+ * isRequired: false,
252
+ * name: "std_terms_agreement",
253
+ * type: "STRING"
255
254
  * },
256
255
  * {
257
- * "name": "std_terms_agreement_ver",
258
- * "type": "STRING",
259
- * "isRequired": false
256
+ * isRequired: false,
257
+ * name: "std_terms_agreement_ver",
258
+ * type: "STRING"
260
259
  * },
261
260
  * {
262
- * "name": "agreement_number",
263
- * "type": "STRING",
264
- * "isRequired": false
261
+ * isRequired: false,
262
+ * name: "agreement_number",
263
+ * type: "STRING"
265
264
  * },
266
265
  * {
267
- * "name": "source",
268
- * "type": "STRING",
269
- * "isRequired": false
266
+ * isRequired: false,
267
+ * name: "source",
268
+ * type: "STRING"
270
269
  * },
271
270
  * {
272
- * "name": "source_update_dttm",
273
- * "type": "TIMESTAMP",
274
- * "isRequired": false
271
+ * isRequired: false,
272
+ * name: "source_update_dttm",
273
+ * type: "TIMESTAMP"
275
274
  * },
276
275
  * {
277
- * "name": "source_event_id",
278
- * "type": "STRING",
279
- * "isRequired": false
276
+ * isRequired: false,
277
+ * name: "source_event_id",
278
+ * type: "STRING"
280
279
  * },
281
280
  * {
282
- * "name": "db_creation_dttm",
283
- * "type": "TIMESTAMP",
284
- * "isRequired": false
281
+ * isRequired: false,
282
+ * name: "db_creation_dttm",
283
+ * type: "TIMESTAMP"
285
284
  * },
286
285
  * {
287
- * "name": "db_updation_dttm",
288
- * "type": "TIMESTAMP",
289
- * "isRequired": false
286
+ * isRequired: false,
287
+ * name: "db_updation_dttm",
288
+ * type: "TIMESTAMP"
290
289
  * }
291
- * ]
290
+ * ],
291
+ * name: "InboundOrder"
292
292
  * }
293
293
  * }
294
294
  * }
295
295
  * *\/
296
- * // example id: example-1
297
296
  * ```
298
297
  *
299
298
  * @example Create a custom dataset
300
299
  * ```javascript
301
300
  * //
302
301
  * const input = {
303
- * "name": "my_dataset",
304
- * "description": "This is a custom dataset",
305
- * "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
306
- * "namespace": "default",
307
- * "schema": {
308
- * "name": "MyDataset",
309
- * "fields": [
302
+ * description: "This is a custom dataset",
303
+ * instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
304
+ * name: "my_dataset",
305
+ * namespace: "default",
306
+ * schema: {
307
+ * fields: [
310
308
  * {
311
- * "name": "id",
312
- * "type": "INT",
313
- * "isRequired": true
309
+ * isRequired: true,
310
+ * name: "id",
311
+ * type: "INT"
314
312
  * },
315
313
  * {
316
- * "name": "description",
317
- * "type": "STRING",
318
- * "isRequired": true
314
+ * isRequired: true,
315
+ * name: "description",
316
+ * type: "STRING"
319
317
  * },
320
318
  * {
321
- * "name": "price",
322
- * "type": "DOUBLE",
323
- * "isRequired": false
319
+ * isRequired: false,
320
+ * name: "price",
321
+ * type: "DOUBLE"
324
322
  * },
325
323
  * {
326
- * "name": "creation_time",
327
- * "type": "TIMESTAMP",
328
- * "isRequired": false
324
+ * isRequired: false,
325
+ * name: "creation_time",
326
+ * type: "TIMESTAMP"
329
327
  * }
330
- * ]
328
+ * ],
329
+ * name: "MyDataset"
331
330
  * },
332
- * "tags": {
333
- * "tagKey1": "tagValue1",
334
- * "tagKey2": "tagValue2"
331
+ * tags: {
332
+ * tagKey1: "tagValue1",
333
+ * tagKey2: "tagValue2"
335
334
  * }
336
335
  * };
337
336
  * const command = new CreateDataLakeDatasetCommand(input);
338
337
  * const response = await client.send(command);
339
- * /* response ==
338
+ * /* response is
340
339
  * {
341
- * "dataset": {
342
- * "name": "my_dataset",
343
- * "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/default/datasets/my_dataset",
344
- * "createdTime": 1727116807.751,
345
- * "description": "This is a custom dataset",
346
- * "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
347
- * "lastModifiedTime": 1727116807.751,
348
- * "namespace": "default",
349
- * "schema": {
350
- * "name": "MyDataset",
351
- * "fields": [
340
+ * dataset: {
341
+ * arn: "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/default/datasets/my_dataset",
342
+ * createdTime: 1.727116807751E9,
343
+ * description: "This is a custom dataset",
344
+ * instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
345
+ * lastModifiedTime: 1.727116807751E9,
346
+ * name: "my_dataset",
347
+ * namespace: "default",
348
+ * schema: {
349
+ * fields: [
352
350
  * {
353
- * "name": "id",
354
- * "type": "INT",
355
- * "isRequired": true
351
+ * isRequired: true,
352
+ * name: "id",
353
+ * type: "INT"
356
354
  * },
357
355
  * {
358
- * "name": "description",
359
- * "type": "STRING",
360
- * "isRequired": true
356
+ * isRequired: true,
357
+ * name: "description",
358
+ * type: "STRING"
361
359
  * },
362
360
  * {
363
- * "name": "price",
364
- * "type": "DOUBLE",
365
- * "isRequired": false
361
+ * isRequired: false,
362
+ * name: "price",
363
+ * type: "DOUBLE"
366
364
  * },
367
365
  * {
368
- * "name": "creation_time",
369
- * "type": "TIMESTAMP",
370
- * "isRequired": false
366
+ * isRequired: false,
367
+ * name: "creation_time",
368
+ * type: "TIMESTAMP"
371
369
  * }
372
- * ]
370
+ * ],
371
+ * name: "MyDataset"
373
372
  * }
374
373
  * }
375
374
  * }
376
375
  * *\/
377
- * // example id: example-2
378
376
  * ```
379
377
  *
378
+ * @public
380
379
  */
381
380
  export declare class CreateDataLakeDatasetCommand extends CreateDataLakeDatasetCommand_base {
382
381
  /** @internal type navigation helper, not in runtime. */