@aws-sdk/client-supplychain 3.671.0 → 3.672.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.
@@ -93,6 +93,60 @@ declare const CreateInstanceCommand_base: {
93
93
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
94
94
  *
95
95
  * @public
96
+ * @example Successful CreateInstance request with all input data
97
+ * ```javascript
98
+ * //
99
+ * const input = {
100
+ * "instanceDescription": "example instance description",
101
+ * "instanceName": "example instance name",
102
+ * "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
103
+ * "tags": {
104
+ * "tagKey1": "tagValue1"
105
+ * }
106
+ * };
107
+ * const command = new CreateInstanceCommand(input);
108
+ * const response = await client.send(command);
109
+ * /* response ==
110
+ * {
111
+ * "instance": {
112
+ * "awsAccountId": "123456789012",
113
+ * "createdTime": 172615383136,
114
+ * "instanceDescription": "example instance description",
115
+ * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
116
+ * "instanceName": "example instance name",
117
+ * "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
118
+ * "lastModifiedTime": 172615383136,
119
+ * "state": "Initializing",
120
+ * "versionNumber": 2
121
+ * }
122
+ * }
123
+ * *\/
124
+ * // example id: example-1
125
+ * ```
126
+ *
127
+ * @example Successful CreateInstance request with no input data
128
+ * ```javascript
129
+ * //
130
+ * const input = {};
131
+ * const command = new CreateInstanceCommand(input);
132
+ * const response = await client.send(command);
133
+ * /* response ==
134
+ * {
135
+ * "instance": {
136
+ * "awsAccountId": "123456789012",
137
+ * "createdTime": 172615383136,
138
+ * "instanceDescription": "",
139
+ * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
140
+ * "kmsKeyArn": "arn:aws:kms:us-west-2:456789012345:key/7372eb6d-874c-4212-8d49-7804282d33a8",
141
+ * "lastModifiedTime": 172615383136,
142
+ * "state": "Initializing",
143
+ * "versionNumber": 2
144
+ * }
145
+ * }
146
+ * *\/
147
+ * // example id: example-2
148
+ * ```
149
+ *
96
150
  */
97
151
  export declare class CreateInstanceCommand extends CreateInstanceCommand_base {
98
152
  /** @internal type navigation helper, not in runtime. */
@@ -87,6 +87,32 @@ declare const DeleteInstanceCommand_base: {
87
87
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
88
88
  *
89
89
  * @public
90
+ * @example Successful DeleteInstance request
91
+ * ```javascript
92
+ * //
93
+ * const input = {
94
+ * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793"
95
+ * };
96
+ * const command = new DeleteInstanceCommand(input);
97
+ * const response = await client.send(command);
98
+ * /* response ==
99
+ * {
100
+ * "instance": {
101
+ * "awsAccountId": "123456789012",
102
+ * "createdTime": 172615383136,
103
+ * "instanceDescription": "updated example instance description",
104
+ * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
105
+ * "instanceName": "updated example instance name",
106
+ * "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
107
+ * "lastModifiedTime": 172615383136,
108
+ * "state": "Deleting",
109
+ * "versionNumber": 2
110
+ * }
111
+ * }
112
+ * *\/
113
+ * // example id: example-1
114
+ * ```
115
+ *
90
116
  */
91
117
  export declare class DeleteInstanceCommand extends DeleteInstanceCommand_base {
92
118
  /** @internal type navigation helper, not in runtime. */
@@ -87,6 +87,32 @@ declare const GetInstanceCommand_base: {
87
87
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
88
88
  *
89
89
  * @public
90
+ * @example Successful GetInstance request
91
+ * ```javascript
92
+ * //
93
+ * const input = {
94
+ * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793"
95
+ * };
96
+ * const command = new GetInstanceCommand(input);
97
+ * const response = await client.send(command);
98
+ * /* response ==
99
+ * {
100
+ * "instance": {
101
+ * "awsAccountId": "123456789012",
102
+ * "createdTime": 172615383136,
103
+ * "instanceDescription": "example instance description",
104
+ * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
105
+ * "instanceName": "example instance name",
106
+ * "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
107
+ * "lastModifiedTime": 172615383136,
108
+ * "state": "Active",
109
+ * "versionNumber": 2
110
+ * }
111
+ * }
112
+ * *\/
113
+ * // example id: example-1
114
+ * ```
115
+ *
90
116
  */
91
117
  export declare class GetInstanceCommand extends GetInstanceCommand_base {
92
118
  /** @internal type navigation helper, not in runtime. */
@@ -97,6 +97,132 @@ declare const ListInstancesCommand_base: {
97
97
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
98
98
  *
99
99
  * @public
100
+ * @example Successful ListInstance request with no input data
101
+ * ```javascript
102
+ * //
103
+ * const input = {};
104
+ * const command = new ListInstancesCommand(input);
105
+ * const response = await client.send(command);
106
+ * /* response ==
107
+ * {
108
+ * "instances": [
109
+ * {
110
+ * "awsAccountId": "123456789012",
111
+ * "createdTime": 172615383136,
112
+ * "instanceDescription": "example instance description",
113
+ * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
114
+ * "instanceName": "example instance name",
115
+ * "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
116
+ * "lastModifiedTime": 172615383136,
117
+ * "state": "Active",
118
+ * "versionNumber": 2
119
+ * },
120
+ * {
121
+ * "awsAccountId": "123456789012",
122
+ * "createdTime": 17261674383136,
123
+ * "instanceDescription": "example instance description",
124
+ * "instanceId": "3ad8116a-644d-4172-8dcb-20e51d314c14",
125
+ * "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
126
+ * "lastModifiedTime": 17261674383136,
127
+ * "state": "Initializing",
128
+ * "versionNumber": 2
129
+ * }
130
+ * ]
131
+ * }
132
+ * *\/
133
+ * // example id: example-1
134
+ * ```
135
+ *
136
+ * @example Successful ListInstance request with filters
137
+ * ```javascript
138
+ * //
139
+ * const input = {
140
+ * "instanceNameFilter": [
141
+ * "example instance name"
142
+ * ],
143
+ * "instanceStateFilter": [
144
+ * "Active"
145
+ * ]
146
+ * };
147
+ * const command = new ListInstancesCommand(input);
148
+ * const response = await client.send(command);
149
+ * /* response ==
150
+ * {
151
+ * "instances": [
152
+ * {
153
+ * "awsAccountId": "123456789012",
154
+ * "createdTime": 172615383136,
155
+ * "instanceDescription": "example instance description",
156
+ * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
157
+ * "instanceName": "example instance name",
158
+ * "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
159
+ * "lastModifiedTime": 172615383136,
160
+ * "state": "Active",
161
+ * "versionNumber": 2
162
+ * }
163
+ * ]
164
+ * }
165
+ * *\/
166
+ * // example id: example-2
167
+ * ```
168
+ *
169
+ * @example Successful ListInstance request with maxResult override
170
+ * ```javascript
171
+ * //
172
+ * const input = {
173
+ * "maxResults": 1
174
+ * };
175
+ * const command = new ListInstancesCommand(input);
176
+ * const response = await client.send(command);
177
+ * /* response ==
178
+ * {
179
+ * "instances": [
180
+ * {
181
+ * "awsAccountId": "123456789012",
182
+ * "createdTime": 172615383136,
183
+ * "instanceDescription": "example instance description",
184
+ * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
185
+ * "instanceName": "example instance name",
186
+ * "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
187
+ * "lastModifiedTime": 172615383136,
188
+ * "state": "Active",
189
+ * "versionNumber": 2
190
+ * }
191
+ * ],
192
+ * "nextToken": "AAQA-EFRSURBSGhtcng0c0dxbENwUHdnckVIbkFYNU1QVjRTZWN2ak5iMFVicC8zemlHOVF3SEpjSC9WTWJVVXBMV2Z1N3ZvZlQ0WEFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTTJibW9LemgrSWZTY0RaZEdBZ0VRZ0R2dDhsQnVGbGJ0dnFTZityWmNSWEVPbG93emJoSjhxOGNMbGQ1UGMvY0VRbWlTR3pQUFd4N2RraXY5Y0ovcS9vSmFYZVBGdWVHaU0zWmd0dz09n-rC1ejA5--7ltJxpDT2xP_i8xGqDPMOZfjpp8q6l5NuP9_bnBURvwwYhdqDriMK5_f96LuPEnPbuML-ItfgEiCcUy0p2tApvpZkZqOG5fbqP-4C5aDYPTffHLyq-MMqvfrGVJzL1nvkpZcnTkVR9VJsu5b8I0qqDW0H8EMKGgTo78U9lr4sj3Usi9VMwZxgKCBmr03HhFLYXOW--XMbIx0CTZF0fYIcRxmA_sVS6J7gpaB9yMcnzs5VUKokoA5JTcAPY5d1Y1VyE8KKxv51cfPgXw8OYCDbFQncw8mZPmE-VqxjFbksmk_FmghpPn9j2Ppoe-zr0LQ%3D"
193
+ * }
194
+ * *\/
195
+ * // example id: example-3
196
+ * ```
197
+ *
198
+ * @example Successful ListInstance request with nextToken
199
+ * ```javascript
200
+ * //
201
+ * const input = {
202
+ * "maxResults": 1,
203
+ * "nextToken": "AAQA-EFRSURBSGhtcng0c0dxbENwUHdnckVIbkFYNU1QVjRTZWN2ak5iMFVicC8zemlHOVF3SEpjSC9WTWJVVXBMV2Z1N3ZvZlQ0WEFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTTJibW9LemgrSWZTY0RaZEdBZ0VRZ0R2dDhsQnVGbGJ0dnFTZityWmNSWEVPbG93emJoSjhxOGNMbGQ1UGMvY0VRbWlTR3pQUFd4N2RraXY5Y0ovcS9vSmFYZVBGdWVHaU0zWmd0dz09n-rC1ejA5--7ltJxpDT2xP_i8xGqDPMOZfjpp8q6l5NuP9_bnBURvwwYhdqDriMK5_f96LuPEnPbuML-ItfgEiCcUy0p2tApvpZkZqOG5fbqP-4C5aDYPTffHLyq-MMqvfrGVJzL1nvkpZcnTkVR9VJsu5b8I0qqDW0H8EMKGgTo78U9lr4sj3Usi9VMwZxgKCBmr03HhFLYXOW--XMbIx0CTZF0fYIcRxmA_sVS6J7gpaB9yMcnzs5VUKokoA5JTcAPY5d1Y1VyE8KKxv51cfPgXw8OYCDbFQncw8mZPmE-VqxjFbksmk_FmghpPn9j2Ppoe-zr0LQ%3D"
204
+ * };
205
+ * const command = new ListInstancesCommand(input);
206
+ * const response = await client.send(command);
207
+ * /* response ==
208
+ * {
209
+ * "instances": [
210
+ * {
211
+ * "awsAccountId": "123456789012",
212
+ * "createdTime": 17261674383136,
213
+ * "instanceDescription": "example instance description",
214
+ * "instanceId": "3ad8116a-644d-4172-8dcb-20e51d314c14",
215
+ * "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
216
+ * "lastModifiedTime": 17261674383136,
217
+ * "state": "Initializing",
218
+ * "versionNumber": 2
219
+ * }
220
+ * ]
221
+ * }
222
+ * *\/
223
+ * // example id: example-4
224
+ * ```
225
+ *
100
226
  */
101
227
  export declare class ListInstancesCommand extends ListInstancesCommand_base {
102
228
  /** @internal type navigation helper, not in runtime. */
@@ -89,6 +89,34 @@ declare const UpdateInstanceCommand_base: {
89
89
  * <p>Base exception class for all service exceptions from SupplyChain service.</p>
90
90
  *
91
91
  * @public
92
+ * @example Successful UpdateInstance request
93
+ * ```javascript
94
+ * //
95
+ * const input = {
96
+ * "instanceDescription": "updated example instance description",
97
+ * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
98
+ * "instanceName": "updated example instance name"
99
+ * };
100
+ * const command = new UpdateInstanceCommand(input);
101
+ * const response = await client.send(command);
102
+ * /* response ==
103
+ * {
104
+ * "instance": {
105
+ * "awsAccountId": "123456789012",
106
+ * "createdTime": 172615383136,
107
+ * "instanceDescription": "updated example instance description",
108
+ * "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793",
109
+ * "instanceName": "updated example instance name",
110
+ * "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d",
111
+ * "lastModifiedTime": 172615383136,
112
+ * "state": "Active",
113
+ * "versionNumber": 2
114
+ * }
115
+ * }
116
+ * *\/
117
+ * // example id: example-1
118
+ * ```
119
+ *
92
120
  */
93
121
  export declare class UpdateInstanceCommand extends UpdateInstanceCommand_base {
94
122
  /** @internal type navigation helper, not in runtime. */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-supplychain",
3
3
  "description": "AWS SDK for JavaScript Supplychain Client for Node.js, Browser and React Native",
4
- "version": "3.671.0",
4
+ "version": "3.672.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-supplychain",