@aws-sdk/client-tnb 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 (34) hide show
  1. package/dist-types/commands/CancelSolNetworkOperationCommand.d.ts +14 -0
  2. package/dist-types/commands/CreateSolFunctionPackageCommand.d.ts +25 -0
  3. package/dist-types/commands/CreateSolNetworkInstanceCommand.d.ts +27 -0
  4. package/dist-types/commands/CreateSolNetworkPackageCommand.d.ts +25 -0
  5. package/dist-types/commands/DeleteSolFunctionPackageCommand.d.ts +14 -0
  6. package/dist-types/commands/DeleteSolNetworkInstanceCommand.d.ts +14 -0
  7. package/dist-types/commands/DeleteSolNetworkPackageCommand.d.ts +14 -0
  8. package/dist-types/commands/GetSolFunctionInstanceCommand.d.ts +40 -0
  9. package/dist-types/commands/GetSolFunctionPackageCommand.d.ts +31 -0
  10. package/dist-types/commands/GetSolFunctionPackageContentCommand.d.ts +18 -0
  11. package/dist-types/commands/GetSolFunctionPackageDescriptorCommand.d.ts +18 -0
  12. package/dist-types/commands/GetSolNetworkInstanceCommand.d.ts +29 -0
  13. package/dist-types/commands/GetSolNetworkOperationCommand.d.ts +174 -0
  14. package/dist-types/commands/GetSolNetworkPackageCommand.d.ts +42 -0
  15. package/dist-types/commands/GetSolNetworkPackageContentCommand.d.ts +18 -0
  16. package/dist-types/commands/GetSolNetworkPackageDescriptorCommand.d.ts +17 -0
  17. package/dist-types/commands/InstantiateSolNetworkInstanceCommand.d.ts +41 -0
  18. package/dist-types/commands/ListSolFunctionInstancesCommand.d.ts +74 -0
  19. package/dist-types/commands/ListSolFunctionPackagesCommand.d.ts +83 -0
  20. package/dist-types/commands/ListSolNetworkInstancesCommand.d.ts +58 -0
  21. package/dist-types/commands/ListSolNetworkOperationsCommand.d.ts +118 -0
  22. package/dist-types/commands/ListSolNetworkPackagesCommand.d.ts +101 -0
  23. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -0
  24. package/dist-types/commands/PutSolFunctionPackageContentCommand.d.ts +27 -0
  25. package/dist-types/commands/PutSolNetworkPackageContentCommand.d.ts +39 -0
  26. package/dist-types/commands/TagResourceCommand.d.ts +1 -0
  27. package/dist-types/commands/TerminateSolNetworkInstanceCommand.d.ts +22 -0
  28. package/dist-types/commands/UntagResourceCommand.d.ts +1 -0
  29. package/dist-types/commands/UpdateSolFunctionPackageCommand.d.ts +33 -0
  30. package/dist-types/commands/UpdateSolNetworkInstanceCommand.d.ts +59 -0
  31. package/dist-types/commands/UpdateSolNetworkPackageCommand.d.ts +33 -0
  32. package/dist-types/commands/ValidateSolFunctionPackageContentCommand.d.ts +27 -0
  33. package/dist-types/commands/ValidateSolNetworkPackageContentCommand.d.ts +39 -0
  34. package/package.json +5 -5
@@ -69,6 +69,20 @@ declare const CancelSolNetworkOperationCommand_base: {
69
69
  * @throws {@link TnbServiceException}
70
70
  * <p>Base exception class for all service exceptions from Tnb service.</p>
71
71
  *
72
+ *
73
+ * @example Cancel a in-progress Sol Network Operation.
74
+ * ```javascript
75
+ * //
76
+ * const input = {
77
+ * nsLcmOpOccId: "no-0d5b823eb5c2a9241"
78
+ * };
79
+ * const command = new CancelSolNetworkOperationCommand(input);
80
+ * const response = await client.send(command);
81
+ * /* response is
82
+ * { /* metadata only *\/ }
83
+ * *\/
84
+ * ```
85
+ *
72
86
  * @public
73
87
  */
74
88
  export declare class CancelSolNetworkOperationCommand extends CancelSolNetworkOperationCommand_base {
@@ -84,6 +84,31 @@ declare const CreateSolFunctionPackageCommand_base: {
84
84
  * @throws {@link TnbServiceException}
85
85
  * <p>Base exception class for all service exceptions from Tnb service.</p>
86
86
  *
87
+ *
88
+ * @example Create a Sol function package
89
+ * ```javascript
90
+ * //
91
+ * const input = {
92
+ * tags: {
93
+ * Name: "Resource"
94
+ * }
95
+ * };
96
+ * const command = new CreateSolFunctionPackageCommand(input);
97
+ * const response = await client.send(command);
98
+ * /* response is
99
+ * {
100
+ * arn: "arn:aws:tnb:us-west-2:123456789000:function-package/fp-07aa863e53460a2a6",
101
+ * id: "fp-07aa863e53460a2a6",
102
+ * onboardingState: "CREATED",
103
+ * operationalState: "DISABLED",
104
+ * tags: {
105
+ * Name: "Resource"
106
+ * },
107
+ * usageState: "NOT_IN_USE"
108
+ * }
109
+ * *\/
110
+ * ```
111
+ *
87
112
  * @public
88
113
  */
89
114
  export declare class CreateSolFunctionPackageCommand extends CreateSolFunctionPackageCommand_base {
@@ -89,6 +89,33 @@ declare const CreateSolNetworkInstanceCommand_base: {
89
89
  * @throws {@link TnbServiceException}
90
90
  * <p>Base exception class for all service exceptions from Tnb service.</p>
91
91
  *
92
+ *
93
+ * @example Create a Sol Network Instance
94
+ * ```javascript
95
+ * //
96
+ * const input = {
97
+ * nsDescription: "Test network for CITY",
98
+ * nsName: "CITY Instance",
99
+ * nsdInfoId: "np-0d5b823eb5c2a9241",
100
+ * tags: {
101
+ * Name: "Resource"
102
+ * }
103
+ * };
104
+ * const command = new CreateSolNetworkInstanceCommand(input);
105
+ * const response = await client.send(command);
106
+ * /* response is
107
+ * {
108
+ * arn: "arn:aws:tnb:us-west-2:123456789000:network-instance/ni-07aa863e53460a2a6",
109
+ * id: "ni-07aa863e53460a2a6",
110
+ * nsInstanceName: "CITY Instance",
111
+ * nsdInfoId: "np-0d5b823eb5c2a9241",
112
+ * tags: {
113
+ * Name: "Resource"
114
+ * }
115
+ * }
116
+ * *\/
117
+ * ```
118
+ *
92
119
  * @public
93
120
  */
94
121
  export declare class CreateSolNetworkInstanceCommand extends CreateSolNetworkInstanceCommand_base {
@@ -87,6 +87,31 @@ declare const CreateSolNetworkPackageCommand_base: {
87
87
  * @throws {@link TnbServiceException}
88
88
  * <p>Base exception class for all service exceptions from Tnb service.</p>
89
89
  *
90
+ *
91
+ * @example Create a Sol network package
92
+ * ```javascript
93
+ * //
94
+ * const input = {
95
+ * tags: {
96
+ * Name: "Resource"
97
+ * }
98
+ * };
99
+ * const command = new CreateSolNetworkPackageCommand(input);
100
+ * const response = await client.send(command);
101
+ * /* response is
102
+ * {
103
+ * arn: "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241",
104
+ * id: "np-0d5b823eb5c2a9241",
105
+ * nsdOnboardingState: "CREATED",
106
+ * nsdOperationalState: "DISABLED",
107
+ * nsdUsageState: "NOT_IN_USE",
108
+ * tags: {
109
+ * Name: "Resource"
110
+ * }
111
+ * }
112
+ * *\/
113
+ * ```
114
+ *
90
115
  * @public
91
116
  */
92
117
  export declare class CreateSolNetworkPackageCommand extends CreateSolNetworkPackageCommand_base {
@@ -71,6 +71,20 @@ declare const DeleteSolFunctionPackageCommand_base: {
71
71
  * @throws {@link TnbServiceException}
72
72
  * <p>Base exception class for all service exceptions from Tnb service.</p>
73
73
  *
74
+ *
75
+ * @example Delete a function package
76
+ * ```javascript
77
+ * //
78
+ * const input = {
79
+ * vnfPkgId: "fp-07aa863e53460a2a6"
80
+ * };
81
+ * const command = new DeleteSolFunctionPackageCommand(input);
82
+ * const response = await client.send(command);
83
+ * /* response is
84
+ * { /* metadata only *\/ }
85
+ * *\/
86
+ * ```
87
+ *
74
88
  * @public
75
89
  */
76
90
  export declare class DeleteSolFunctionPackageCommand extends DeleteSolFunctionPackageCommand_base {
@@ -71,6 +71,20 @@ declare const DeleteSolNetworkInstanceCommand_base: {
71
71
  * @throws {@link TnbServiceException}
72
72
  * <p>Base exception class for all service exceptions from Tnb service.</p>
73
73
  *
74
+ *
75
+ * @example Delete a Sol Network Instance.
76
+ * ```javascript
77
+ * //
78
+ * const input = {
79
+ * nsInstanceId: "ni-07aa863e53460a2a6"
80
+ * };
81
+ * const command = new DeleteSolNetworkInstanceCommand(input);
82
+ * const response = await client.send(command);
83
+ * /* response is
84
+ * { /* metadata only *\/ }
85
+ * *\/
86
+ * ```
87
+ *
74
88
  * @public
75
89
  */
76
90
  export declare class DeleteSolNetworkInstanceCommand extends DeleteSolNetworkInstanceCommand_base {
@@ -71,6 +71,20 @@ declare const DeleteSolNetworkPackageCommand_base: {
71
71
  * @throws {@link TnbServiceException}
72
72
  * <p>Base exception class for all service exceptions from Tnb service.</p>
73
73
  *
74
+ *
75
+ * @example Delete a Sol network package
76
+ * ```javascript
77
+ * //
78
+ * const input = {
79
+ * nsdInfoId: "np-0d5b823eb5c2a9241"
80
+ * };
81
+ * const command = new DeleteSolNetworkPackageCommand(input);
82
+ * const response = await client.send(command);
83
+ * /* response is
84
+ * { /* metadata only *\/ }
85
+ * *\/
86
+ * ```
87
+ *
74
88
  * @public
75
89
  */
76
90
  export declare class DeleteSolNetworkPackageCommand extends DeleteSolNetworkPackageCommand_base {
@@ -99,6 +99,46 @@ declare const GetSolFunctionInstanceCommand_base: {
99
99
  * @throws {@link TnbServiceException}
100
100
  * <p>Base exception class for all service exceptions from Tnb service.</p>
101
101
  *
102
+ *
103
+ * @example Get a Sol Network Function Instance details
104
+ * ```javascript
105
+ * //
106
+ * const input = {
107
+ * vnfInstanceId: "fi-b9439c34c1ef86c54"
108
+ * };
109
+ * const command = new GetSolFunctionInstanceCommand(input);
110
+ * const response = await client.send(command);
111
+ * /* response is
112
+ * {
113
+ * arn: "arn:aws:tnb:us-west-2:123456789000:function-instance/fi-b9439c34c1ef86c54",
114
+ * id: "fi-b9439c34c1ef86c54",
115
+ * instantiatedVnfInfo: {
116
+ * vnfState: "STARTED",
117
+ * vnfcResourceInfo: [
118
+ * {
119
+ * metadata: {
120
+ * cluster: "TestCluster",
121
+ * helmChart: "VnfHelmChart01",
122
+ * nodeGroup: "Core-EKS-TEST01-EKSNodeGroup-94BNRKWRV6MP"
123
+ * }
124
+ * }
125
+ * ]
126
+ * },
127
+ * instantiationState: "INSTANTIATED",
128
+ * metadata: {
129
+ * createdAt: "2022-06-10T19:48:33Z",
130
+ * lastModified: "2022-06-10T19:48:33Z"
131
+ * },
132
+ * nsInstanceId: "ni-07aa863e53460a2a6",
133
+ * vnfPkgId: "fp-07aa863e53460a2a6",
134
+ * vnfProductName: "VNFBuilder-AMF",
135
+ * vnfProvider: "VNFBuilder",
136
+ * vnfdId: "6625a858-2157-4d74-9197-a6ff67d51f3e",
137
+ * vnfdVersion: "1.0"
138
+ * }
139
+ * *\/
140
+ * ```
141
+ *
102
142
  * @public
103
143
  */
104
144
  export declare class GetSolFunctionInstanceCommand extends GetSolFunctionInstanceCommand_base {
@@ -95,6 +95,37 @@ declare const GetSolFunctionPackageCommand_base: {
95
95
  * @throws {@link TnbServiceException}
96
96
  * <p>Base exception class for all service exceptions from Tnb service.</p>
97
97
  *
98
+ *
99
+ * @example Describe a function package with correct vnfPkgId
100
+ * ```javascript
101
+ * //
102
+ * const input = {
103
+ * vnfPkgId: "fp-07aa863e53460a2a6"
104
+ * };
105
+ * const command = new GetSolFunctionPackageCommand(input);
106
+ * const response = await client.send(command);
107
+ * /* response is
108
+ * {
109
+ * arn: "arn:aws:tnb:us-west-2:123456789000:function-package/fp-07aa863e53460a2a6",
110
+ * id: "fp-07aa863e53460a2a6",
111
+ * metadata: {
112
+ * createdAt: "2022-06-10T19:48:34Z",
113
+ * lastModified: "2022-06-10T21:48:33Z",
114
+ * vnfd: {
115
+ * overrides: []
116
+ * }
117
+ * },
118
+ * onboardingState: "ONBOARDED",
119
+ * operationalState: "ENABLED",
120
+ * usageState: "IN_USE",
121
+ * vnfProductName: "NRF",
122
+ * vnfProvider: "VNFBuilder",
123
+ * vnfdId: "eefaac4a-cf5c-4b1f-869e-9d31a9fa6d71",
124
+ * vnfdVersion: "1.0.0"
125
+ * }
126
+ * *\/
127
+ * ```
128
+ *
98
129
  * @public
99
130
  */
100
131
  export declare class GetSolFunctionPackageCommand extends GetSolFunctionPackageCommand_base {
@@ -80,6 +80,24 @@ declare const GetSolFunctionPackageContentCommand_base: {
80
80
  * @throws {@link TnbServiceException}
81
81
  * <p>Base exception class for all service exceptions from Tnb service.</p>
82
82
  *
83
+ *
84
+ * @example Get the content of a function package
85
+ * ```javascript
86
+ * //
87
+ * const input = {
88
+ * accept: "application/zip",
89
+ * vnfPkgId: "fp-07aa863e53460a2a6"
90
+ * };
91
+ * const command = new GetSolFunctionPackageContentCommand(input);
92
+ * const response = await client.send(command);
93
+ * /* response is
94
+ * {
95
+ * contentType: "application/zip",
96
+ * packageContent: "dGVzdCBjb250ZW50IGhlcmU="
97
+ * }
98
+ * *\/
99
+ * ```
100
+ *
83
101
  * @public
84
102
  */
85
103
  export declare class GetSolFunctionPackageContentCommand extends GetSolFunctionPackageContentCommand_base {
@@ -81,6 +81,24 @@ declare const GetSolFunctionPackageDescriptorCommand_base: {
81
81
  * @throws {@link TnbServiceException}
82
82
  * <p>Base exception class for all service exceptions from Tnb service.</p>
83
83
  *
84
+ *
85
+ * @example Get the descriptor of a function package
86
+ * ```javascript
87
+ * //
88
+ * const input = {
89
+ * accept: "text/plain",
90
+ * vnfPkgId: "fp-07aa863e53460a2a6"
91
+ * };
92
+ * const command = new GetSolFunctionPackageDescriptorCommand(input);
93
+ * const response = await client.send(command);
94
+ * /* response is
95
+ * {
96
+ * contentType: "text/plain",
97
+ * vnfd: "dGVzdCBjb250ZW50IGhlcmU="
98
+ * }
99
+ * *\/
100
+ * ```
101
+ *
84
102
  * @public
85
103
  */
86
104
  export declare class GetSolFunctionPackageDescriptorCommand extends GetSolFunctionPackageDescriptorCommand_base {
@@ -87,6 +87,35 @@ declare const GetSolNetworkInstanceCommand_base: {
87
87
  * @throws {@link TnbServiceException}
88
88
  * <p>Base exception class for all service exceptions from Tnb service.</p>
89
89
  *
90
+ *
91
+ * @example Get a Sol Network Instance details
92
+ * ```javascript
93
+ * //
94
+ * const input = {
95
+ * nsInstanceId: "ni-07aa863e53460a2a6"
96
+ * };
97
+ * const command = new GetSolNetworkInstanceCommand(input);
98
+ * const response = await client.send(command);
99
+ * /* response is
100
+ * {
101
+ * arn: "arn:aws:tnb:us-west-2:123456789000:network-instance/ni-07aa863e53460a2a6",
102
+ * id: "ni-07aa863e53460a2a6",
103
+ * lcmOpInfo: {
104
+ * nsLcmOpOccId: "no-0d5b823eb5c2a9241"
105
+ * },
106
+ * metadata: {
107
+ * createdAt: "2022-06-10T19:48:33Z",
108
+ * lastModified: "2022-06-10T19:48:33Z"
109
+ * },
110
+ * nsInstanceDescription: "Network service for CITY",
111
+ * nsInstanceName: "CITY Instance",
112
+ * nsState: "INSTANTIATED",
113
+ * nsdId: "6625a858-2157-4d74-9197-a6ff67d51f3e",
114
+ * nsdInfoId: "np-07aa863e53460a2a6"
115
+ * }
116
+ * *\/
117
+ * ```
118
+ *
90
119
  * @public
91
120
  */
92
121
  export declare class GetSolNetworkInstanceCommand extends GetSolNetworkInstanceCommand_base {
@@ -115,6 +115,180 @@ declare const GetSolNetworkOperationCommand_base: {
115
115
  * @throws {@link TnbServiceException}
116
116
  * <p>Base exception class for all service exceptions from Tnb service.</p>
117
117
  *
118
+ *
119
+ * @example Get Sol Network Instantiate operation
120
+ * ```javascript
121
+ * //
122
+ * const input = {
123
+ * nsLcmOpOccId: "no-0d5b823eb5c2a9241"
124
+ * };
125
+ * const command = new GetSolNetworkOperationCommand(input);
126
+ * const response = await client.send(command);
127
+ * /* response is
128
+ * {
129
+ * arn: "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241",
130
+ * id: "no-0d5b823eb5c2a9241",
131
+ * lcmOperationType: "INSTANTIATE",
132
+ * metadata: {
133
+ * createdAt: "2022-06-10T19:48:34Z",
134
+ * instantiateMetadata: {
135
+ * additionalParamsForNs: {
136
+ * availability_zone: "us-west-2a",
137
+ * cidr_block: "10.0.0.0/16"
138
+ * },
139
+ * nsdInfoId: "np-0d0f3e2eae4fc1ac1"
140
+ * },
141
+ * lastModified: "2022-06-10T21:48:33Z"
142
+ * },
143
+ * nsInstanceId: "ni-0d5b823eb5c2a9241",
144
+ * operationState: "COMPLETED",
145
+ * tasks: [
146
+ * {
147
+ * taskContext: {
148
+ * cloudWatchLogsARN: "arn:aws:logs:us-east-1:123456789000:log-group:/aws/codebuild/TestProject:log-stream:a4dc6b0b-2ea3-48c5-bb30-636c4f376b81"
149
+ * },
150
+ * taskEndTime: "2022-06-10T21:48:33Z",
151
+ * taskName: "HookExecution",
152
+ * taskStartTime: "2022-06-10T19:48:34Z",
153
+ * taskStatus: "IN_PROGRESS"
154
+ * }
155
+ * ]
156
+ * }
157
+ * *\/
158
+ * ```
159
+ *
160
+ * @example Get Sol Network Update operation
161
+ * ```javascript
162
+ * //
163
+ * const input = {
164
+ * nsLcmOpOccId: "no-0d5b823eb5c2a9241"
165
+ * };
166
+ * const command = new GetSolNetworkOperationCommand(input);
167
+ * const response = await client.send(command);
168
+ * /* response is
169
+ * {
170
+ * arn: "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241",
171
+ * id: "no-0d5b823eb5c2a9241",
172
+ * lcmOperationType: "UPDATE",
173
+ * metadata: {
174
+ * createdAt: "2022-06-10T19:48:34Z",
175
+ * lastModified: "2022-06-10T21:48:33Z",
176
+ * updateNsMetadata: {
177
+ * additionalParamsForNs: {
178
+ * availability_zone: "us-west-2a",
179
+ * cidr_block: "10.0.0.0/16"
180
+ * },
181
+ * nsdInfoId: "np-0d0f3e2eae4fc1ac1"
182
+ * }
183
+ * },
184
+ * nsInstanceId: "ni-0d5b823eb5c2a9241",
185
+ * operationState: "COMPLETED",
186
+ * tasks: [
187
+ * {
188
+ * taskContext: {
189
+ * cloudWatchLogsARN: "arn:aws:logs:us-east-1:123456789000:log-group:/aws/codebuild/TestProject:log-stream:a4dc6b0b-2ea3-48c5-bb30-636c4f376b81"
190
+ * },
191
+ * taskEndTime: "2022-06-10T21:48:33Z",
192
+ * taskName: "HookExecution",
193
+ * taskStartTime: "2022-06-10T19:48:34Z",
194
+ * taskStatus: "IN_PROGRESS"
195
+ * }
196
+ * ],
197
+ * updateType: "UPDATE_NS"
198
+ * }
199
+ * *\/
200
+ * ```
201
+ *
202
+ * @example Get Sol Network Update operation
203
+ * ```javascript
204
+ * //
205
+ * const input = {
206
+ * nsLcmOpOccId: "no-0d5b823eb5c2a9241"
207
+ * };
208
+ * const command = new GetSolNetworkOperationCommand(input);
209
+ * const response = await client.send(command);
210
+ * /* response is
211
+ * {
212
+ * arn: "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241",
213
+ * id: "no-0d5b823eb5c2a9241",
214
+ * lcmOperationType: "UPDATE",
215
+ * metadata: {
216
+ * createdAt: "2022-06-10T19:48:34Z",
217
+ * lastModified: "2022-06-10T21:48:33Z",
218
+ * modifyVnfInfoMetadata: {
219
+ * vnfConfigurableProperties: {
220
+ * pcf.pods: "10",
221
+ * pcf.port: "8080"
222
+ * },
223
+ * vnfInstanceId: "fi-0d5b823eb5c2a9241"
224
+ * }
225
+ * },
226
+ * nsInstanceId: "ni-0d5b823eb5c2a9241",
227
+ * operationState: "COMPLETED",
228
+ * tasks: [
229
+ * {
230
+ * taskContext: {
231
+ * cloudWatchLogsARN: "arn:aws:logs:us-east-1:123456789000:log-group:/aws/codebuild/TestProject:log-stream:a4dc6b0b-2ea3-48c5-bb30-636c4f376b81"
232
+ * },
233
+ * taskEndTime: "2022-06-10T21:48:33Z",
234
+ * taskName: "HookExecution",
235
+ * taskStartTime: "2022-06-10T19:48:34Z",
236
+ * taskStatus: "IN_PROGRESS"
237
+ * }
238
+ * ],
239
+ * updateType: "MODIFY_VNF_INFORMATION"
240
+ * }
241
+ * *\/
242
+ * ```
243
+ *
244
+ * @example Get Sol Network Instantiate operation which has a failure
245
+ * ```javascript
246
+ * //
247
+ * const input = {
248
+ * nsLcmOpOccId: "no-0d5b823eb5c2a9241"
249
+ * };
250
+ * const command = new GetSolNetworkOperationCommand(input);
251
+ * const response = await client.send(command);
252
+ * /* response is
253
+ * {
254
+ * arn: "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241",
255
+ * error: {
256
+ * detail: "The service encountered an error. Sorry for the inconvenience.",
257
+ * title: "InternalServerException"
258
+ * },
259
+ * id: "no-0d5b823eb5c2a9241",
260
+ * lcmOperationType: "INSTANTIATE",
261
+ * metadata: {
262
+ * createdAt: "2022-06-10T19:48:33Z",
263
+ * lastModified: "2022-06-10T19:48:33Z"
264
+ * },
265
+ * nsInstanceId: "ni-0d5b823eb5c2a9241",
266
+ * operationState: "FAILED",
267
+ * tasks: [
268
+ * {
269
+ * taskContext: {
270
+ * cloudWatchLogsARN: "arn:aws:logs:us-east-1:123456789000:log-group:/aws/codebuild/TestProject:log-stream:a4dc6b0b-2ea3-48c5-bb30-636c4f376b81"
271
+ * },
272
+ * taskEndTime: "2022-06-10T21:48:33Z",
273
+ * taskName: "HookExecution",
274
+ * taskStartTime: "2022-06-10T19:48:34Z",
275
+ * taskStatus: "IN_PROGRESS"
276
+ * },
277
+ * {
278
+ * taskEndTime: "2022-06-10T21:48:33Z",
279
+ * taskErrorDetails: {
280
+ * cause: "InternalServerException",
281
+ * details: "The service encountered an error. Sorry for the inconvenience."
282
+ * },
283
+ * taskName: "HookExecution",
284
+ * taskStartTime: "2022-06-10T19:48:34Z",
285
+ * taskStatus: "ERROR"
286
+ * }
287
+ * ]
288
+ * }
289
+ * *\/
290
+ * ```
291
+ *
118
292
  * @public
119
293
  */
120
294
  export declare class GetSolNetworkOperationCommand extends GetSolNetworkOperationCommand_base {
@@ -96,6 +96,48 @@ declare const GetSolNetworkPackageCommand_base: {
96
96
  * @throws {@link TnbServiceException}
97
97
  * <p>Base exception class for all service exceptions from Tnb service.</p>
98
98
  *
99
+ *
100
+ * @example Describe an individual Sol network package
101
+ * ```javascript
102
+ * //
103
+ * const input = {
104
+ * nsdInfoId: "np-0d5b823eb5c2a9241"
105
+ * };
106
+ * const command = new GetSolNetworkPackageCommand(input);
107
+ * const response = await client.send(command);
108
+ * /* response is
109
+ * {
110
+ * arn: "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241",
111
+ * id: "np-0d5b823eb5c2a9241",
112
+ * metadata: {
113
+ * createdAt: "2022-06-10T19:48:34Z",
114
+ * lastModified: "2022-06-10T21:48:33Z",
115
+ * nsd: {
116
+ * overrides: [
117
+ * {
118
+ * defaultValue: "10.0.0.0/24",
119
+ * name: "cidr_block"
120
+ * },
121
+ * {
122
+ * name: "some_vnf.vnf_prop"
123
+ * }
124
+ * ]
125
+ * }
126
+ * },
127
+ * nsdId: "be1abe66-1fcc-11ec-9621-0242ac130002",
128
+ * nsdName: "Sample-City",
129
+ * nsdOnboardingState: "ONBOARDED",
130
+ * nsdOperationalState: "ENABLED",
131
+ * nsdUsageState: "IN_USE",
132
+ * nsdVersion: "1.0",
133
+ * vnfPkgIds: [
134
+ * "fp-0b627c4a170a97f79",
135
+ * "fp-8c253b2e898d23f92"
136
+ * ]
137
+ * }
138
+ * *\/
139
+ * ```
140
+ *
99
141
  * @public
100
142
  */
101
143
  export declare class GetSolNetworkPackageCommand extends GetSolNetworkPackageCommand_base {
@@ -80,6 +80,24 @@ declare const GetSolNetworkPackageContentCommand_base: {
80
80
  * @throws {@link TnbServiceException}
81
81
  * <p>Base exception class for all service exceptions from Tnb service.</p>
82
82
  *
83
+ *
84
+ * @example Get a network package Content
85
+ * ```javascript
86
+ * //
87
+ * const input = {
88
+ * accept: "application/zip",
89
+ * nsdInfoId: "np-0d5b823eb5c2a9241"
90
+ * };
91
+ * const command = new GetSolNetworkPackageContentCommand(input);
92
+ * const response = await client.send(command);
93
+ * /* response is
94
+ * {
95
+ * contentType: "application/zip",
96
+ * nsdContent: "dGVzdCBjb250ZW50IGhlcmU="
97
+ * }
98
+ * *\/
99
+ * ```
100
+ *
83
101
  * @public
84
102
  */
85
103
  export declare class GetSolNetworkPackageContentCommand extends GetSolNetworkPackageContentCommand_base {
@@ -79,6 +79,23 @@ declare const GetSolNetworkPackageDescriptorCommand_base: {
79
79
  * @throws {@link TnbServiceException}
80
80
  * <p>Base exception class for all service exceptions from Tnb service.</p>
81
81
  *
82
+ *
83
+ * @example Get the descriptor of a Network Pacakge
84
+ * ```javascript
85
+ * //
86
+ * const input = {
87
+ * nsdInfoId: "np-0d5b823eb5c2a9241"
88
+ * };
89
+ * const command = new GetSolNetworkPackageDescriptorCommand(input);
90
+ * const response = await client.send(command);
91
+ * /* response is
92
+ * {
93
+ * contentType: "text/plain",
94
+ * nsd: "dGVzdCBjb250ZW50IGhlcmU="
95
+ * }
96
+ * *\/
97
+ * ```
98
+ *
82
99
  * @public
83
100
  */
84
101
  export declare class GetSolNetworkPackageDescriptorCommand extends GetSolNetworkPackageDescriptorCommand_base {
@@ -84,6 +84,47 @@ declare const InstantiateSolNetworkInstanceCommand_base: {
84
84
  * @throws {@link TnbServiceException}
85
85
  * <p>Base exception class for all service exceptions from Tnb service.</p>
86
86
  *
87
+ *
88
+ * @example Instantiate a Sol Network Instance
89
+ * ```javascript
90
+ * //
91
+ * const input = {
92
+ * nsInstanceId: "ni-0d5b823eb5c2a9241",
93
+ * tags: {
94
+ * Name: "Resource"
95
+ * }
96
+ * };
97
+ * const command = new InstantiateSolNetworkInstanceCommand(input);
98
+ * const response = await client.send(command);
99
+ * /* response is
100
+ * {
101
+ * nsLcmOpOccId: "no-0d5b823eb5c2a9241",
102
+ * tags: {
103
+ * Name: "Resource"
104
+ * }
105
+ * }
106
+ * *\/
107
+ * ```
108
+ *
109
+ * @example Instantiate a Sol Network Instance with Overrides
110
+ * ```javascript
111
+ * //
112
+ * const input = {
113
+ * additionalParamsForNs: {
114
+ * availability_zone: "us-west-2a",
115
+ * cidr_block: "10.0.0.0/16"
116
+ * },
117
+ * nsInstanceId: "ni-0d5b823eb5c2a9241"
118
+ * };
119
+ * const command = new InstantiateSolNetworkInstanceCommand(input);
120
+ * const response = await client.send(command);
121
+ * /* response is
122
+ * {
123
+ * nsLcmOpOccId: "no-0d5b823eb5c2a9241"
124
+ * }
125
+ * *\/
126
+ * ```
127
+ *
87
128
  * @public
88
129
  */
89
130
  export declare class InstantiateSolNetworkInstanceCommand extends InstantiateSolNetworkInstanceCommand_base {