@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.
@@ -95,239 +95,238 @@ declare const GetDataLakeDatasetCommand_base: {
95
95
  * @throws {@link SupplyChainServiceException}
96
96
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
97
97
  *
98
- * @public
98
+ *
99
99
  * @example Get properties of an existing AWS Supply Chain inbound order dataset
100
100
  * ```javascript
101
101
  * //
102
102
  * const input = {
103
- * "name": "inbound_order",
104
- * "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
105
- * "namespace": "asc"
103
+ * instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
104
+ * name: "inbound_order",
105
+ * namespace: "asc"
106
106
  * };
107
107
  * const command = new GetDataLakeDatasetCommand(input);
108
108
  * const response = await client.send(command);
109
- * /* response ==
109
+ * /* response is
110
110
  * {
111
- * "dataset": {
112
- * "name": "inbound_order",
113
- * "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/asc/datasets/inbound_order",
114
- * "createdTime": 1727116807.751,
115
- * "description": "This is an AWS Supply Chain inbound order dataset",
116
- * "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
117
- * "lastModifiedTime": 1727116807.751,
118
- * "namespace": "asc",
119
- * "schema": {
120
- * "name": "InboundOrder",
121
- * "fields": [
111
+ * dataset: {
112
+ * arn: "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/asc/datasets/inbound_order",
113
+ * createdTime: 1.727116807751E9,
114
+ * description: "This is an AWS Supply Chain inbound order dataset",
115
+ * instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
116
+ * lastModifiedTime: 1.727116807751E9,
117
+ * name: "inbound_order",
118
+ * namespace: "asc",
119
+ * schema: {
120
+ * fields: [
122
121
  * {
123
- * "name": "id",
124
- * "type": "STRING",
125
- * "isRequired": true
122
+ * isRequired: true,
123
+ * name: "id",
124
+ * type: "STRING"
126
125
  * },
127
126
  * {
128
- * "name": "tpartner_id",
129
- * "type": "STRING",
130
- * "isRequired": true
127
+ * isRequired: true,
128
+ * name: "tpartner_id",
129
+ * type: "STRING"
131
130
  * },
132
131
  * {
133
- * "name": "connection_id",
134
- * "type": "STRING",
135
- * "isRequired": true
132
+ * isRequired: true,
133
+ * name: "connection_id",
134
+ * type: "STRING"
136
135
  * },
137
136
  * {
138
- * "name": "order_type",
139
- * "type": "STRING",
140
- * "isRequired": false
137
+ * isRequired: false,
138
+ * name: "order_type",
139
+ * type: "STRING"
141
140
  * },
142
141
  * {
143
- * "name": "order_status",
144
- * "type": "STRING",
145
- * "isRequired": false
142
+ * isRequired: false,
143
+ * name: "order_status",
144
+ * type: "STRING"
146
145
  * },
147
146
  * {
148
- * "name": "inbound_order_url",
149
- * "type": "STRING",
150
- * "isRequired": false
147
+ * isRequired: false,
148
+ * name: "inbound_order_url",
149
+ * type: "STRING"
151
150
  * },
152
151
  * {
153
- * "name": "order_creation_date",
154
- * "type": "TIMESTAMP",
155
- * "isRequired": false
152
+ * isRequired: false,
153
+ * name: "order_creation_date",
154
+ * type: "TIMESTAMP"
156
155
  * },
157
156
  * {
158
- * "name": "company_id",
159
- * "type": "STRING",
160
- * "isRequired": false
157
+ * isRequired: false,
158
+ * name: "company_id",
159
+ * type: "STRING"
161
160
  * },
162
161
  * {
163
- * "name": "to_site_id",
164
- * "type": "STRING",
165
- * "isRequired": false
162
+ * isRequired: false,
163
+ * name: "to_site_id",
164
+ * type: "STRING"
166
165
  * },
167
166
  * {
168
- * "name": "order_currency_uom",
169
- * "type": "STRING",
170
- * "isRequired": false
167
+ * isRequired: false,
168
+ * name: "order_currency_uom",
169
+ * type: "STRING"
171
170
  * },
172
171
  * {
173
- * "name": "vendor_currency_uom",
174
- * "type": "STRING",
175
- * "isRequired": false
172
+ * isRequired: false,
173
+ * name: "vendor_currency_uom",
174
+ * type: "STRING"
176
175
  * },
177
176
  * {
178
- * "name": "exchange_rate",
179
- * "type": "DOUBLE",
180
- * "isRequired": false
177
+ * isRequired: false,
178
+ * name: "exchange_rate",
179
+ * type: "DOUBLE"
181
180
  * },
182
181
  * {
183
- * "name": "exchange_rate_date",
184
- * "type": "TIMESTAMP",
185
- * "isRequired": false
182
+ * isRequired: false,
183
+ * name: "exchange_rate_date",
184
+ * type: "TIMESTAMP"
186
185
  * },
187
186
  * {
188
- * "name": "incoterm",
189
- * "type": "STRING",
190
- * "isRequired": false
187
+ * isRequired: false,
188
+ * name: "incoterm",
189
+ * type: "STRING"
191
190
  * },
192
191
  * {
193
- * "name": "incoterm2",
194
- * "type": "STRING",
195
- * "isRequired": false
192
+ * isRequired: false,
193
+ * name: "incoterm2",
194
+ * type: "STRING"
196
195
  * },
197
196
  * {
198
- * "name": "incoterm_location_1",
199
- * "type": "STRING",
200
- * "isRequired": false
197
+ * isRequired: false,
198
+ * name: "incoterm_location_1",
199
+ * type: "STRING"
201
200
  * },
202
201
  * {
203
- * "name": "incoterm_location_2",
204
- * "type": "STRING",
205
- * "isRequired": false
202
+ * isRequired: false,
203
+ * name: "incoterm_location_2",
204
+ * type: "STRING"
206
205
  * },
207
206
  * {
208
- * "name": "submitted_date",
209
- * "type": "TIMESTAMP",
210
- * "isRequired": false
207
+ * isRequired: false,
208
+ * name: "submitted_date",
209
+ * type: "TIMESTAMP"
211
210
  * },
212
211
  * {
213
- * "name": "agreement_start_date",
214
- * "type": "TIMESTAMP",
215
- * "isRequired": false
212
+ * isRequired: false,
213
+ * name: "agreement_start_date",
214
+ * type: "TIMESTAMP"
216
215
  * },
217
216
  * {
218
- * "name": "agreement_end_date",
219
- * "type": "TIMESTAMP",
220
- * "isRequired": false
217
+ * isRequired: false,
218
+ * name: "agreement_end_date",
219
+ * type: "TIMESTAMP"
221
220
  * },
222
221
  * {
223
- * "name": "shipping_instr_code",
224
- * "type": "STRING",
225
- * "isRequired": false
222
+ * isRequired: false,
223
+ * name: "shipping_instr_code",
224
+ * type: "STRING"
226
225
  * },
227
226
  * {
228
- * "name": "payment_terms_code",
229
- * "type": "STRING",
230
- * "isRequired": false
227
+ * isRequired: false,
228
+ * name: "payment_terms_code",
229
+ * type: "STRING"
231
230
  * },
232
231
  * {
233
- * "name": "std_terms_agreement",
234
- * "type": "STRING",
235
- * "isRequired": false
232
+ * isRequired: false,
233
+ * name: "std_terms_agreement",
234
+ * type: "STRING"
236
235
  * },
237
236
  * {
238
- * "name": "std_terms_agreement_ver",
239
- * "type": "STRING",
240
- * "isRequired": false
237
+ * isRequired: false,
238
+ * name: "std_terms_agreement_ver",
239
+ * type: "STRING"
241
240
  * },
242
241
  * {
243
- * "name": "agreement_number",
244
- * "type": "STRING",
245
- * "isRequired": false
242
+ * isRequired: false,
243
+ * name: "agreement_number",
244
+ * type: "STRING"
246
245
  * },
247
246
  * {
248
- * "name": "source",
249
- * "type": "STRING",
250
- * "isRequired": false
247
+ * isRequired: false,
248
+ * name: "source",
249
+ * type: "STRING"
251
250
  * },
252
251
  * {
253
- * "name": "source_update_dttm",
254
- * "type": "TIMESTAMP",
255
- * "isRequired": false
252
+ * isRequired: false,
253
+ * name: "source_update_dttm",
254
+ * type: "TIMESTAMP"
256
255
  * },
257
256
  * {
258
- * "name": "source_event_id",
259
- * "type": "STRING",
260
- * "isRequired": false
257
+ * isRequired: false,
258
+ * name: "source_event_id",
259
+ * type: "STRING"
261
260
  * },
262
261
  * {
263
- * "name": "db_creation_dttm",
264
- * "type": "TIMESTAMP",
265
- * "isRequired": false
262
+ * isRequired: false,
263
+ * name: "db_creation_dttm",
264
+ * type: "TIMESTAMP"
266
265
  * },
267
266
  * {
268
- * "name": "db_updation_dttm",
269
- * "type": "TIMESTAMP",
270
- * "isRequired": false
267
+ * isRequired: false,
268
+ * name: "db_updation_dttm",
269
+ * type: "TIMESTAMP"
271
270
  * }
272
- * ]
271
+ * ],
272
+ * name: "InboundOrder"
273
273
  * }
274
274
  * }
275
275
  * }
276
276
  * *\/
277
- * // example id: example-1
278
277
  * ```
279
278
  *
280
279
  * @example Get proporties of an existing custom dataset
281
280
  * ```javascript
282
281
  * //
283
282
  * const input = {
284
- * "name": "my_dataset",
285
- * "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
286
- * "namespace": "default"
283
+ * instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
284
+ * name: "my_dataset",
285
+ * namespace: "default"
287
286
  * };
288
287
  * const command = new GetDataLakeDatasetCommand(input);
289
288
  * const response = await client.send(command);
290
- * /* response ==
289
+ * /* response is
291
290
  * {
292
- * "dataset": {
293
- * "name": "my_dataset",
294
- * "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/default/datasets/my_dataset",
295
- * "createdTime": 1727116807.751,
296
- * "description": "This is a custom dataset",
297
- * "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
298
- * "lastModifiedTime": 1727116807.751,
299
- * "namespace": "default",
300
- * "schema": {
301
- * "name": "MyDataset",
302
- * "fields": [
291
+ * dataset: {
292
+ * arn: "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/default/datasets/my_dataset",
293
+ * createdTime: 1.727116807751E9,
294
+ * description: "This is a custom dataset",
295
+ * instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
296
+ * lastModifiedTime: 1.727116807751E9,
297
+ * name: "my_dataset",
298
+ * namespace: "default",
299
+ * schema: {
300
+ * fields: [
303
301
  * {
304
- * "name": "id",
305
- * "type": "INT",
306
- * "isRequired": true
302
+ * isRequired: true,
303
+ * name: "id",
304
+ * type: "INT"
307
305
  * },
308
306
  * {
309
- * "name": "description",
310
- * "type": "STRING",
311
- * "isRequired": true
307
+ * isRequired: true,
308
+ * name: "description",
309
+ * type: "STRING"
312
310
  * },
313
311
  * {
314
- * "name": "price",
315
- * "type": "DOUBLE",
316
- * "isRequired": false
312
+ * isRequired: false,
313
+ * name: "price",
314
+ * type: "DOUBLE"
317
315
  * },
318
316
  * {
319
- * "name": "creation_time",
320
- * "type": "TIMESTAMP",
321
- * "isRequired": false
317
+ * isRequired: false,
318
+ * name: "creation_time",
319
+ * type: "TIMESTAMP"
322
320
  * }
323
- * ]
321
+ * ],
322
+ * name: "MyDataset"
324
323
  * }
325
324
  * }
326
325
  * }
327
326
  * *\/
328
- * // example id: example-2
329
327
  * ```
330
328
  *
329
+ * @public
331
330
  */
332
331
  export declare class GetDataLakeDatasetCommand extends GetDataLakeDatasetCommand_base {
333
332
  /** @internal type navigation helper, not in runtime. */
@@ -87,60 +87,59 @@ declare const GetInstanceCommand_base: {
87
87
  * @throws {@link SupplyChainServiceException}
88
88
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
89
89
  *
90
- * @public
90
+ *
91
91
  * @example Successful GetInstance request
92
92
  * ```javascript
93
93
  * //
94
94
  * const input = {
95
- * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793"
95
+ * instanceId: "9e193580-7cc5-45f7-9609-c43ba0ada793"
96
96
  * };
97
97
  * const command = new GetInstanceCommand(input);
98
98
  * const response = await client.send(command);
99
- * /* response ==
99
+ * /* response is
100
100
  * {
101
- * "instance": {
102
- * "awsAccountId": "123456789012",
103
- * "createdTime": 172615383136,
104
- * "instanceDescription": "example instance description",
105
- * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
106
- * "instanceName": "example instance name",
107
- * "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
108
- * "lastModifiedTime": 172615383136,
109
- * "state": "Active",
110
- * "versionNumber": 2
101
+ * instance: {
102
+ * awsAccountId: "123456789012",
103
+ * createdTime: 172615383136,
104
+ * instanceDescription: "example instance description",
105
+ * instanceId: "9e193580-7cc5-45f7-9609-c43ba0ada793",
106
+ * instanceName: "example instance name",
107
+ * kmsKeyArn: "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
108
+ * lastModifiedTime: 172615383136,
109
+ * state: "Active",
110
+ * versionNumber: 2.0
111
111
  * }
112
112
  * }
113
113
  * *\/
114
- * // example id: example-1
115
114
  * ```
116
115
  *
117
116
  * @example Successful GetInstance request with error message
118
117
  * ```javascript
119
118
  * //
120
119
  * const input = {
121
- * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793"
120
+ * instanceId: "9e193580-7cc5-45f7-9609-c43ba0ada793"
122
121
  * };
123
122
  * const command = new GetInstanceCommand(input);
124
123
  * const response = await client.send(command);
125
- * /* response ==
124
+ * /* response is
126
125
  * {
127
- * "instance": {
128
- * "awsAccountId": "123456789012",
129
- * "createdTime": 172615383136,
130
- * "errorMessage": "Access denied when attempting to create an S3 bucket. Please correct your IAM policy and try again.",
131
- * "instanceDescription": "example instance description",
132
- * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
133
- * "instanceName": "example instance name",
134
- * "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
135
- * "lastModifiedTime": 172615383136,
136
- * "state": "CreateFailed",
137
- * "versionNumber": 2
126
+ * instance: {
127
+ * awsAccountId: "123456789012",
128
+ * createdTime: 172615383136,
129
+ * errorMessage: "Access denied when attempting to create an S3 bucket. Please correct your IAM policy and try again.",
130
+ * instanceDescription: "example instance description",
131
+ * instanceId: "9e193580-7cc5-45f7-9609-c43ba0ada793",
132
+ * instanceName: "example instance name",
133
+ * kmsKeyArn: "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
134
+ * lastModifiedTime: 172615383136,
135
+ * state: "CreateFailed",
136
+ * versionNumber: 2.0
138
137
  * }
139
138
  * }
140
139
  * *\/
141
- * // example id: example-2
142
140
  * ```
143
141
  *
142
+ * @public
144
143
  */
145
144
  export declare class GetInstanceCommand extends GetInstanceCommand_base {
146
145
  /** @internal type navigation helper, not in runtime. */
@@ -128,86 +128,86 @@ declare const ListDataIntegrationFlowsCommand_base: {
128
128
  * @throws {@link SupplyChainServiceException}
129
129
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
130
130
  *
131
- * @public
131
+ *
132
132
  * @example Successful ListDataIntegrationFlow
133
133
  * ```javascript
134
134
  * //
135
135
  * const input = {
136
- * "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d"
136
+ * instanceId: "8850c54e-e187-4fa7-89d4-6370f165174d"
137
137
  * };
138
138
  * const command = new ListDataIntegrationFlowsCommand(input);
139
139
  * const response = await client.send(command);
140
- * /* response ==
140
+ * /* response is
141
141
  * {
142
- * "flows": [
142
+ * flows: [
143
143
  * {
144
- * "name": "testStagingFlow",
145
- * "createdTime": 1724956400.44,
146
- * "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d",
147
- * "lastModifiedTime": 1724956400.44,
148
- * "sources": [
144
+ * createdTime: 1.72495640044E9,
145
+ * instanceId: "8850c54e-e187-4fa7-89d4-6370f165174d",
146
+ * lastModifiedTime: 1.72495640044E9,
147
+ * name: "testStagingFlow",
148
+ * sources: [
149
149
  * {
150
- * "s3Source": {
151
- * "bucketName": "aws-supply-chain-data-b8c7bb28-a576-4334-b481-6d6e8e47371f",
152
- * "prefix": "example-prefix"
150
+ * s3Source: {
151
+ * bucketName: "aws-supply-chain-data-b8c7bb28-a576-4334-b481-6d6e8e47371f",
152
+ * prefix: "example-prefix"
153
153
  * },
154
- * "sourceName": "testSourceName",
155
- * "sourceType": "S3"
154
+ * sourceName: "testSourceName",
155
+ * sourceType: "S3"
156
156
  * }
157
157
  * ],
158
- * "target": {
159
- * "datasetTarget": {
160
- * "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset"
158
+ * target: {
159
+ * datasetTarget: {
160
+ * datasetIdentifier: "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset"
161
161
  * },
162
- * "targetType": "DATASET"
162
+ * targetType: "DATASET"
163
163
  * },
164
- * "transformation": {
165
- * "sqlTransformation": {
166
- * "query": "SELECT * FROM testSourceName"
164
+ * transformation: {
165
+ * sqlTransformation: {
166
+ * query: "SELECT * FROM testSourceName"
167
167
  * },
168
- * "transformationType": "SQL"
168
+ * transformationType: "SQL"
169
169
  * }
170
170
  * },
171
171
  * {
172
- * "name": "trading-partner",
173
- * "createdTime": 17235763506.88,
174
- * "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d",
175
- * "lastModifiedTime": 17235763506.88,
176
- * "sources": [
172
+ * createdTime: 1.723576350688E10,
173
+ * instanceId: "8850c54e-e187-4fa7-89d4-6370f165174d",
174
+ * lastModifiedTime: 1.723576350688E10,
175
+ * name: "trading-partner",
176
+ * sources: [
177
177
  * {
178
- * "datasetSource": {
179
- * "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset1"
178
+ * datasetSource: {
179
+ * datasetIdentifier: "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset1"
180
180
  * },
181
- * "sourceName": "testSourceName1",
182
- * "sourceType": "DATASET"
181
+ * sourceName: "testSourceName1",
182
+ * sourceType: "DATASET"
183
183
  * },
184
184
  * {
185
- * "datasetSource": {
186
- * "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset2"
185
+ * datasetSource: {
186
+ * datasetIdentifier: "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset2"
187
187
  * },
188
- * "sourceName": "testSourceName2",
189
- * "sourceType": "DATASET"
188
+ * sourceName: "testSourceName2",
189
+ * sourceType: "DATASET"
190
190
  * }
191
191
  * ],
192
- * "target": {
193
- * "datasetTarget": {
194
- * "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner"
192
+ * target: {
193
+ * datasetTarget: {
194
+ * datasetIdentifier: "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner"
195
195
  * },
196
- * "targetType": "DATASET"
196
+ * targetType: "DATASET"
197
197
  * },
198
- * "transformation": {
199
- * "sqlTransformation": {
200
- * "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"
198
+ * transformation: {
199
+ * sqlTransformation: {
200
+ * 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"
201
201
  * },
202
- * "transformationType": "SQL"
202
+ * transformationType: "SQL"
203
203
  * }
204
204
  * }
205
205
  * ]
206
206
  * }
207
207
  * *\/
208
- * // example id: example-1
209
208
  * ```
210
209
  *
210
+ * @public
211
211
  */
212
212
  export declare class ListDataIntegrationFlowsCommand extends ListDataIntegrationFlowsCommand_base {
213
213
  /** @internal type navigation helper, not in runtime. */