@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.
Files changed (22) hide show
  1. package/dist-types/commands/CreateBillOfMaterialsImportJobCommand.d.ts +7 -7
  2. package/dist-types/commands/CreateDataIntegrationFlowCommand.d.ts +47 -48
  3. package/dist-types/commands/CreateDataLakeDatasetCommand.d.ts +160 -161
  4. package/dist-types/commands/CreateInstanceCommand.d.ts +29 -30
  5. package/dist-types/commands/DeleteDataIntegrationFlowCommand.d.ts +7 -7
  6. package/dist-types/commands/DeleteDataLakeDatasetCommand.d.ts +16 -17
  7. package/dist-types/commands/DeleteInstanceCommand.d.ts +14 -14
  8. package/dist-types/commands/GetBillOfMaterialsImportJobCommand.d.ts +19 -20
  9. package/dist-types/commands/GetDataIntegrationFlowCommand.d.ts +24 -24
  10. package/dist-types/commands/GetDataLakeDatasetCommand.d.ts +136 -137
  11. package/dist-types/commands/GetInstanceCommand.d.ts +27 -28
  12. package/dist-types/commands/ListDataIntegrationFlowsCommand.d.ts +44 -44
  13. package/dist-types/commands/ListDataLakeDatasetsCommand.d.ts +157 -158
  14. package/dist-types/commands/ListInstancesCommand.d.ts +60 -63
  15. package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -6
  16. package/dist-types/commands/SendDataIntegrationEventCommand.d.ts +107 -121
  17. package/dist-types/commands/TagResourceCommand.d.ts +9 -6
  18. package/dist-types/commands/UntagResourceCommand.d.ts +8 -5
  19. package/dist-types/commands/UpdateDataIntegrationFlowCommand.d.ts +80 -81
  20. package/dist-types/commands/UpdateDataLakeDatasetCommand.d.ts +138 -139
  21. package/dist-types/commands/UpdateInstanceCommand.d.ts +16 -16
  22. package/package.json +5 -5
package/dist-types/commands/CreateInstanceCommand.d.ts CHANGED
@@ -95,61 +95,60 @@ declare const CreateInstanceCommand_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 Successful CreateInstance request with all input data
100
100
  * ```javascript
101
101
  * //
102
102
  * const input = {
103
- * "instanceDescription": "example instance description",
104
- * "instanceName": "example instance name",
105
- * "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
106
- * "tags": {
107
- * "tagKey1": "tagValue1"
103
+ * instanceDescription: "example instance description",
104
+ * instanceName: "example instance name",
105
+ * kmsKeyArn: "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
106
+ * tags: {
107
+ * tagKey1: "tagValue1"
108
108
  * }
109
109
  * };
110
110
  * const command = new CreateInstanceCommand(input);
111
111
  * const response = await client.send(command);
112
- * /* response ==
112
+ * /* response is
113
113
  * {
114
- * "instance": {
115
- * "awsAccountId": "123456789012",
116
- * "createdTime": 172615383136,
117
- * "instanceDescription": "example instance description",
118
- * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
119
- * "instanceName": "example instance name",
120
- * "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
121
- * "lastModifiedTime": 172615383136,
122
- * "state": "Initializing",
123
- * "versionNumber": 2
114
+ * instance: {
115
+ * awsAccountId: "123456789012",
116
+ * createdTime: 172615383136,
117
+ * instanceDescription: "example instance description",
118
+ * instanceId: "9e193580-7cc5-45f7-9609-c43ba0ada793",
119
+ * instanceName: "example instance name",
120
+ * kmsKeyArn: "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
121
+ * lastModifiedTime: 172615383136,
122
+ * state: "Initializing",
123
+ * versionNumber: 2.0
124
124
  * }
125
125
  * }
126
126
  * *\/
127
- * // example id: example-1
128
127
  * ```
129
128
  *
130
129
  * @example Successful CreateInstance request with no input data
131
130
  * ```javascript
132
131
  * //
133
- * const input = {};
132
+ * const input = { /* empty *\/ };
134
133
  * const command = new CreateInstanceCommand(input);
135
134
  * const response = await client.send(command);
136
- * /* response ==
135
+ * /* response is
137
136
  * {
138
- * "instance": {
139
- * "awsAccountId": "123456789012",
140
- * "createdTime": 172615383136,
141
- * "instanceDescription": "",
142
- * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
143
- * "kmsKeyArn": "arn:aws:kms:us-west-2:456789012345:key/7372eb6d-874c-4212-8d49-7804282d33a8",
144
- * "lastModifiedTime": 172615383136,
145
- * "state": "Initializing",
146
- * "versionNumber": 2
137
+ * instance: {
138
+ * awsAccountId: "123456789012",
139
+ * createdTime: 172615383136,
140
+ * instanceDescription: "",
141
+ * instanceId: "9e193580-7cc5-45f7-9609-c43ba0ada793",
142
+ * kmsKeyArn: "arn:aws:kms:us-west-2:456789012345:key/7372eb6d-874c-4212-8d49-7804282d33a8",
143
+ * lastModifiedTime: 172615383136,
144
+ * state: "Initializing",
145
+ * versionNumber: 2.0
147
146
  * }
148
147
  * }
149
148
  * *\/
150
- * // example id: example-2
151
149
  * ```
152
150
  *
151
+ * @public
153
152
  */
154
153
  export declare class CreateInstanceCommand extends CreateInstanceCommand_base {
155
154
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/DeleteDataIntegrationFlowCommand.d.ts CHANGED
@@ -77,25 +77,25 @@ declare const DeleteDataIntegrationFlowCommand_base: {
77
77
  * @throws {@link SupplyChainServiceException}
78
78
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
79
79
  *
80
- * @public
80
+ *
81
81
  * @example Successful DeleteDataIntegrationFlow
82
82
  * ```javascript
83
83
  * //
84
84
  * const input = {
85
- * "name": "testStagingFlow",
86
- * "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d"
85
+ * instanceId: "8850c54e-e187-4fa7-89d4-6370f165174d",
86
+ * name: "testStagingFlow"
87
87
  * };
88
88
  * const command = new DeleteDataIntegrationFlowCommand(input);
89
89
  * const response = await client.send(command);
90
- * /* response ==
90
+ * /* response is
91
91
  * {
92
- * "name": "testStagingFlow",
93
- * "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d"
92
+ * instanceId: "8850c54e-e187-4fa7-89d4-6370f165174d",
93
+ * name: "testStagingFlow"
94
94
  * }
95
95
  * *\/
96
- * // example id: example-1
97
96
  * ```
98
97
  *
98
+ * @public
99
99
  */
100
100
  export declare class DeleteDataIntegrationFlowCommand extends DeleteDataIntegrationFlowCommand_base {
101
101
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/DeleteDataLakeDatasetCommand.d.ts CHANGED
@@ -79,47 +79,46 @@ declare const DeleteDataLakeDatasetCommand_base: {
79
79
  * @throws {@link SupplyChainServiceException}
80
80
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
81
81
  *
82
- * @public
82
+ *
83
83
  * @example Delete an AWS Supply Chain inbound_order dataset
84
84
  * ```javascript
85
85
  * //
86
86
  * const input = {
87
- * "name": "inbound_order",
88
- * "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
89
- * "namespace": "asc"
87
+ * instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
88
+ * name: "inbound_order",
89
+ * namespace: "asc"
90
90
  * };
91
91
  * const command = new DeleteDataLakeDatasetCommand(input);
92
92
  * const response = await client.send(command);
93
- * /* response ==
93
+ * /* response is
94
94
  * {
95
- * "name": "inbound_order",
96
- * "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
97
- * "namespace": "asc"
95
+ * instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
96
+ * name: "inbound_order",
97
+ * namespace: "asc"
98
98
  * }
99
99
  * *\/
100
- * // example id: example-1
101
100
  * ```
102
101
  *
103
102
  * @example Delete a custom dataset
104
103
  * ```javascript
105
104
  * //
106
105
  * const input = {
107
- * "name": "my_dataset",
108
- * "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
109
- * "namespace": "default"
106
+ * instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
107
+ * name: "my_dataset",
108
+ * namespace: "default"
110
109
  * };
111
110
  * const command = new DeleteDataLakeDatasetCommand(input);
112
111
  * const response = await client.send(command);
113
- * /* response ==
112
+ * /* response is
114
113
  * {
115
- * "name": "my_dataset",
116
- * "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5",
117
- * "namespace": "default"
114
+ * instanceId: "1877dd20-dee9-4639-8e99-cb67acf21fe5",
115
+ * name: "my_dataset",
116
+ * namespace: "default"
118
117
  * }
119
118
  * *\/
120
- * // example id: example-2
121
119
  * ```
122
120
  *
121
+ * @public
123
122
  */
124
123
  export declare class DeleteDataLakeDatasetCommand extends DeleteDataLakeDatasetCommand_base {
125
124
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/DeleteInstanceCommand.d.ts CHANGED
@@ -88,33 +88,33 @@ declare const DeleteInstanceCommand_base: {
88
88
  * @throws {@link SupplyChainServiceException}
89
89
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
90
90
  *
91
- * @public
91
+ *
92
92
  * @example Successful DeleteInstance request
93
93
  * ```javascript
94
94
  * //
95
95
  * const input = {
96
- * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793"
96
+ * instanceId: "9e193580-7cc5-45f7-9609-c43ba0ada793"
97
97
  * };
98
98
  * const command = new DeleteInstanceCommand(input);
99
99
  * const response = await client.send(command);
100
- * /* response ==
100
+ * /* response is
101
101
  * {
102
- * "instance": {
103
- * "awsAccountId": "123456789012",
104
- * "createdTime": 172615383136,
105
- * "instanceDescription": "updated example instance description",
106
- * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
107
- * "instanceName": "updated example instance name",
108
- * "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
109
- * "lastModifiedTime": 172615383136,
110
- * "state": "Deleting",
111
- * "versionNumber": 2
102
+ * instance: {
103
+ * awsAccountId: "123456789012",
104
+ * createdTime: 172615383136,
105
+ * instanceDescription: "updated example instance description",
106
+ * instanceId: "9e193580-7cc5-45f7-9609-c43ba0ada793",
107
+ * instanceName: "updated example instance name",
108
+ * kmsKeyArn: "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
109
+ * lastModifiedTime: 172615383136,
110
+ * state: "Deleting",
111
+ * versionNumber: 2.0
112
112
  * }
113
113
  * }
114
114
  * *\/
115
- * // example id: example-1
116
115
  * ```
117
116
  *
117
+ * @public
118
118
  */
119
119
  export declare class DeleteInstanceCommand extends DeleteInstanceCommand_base {
120
120
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/GetBillOfMaterialsImportJobCommand.d.ts CHANGED
@@ -82,52 +82,51 @@ declare const GetBillOfMaterialsImportJobCommand_base: {
82
82
  * @throws {@link SupplyChainServiceException}
83
83
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
84
84
  *
85
- * @public
85
+ *
86
86
  * @example Invoke GetBillOfMaterialsImportJob for a successful job
87
87
  * ```javascript
88
88
  * //
89
89
  * const input = {
90
- * "instanceId": "60f82bbd-71f7-4fcd-a941-472f574c5243",
91
- * "jobId": "f79b359b-1515-4436-a3bf-bae7b33e47b4"
90
+ * instanceId: "60f82bbd-71f7-4fcd-a941-472f574c5243",
91
+ * jobId: "f79b359b-1515-4436-a3bf-bae7b33e47b4"
92
92
  * };
93
93
  * const command = new GetBillOfMaterialsImportJobCommand(input);
94
94
  * const response = await client.send(command);
95
- * /* response ==
95
+ * /* response is
96
96
  * {
97
- * "job": {
98
- * "instanceId": "60f82bbd-71f7-4fcd-a941-472f574c5243",
99
- * "jobId": "f79b359b-1515-4436-a3bf-bae7b33e47b4",
100
- * "message": "Import job completed successfully.",
101
- * "s3uri": "s3://mybucketname/pathelemene/file.csv",
102
- * "status": "SUCCESS"
97
+ * job: {
98
+ * instanceId: "60f82bbd-71f7-4fcd-a941-472f574c5243",
99
+ * jobId: "f79b359b-1515-4436-a3bf-bae7b33e47b4",
100
+ * message: "Import job completed successfully.",
101
+ * s3uri: "s3://mybucketname/pathelemene/file.csv",
102
+ * status: "SUCCESS"
103
103
  * }
104
104
  * }
105
105
  * *\/
106
- * // example id: example-1
107
106
  * ```
108
107
  *
109
108
  * @example Invoke GetBillOfMaterialsImportJob for an in-progress job
110
109
  * ```javascript
111
110
  * //
112
111
  * const input = {
113
- * "instanceId": "60f82bbd-71f7-4fcd-a941-472f574c5243",
114
- * "jobId": "f79b359b-1515-4436-a3bf-bae7b33e47b4"
112
+ * instanceId: "60f82bbd-71f7-4fcd-a941-472f574c5243",
113
+ * jobId: "f79b359b-1515-4436-a3bf-bae7b33e47b4"
115
114
  * };
116
115
  * const command = new GetBillOfMaterialsImportJobCommand(input);
117
116
  * const response = await client.send(command);
118
- * /* response ==
117
+ * /* response is
119
118
  * {
120
- * "job": {
121
- * "instanceId": "60f82bbd-71f7-4fcd-a941-472f574c5243",
122
- * "jobId": "f79b359b-1515-4436-a3bf-bae7b33e47b4",
123
- * "s3uri": "s3://mybucketname/pathelemene/file.csv",
124
- * "status": "IN_PROGRESS"
119
+ * job: {
120
+ * instanceId: "60f82bbd-71f7-4fcd-a941-472f574c5243",
121
+ * jobId: "f79b359b-1515-4436-a3bf-bae7b33e47b4",
122
+ * s3uri: "s3://mybucketname/pathelemene/file.csv",
123
+ * status: "IN_PROGRESS"
125
124
  * }
126
125
  * }
127
126
  * *\/
128
- * // example id: example-2
129
127
  * ```
130
128
  *
129
+ * @public
131
130
  */
132
131
  export declare class GetBillOfMaterialsImportJobCommand extends GetBillOfMaterialsImportJobCommand_base {
133
132
  /** @internal type navigation helper, not in runtime. */
package/dist-types/commands/GetDataIntegrationFlowCommand.d.ts CHANGED
@@ -124,51 +124,51 @@ declare const GetDataIntegrationFlowCommand_base: {
124
124
  * @throws {@link SupplyChainServiceException}
125
125
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
126
126
  *
127
- * @public
127
+ *
128
128
  * @example Successful GetDataIntegrationFlow
129
129
  * ```javascript
130
130
  * //
131
131
  * const input = {
132
- * "name": "testStagingFlow",
133
- * "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d"
132
+ * instanceId: "8850c54e-e187-4fa7-89d4-6370f165174d",
133
+ * name: "testStagingFlow"
134
134
  * };
135
135
  * const command = new GetDataIntegrationFlowCommand(input);
136
136
  * const response = await client.send(command);
137
- * /* response ==
137
+ * /* response is
138
138
  * {
139
- * "flow": {
140
- * "name": "testStagingFlow",
141
- * "createdTime": 1724956400.44,
142
- * "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d",
143
- * "lastModifiedTime": 1724956400.44,
144
- * "sources": [
139
+ * flow: {
140
+ * createdTime: 1.72495640044E9,
141
+ * instanceId: "8850c54e-e187-4fa7-89d4-6370f165174d",
142
+ * lastModifiedTime: 1.72495640044E9,
143
+ * name: "testStagingFlow",
144
+ * sources: [
145
145
  * {
146
- * "s3Source": {
147
- * "bucketName": "aws-supply-chain-data-b8c7bb28-a576-4334-b481-6d6e8e47371f",
148
- * "prefix": "example-prefix"
146
+ * s3Source: {
147
+ * bucketName: "aws-supply-chain-data-b8c7bb28-a576-4334-b481-6d6e8e47371f",
148
+ * prefix: "example-prefix"
149
149
  * },
150
- * "sourceName": "testSourceName",
151
- * "sourceType": "S3"
150
+ * sourceName: "testSourceName",
151
+ * sourceType: "S3"
152
152
  * }
153
153
  * ],
154
- * "target": {
155
- * "datasetTarget": {
156
- * "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset"
154
+ * target: {
155
+ * datasetTarget: {
156
+ * datasetIdentifier: "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset"
157
157
  * },
158
- * "targetType": "DATASET"
158
+ * targetType: "DATASET"
159
159
  * },
160
- * "transformation": {
161
- * "sqlTransformation": {
162
- * "query": "SELECT * FROM testSourceName"
160
+ * transformation: {
161
+ * sqlTransformation: {
162
+ * query: "SELECT * FROM testSourceName"
163
163
  * },
164
- * "transformationType": "SQL"
164
+ * transformationType: "SQL"
165
165
  * }
166
166
  * }
167
167
  * }
168
168
  * *\/
169
- * // example id: example-1
170
169
  * ```
171
170
  *
171
+ * @public
172
172
  */
173
173
  export declare class GetDataIntegrationFlowCommand extends GetDataIntegrationFlowCommand_base {
174
174
  /** @internal type navigation helper, not in runtime. */