Skip to content

Commit cee6948

Browse files
author
awstools
committed
feat(client-tnb): This release adds Network Service Update, through which customers will be able to update their instantiated networks to a new network package. See the documentation for limitations. The release also enhances the Get network operation API to return parameter overrides used during the operation.
1 parent 2347163 commit cee6948

40 files changed

+805
-124
lines changed

‎clients/client-tnb/README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@
66

77
AWS SDK for JavaScript Tnb Client for Node.js, Browser and React Native.
88

9-
<p> Amazon Web Services Telco Network Builder (TNB) is a network automation service that helps you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of your telecommunication network functions throughout planning, deployment, and post-deployment activities.</p>
9+
<p>
10+
Amazon Web Services Telco Network Builder (TNB) is a network automation service that helps
11+
you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of
12+
your telecommunication network functions throughout planning, deployment, and
13+
post-deployment activities.</p>
1014

1115
## Installing
1216

‎clients/client-tnb/src/Tnb.ts

+5-1
Original file line numberDiff line numberDiff line change
@@ -760,7 +760,11 @@ export interface Tnb {
760760
}
761761

762762
/**
763-
* <p> Amazon Web Services Telco Network Builder (TNB) is a network automation service that helps you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of your telecommunication network functions throughout planning, deployment, and post-deployment activities.</p>
763+
* <p>
764+
* Amazon Web Services Telco Network Builder (TNB) is a network automation service that helps
765+
* you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of
766+
* your telecommunication network functions throughout planning, deployment, and
767+
* post-deployment activities.</p>
764768
* @public
765769
*/
766770
export class Tnb extends TnbClient implements Tnb {}

‎clients/client-tnb/src/TnbClient.ts

+5-1
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,11 @@ export type TnbClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHa
438438
export interface TnbClientResolvedConfig extends TnbClientResolvedConfigType {}
439439

440440
/**
441-
* <p> Amazon Web Services Telco Network Builder (TNB) is a network automation service that helps you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of your telecommunication network functions throughout planning, deployment, and post-deployment activities.</p>
441+
* <p>
442+
* Amazon Web Services Telco Network Builder (TNB) is a network automation service that helps
443+
* you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of
444+
* your telecommunication network functions throughout planning, deployment, and
445+
* post-deployment activities.</p>
442446
* @public
443447
*/
444448
export class TnbClient extends __Client<

‎clients/client-tnb/src/commands/CancelSolNetworkOperationCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,8 @@ export interface CancelSolNetworkOperationCommandOutput extends __MetadataBearer
6464
* <p>Exception caused by throttling.</p>
6565
*
6666
* @throws {@link ValidationException} (client fault)
67-
* <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
67+
* <p>Unable to process the request because the client provided input failed to satisfy
68+
* request constraints.</p>
6869
*
6970
* @throws {@link TnbServiceException}
7071
* <p>Base exception class for all service exceptions from Tnb service.</p>

‎clients/client-tnb/src/commands/CreateSolFunctionPackageCommand.ts

+7-4
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,11 @@ export interface CreateSolFunctionPackageCommandOutput extends CreateSolFunction
3434

3535
/**
3636
* <p>Creates a function package.</p>
37-
* <p>A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. For more information, see <a href="https://docs.aws.amazon.com/tnb/latest/ug/function-packages.html">Function packages</a> in the <i>Amazon Web Services Telco Network Builder User Guide</i>.
38-
* </p>
39-
* <p>Creating a function package is the first step for creating a network in AWS TNB. This request creates an empty container with an ID. The next step is to upload the actual CSAR zip file into that empty container. To upload function package content, see <a href="https://docs.aws.amazon.com/tnb/latest/APIReference/API_PutSolFunctionPackageContent.html">PutSolFunctionPackageContent</a>.</p>
37+
* <p>A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. For more information, see <a href="https://docs.aws.amazon.com/tnb/latest/ug/function-packages.html">Function packages</a> in the
38+
* <i>Amazon Web Services Telco Network Builder User Guide</i>. </p>
39+
* <p>Creating a function package is the first step for creating a network in AWS TNB. This
40+
* request creates an empty container with an ID. The next step is to upload the actual CSAR
41+
* zip file into that empty container. To upload function package content, see <a href="https://docs.aws.amazon.com/tnb/latest/APIReference/API_PutSolFunctionPackageContent.html">PutSolFunctionPackageContent</a>.</p>
4042
* @example
4143
* Use a bare-bones client and the command you need to make an API call.
4244
* ```javascript
@@ -82,7 +84,8 @@ export interface CreateSolFunctionPackageCommandOutput extends CreateSolFunction
8284
* <p>Exception caused by throttling.</p>
8385
*
8486
* @throws {@link ValidationException} (client fault)
85-
* <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
87+
* <p>Unable to process the request because the client provided input failed to satisfy
88+
* request constraints.</p>
8689
*
8790
* @throws {@link TnbServiceException}
8891
* <p>Base exception class for all service exceptions from Tnb service.</p>

‎clients/client-tnb/src/commands/CreateSolNetworkInstanceCommand.ts

+7-3
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,11 @@ export interface CreateSolNetworkInstanceCommandOutput extends CreateSolNetworkI
3434

3535
/**
3636
* <p>Creates a network instance.</p>
37-
* <p>A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Creating a network instance is the third step after creating a network package. For more information about network instances, <a href="https://docs.aws.amazon.com/tnb/latest/ug/network-instances.html">Network instances</a> in the <i>Amazon Web Services Telco Network Builder User Guide</i>.</p>
38-
* <p>Once you create a network instance, you can instantiate it. To instantiate a network, see <a href="https://docs.aws.amazon.com/tnb/latest/APIReference/API_InstantiateSolNetworkInstance.html">InstantiateSolNetworkInstance</a>.</p>
37+
* <p>A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Creating a network instance is the third step after creating a network
38+
* package. For more information about network instances, <a href="https://docs.aws.amazon.com/tnb/latest/ug/network-instances.html">Network instances</a> in the
39+
* <i>Amazon Web Services Telco Network Builder User Guide</i>.</p>
40+
* <p>Once you create a network instance, you can instantiate it. To instantiate a network,
41+
* see <a href="https://docs.aws.amazon.com/tnb/latest/APIReference/API_InstantiateSolNetworkInstance.html">InstantiateSolNetworkInstance</a>.</p>
3942
* @example
4043
* Use a bare-bones client and the command you need to make an API call.
4144
* ```javascript
@@ -86,7 +89,8 @@ export interface CreateSolNetworkInstanceCommandOutput extends CreateSolNetworkI
8689
* <p>Exception caused by throttling.</p>
8790
*
8891
* @throws {@link ValidationException} (client fault)
89-
* <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
92+
* <p>Unable to process the request because the client provided input failed to satisfy
93+
* request constraints.</p>
9094
*
9195
* @throws {@link TnbServiceException}
9296
* <p>Base exception class for all service exceptions from Tnb service.</p>

‎clients/client-tnb/src/commands/CreateSolNetworkPackageCommand.ts

+10-5
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,14 @@ export interface CreateSolNetworkPackageCommandOutput extends CreateSolNetworkPa
3434

3535
/**
3636
* <p>Creates a network package.</p>
37-
* <p>A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. For more information, see <a href="https://docs.aws.amazon.com/tnb/latest/ug/network-instances.html">Network instances</a> in the <i>Amazon Web Services Telco Network Builder User Guide</i>.
38-
* </p>
39-
* <p>A network package consists of a network service descriptor (NSD) file (required) and any additional files (optional), such as scripts specific to your needs. For example, if you have multiple function packages in your network package, you can use the NSD to define which network functions should run in certain VPCs, subnets, or EKS clusters.</p>
40-
* <p>This request creates an empty network package container with an ID. Once you create a network package, you can upload the network package content using <a href="https://docs.aws.amazon.com/tnb/latest/APIReference/API_PutSolNetworkPackageContent.html">PutSolNetworkPackageContent</a>.</p>
37+
* <p>A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. For more information, see <a href="https://docs.aws.amazon.com/tnb/latest/ug/network-instances.html">Network instances</a> in the
38+
* <i>Amazon Web Services Telco Network Builder User Guide</i>. </p>
39+
* <p>A network package consists of a network service descriptor (NSD) file (required) and any
40+
* additional files (optional), such as scripts specific to your needs. For example, if you
41+
* have multiple function packages in your network package, you can use the NSD to define
42+
* which network functions should run in certain VPCs, subnets, or EKS clusters.</p>
43+
* <p>This request creates an empty network package container with an ID. Once you create a
44+
* network package, you can upload the network package content using <a href="https://docs.aws.amazon.com/tnb/latest/APIReference/API_PutSolNetworkPackageContent.html">PutSolNetworkPackageContent</a>.</p>
4145
* @example
4246
* Use a bare-bones client and the command you need to make an API call.
4347
* ```javascript
@@ -83,7 +87,8 @@ export interface CreateSolNetworkPackageCommandOutput extends CreateSolNetworkPa
8387
* <p>Exception caused by throttling.</p>
8488
*
8589
* @throws {@link ValidationException} (client fault)
86-
* <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
90+
* <p>Unable to process the request because the client provided input failed to satisfy
91+
* request constraints.</p>
8792
*
8893
* @throws {@link TnbServiceException}
8994
* <p>Base exception class for all service exceptions from Tnb service.</p>

‎clients/client-tnb/src/commands/DeleteSolFunctionPackageCommand.ts

+4-3
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ export interface DeleteSolFunctionPackageCommandOutput extends __MetadataBearer
3030
/**
3131
* <p>Deletes a function package.</p>
3232
* <p>A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.</p>
33-
* <p>To delete a function package, the package must be in a disabled state. To disable a function package, see <a href="https://docs.aws.amazon.com/tnb/latest/APIReference/API_UpdateSolFunctionPackage.html">UpdateSolFunctionPackage</a>.
34-
* </p>
33+
* <p>To delete a function package, the package must be in a disabled state. To disable a
34+
* function package, see <a href="https://docs.aws.amazon.com/tnb/latest/APIReference/API_UpdateSolFunctionPackage.html">UpdateSolFunctionPackage</a>. </p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
3737
* ```javascript
@@ -66,7 +66,8 @@ export interface DeleteSolFunctionPackageCommandOutput extends __MetadataBearer
6666
* <p>Exception caused by throttling.</p>
6767
*
6868
* @throws {@link ValidationException} (client fault)
69-
* <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
69+
* <p>Unable to process the request because the client provided input failed to satisfy
70+
* request constraints.</p>
7071
*
7172
* @throws {@link TnbServiceException}
7273
* <p>Base exception class for all service exceptions from Tnb service.</p>

‎clients/client-tnb/src/commands/DeleteSolNetworkInstanceCommand.ts

+4-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ export interface DeleteSolNetworkInstanceCommandOutput extends __MetadataBearer
3030
/**
3131
* <p>Deletes a network instance.</p>
3232
* <p>A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.</p>
33-
* <p>To delete a network instance, the instance must be in a stopped or terminated state. To terminate a network instance, see <a href="https://docs.aws.amazon.com/tnb/latest/APIReference/API_TerminateSolNetworkInstance.html">TerminateSolNetworkInstance</a>.</p>
33+
* <p>To delete a network instance, the instance must be in a stopped or terminated state. To
34+
* terminate a network instance, see <a href="https://docs.aws.amazon.com/tnb/latest/APIReference/API_TerminateSolNetworkInstance.html">TerminateSolNetworkInstance</a>.</p>
3435
* @example
3536
* Use a bare-bones client and the command you need to make an API call.
3637
* ```javascript
@@ -65,7 +66,8 @@ export interface DeleteSolNetworkInstanceCommandOutput extends __MetadataBearer
6566
* <p>Exception caused by throttling.</p>
6667
*
6768
* @throws {@link ValidationException} (client fault)
68-
* <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
69+
* <p>Unable to process the request because the client provided input failed to satisfy
70+
* request constraints.</p>
6971
*
7072
* @throws {@link TnbServiceException}
7173
* <p>Base exception class for all service exceptions from Tnb service.</p>

‎clients/client-tnb/src/commands/DeleteSolNetworkPackageCommand.ts

+4-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ export interface DeleteSolNetworkPackageCommandOutput extends __MetadataBearer {
3030
/**
3131
* <p>Deletes network package.</p>
3232
* <p>A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.</p>
33-
* <p>To delete a network package, the package must be in a disable state. To disable a network package, see <a href="https://docs.aws.amazon.com/tnb/latest/APIReference/API_UpdateSolNetworkPackage.html">UpdateSolNetworkPackage</a>.</p>
33+
* <p>To delete a network package, the package must be in a disable state. To disable a
34+
* network package, see <a href="https://docs.aws.amazon.com/tnb/latest/APIReference/API_UpdateSolNetworkPackage.html">UpdateSolNetworkPackage</a>.</p>
3435
* @example
3536
* Use a bare-bones client and the command you need to make an API call.
3637
* ```javascript
@@ -65,7 +66,8 @@ export interface DeleteSolNetworkPackageCommandOutput extends __MetadataBearer {
6566
* <p>Exception caused by throttling.</p>
6667
*
6768
* @throws {@link ValidationException} (client fault)
68-
* <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
69+
* <p>Unable to process the request because the client provided input failed to satisfy
70+
* request constraints.</p>
6971
*
7072
* @throws {@link TnbServiceException}
7173
* <p>Base exception class for all service exceptions from Tnb service.</p>

‎clients/client-tnb/src/commands/GetSolFunctionInstanceCommand.ts

+4-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ export interface GetSolFunctionInstanceCommandInput extends GetSolFunctionInstan
3232
export interface GetSolFunctionInstanceCommandOutput extends GetSolFunctionInstanceOutput, __MetadataBearer {}
3333

3434
/**
35-
* <p>Gets the details of a network function instance, including the instantation state and metadata from the function package descriptor in the network function package.</p>
35+
* <p>Gets the details of a network function instance, including the instantiation state and
36+
* metadata from the function package descriptor in the network function package.</p>
3637
* <p>A network function instance is a function in a function package .</p>
3738
* @example
3839
* Use a bare-bones client and the command you need to make an API call.
@@ -97,7 +98,8 @@ export interface GetSolFunctionInstanceCommandOutput extends GetSolFunctionInsta
9798
* <p>Exception caused by throttling.</p>
9899
*
99100
* @throws {@link ValidationException} (client fault)
100-
* <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
101+
* <p>Unable to process the request because the client provided input failed to satisfy
102+
* request constraints.</p>
101103
*
102104
* @throws {@link TnbServiceException}
103105
* <p>Base exception class for all service exceptions from Tnb service.</p>

‎clients/client-tnb/src/commands/GetSolFunctionPackageCommand.ts

+4-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ export interface GetSolFunctionPackageCommandInput extends GetSolFunctionPackage
3232
export interface GetSolFunctionPackageCommandOutput extends GetSolFunctionPackageOutput, __MetadataBearer {}
3333

3434
/**
35-
* <p>Gets the details of an individual function package, such as the operational state and whether the package is in use.</p>
35+
* <p>Gets the details of an individual function package, such as the operational state and
36+
* whether the package is in use.</p>
3637
* <p>A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network..</p>
3738
* @example
3839
* Use a bare-bones client and the command you need to make an API call.
@@ -93,7 +94,8 @@ export interface GetSolFunctionPackageCommandOutput extends GetSolFunctionPackag
9394
* <p>Exception caused by throttling.</p>
9495
*
9596
* @throws {@link ValidationException} (client fault)
96-
* <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
97+
* <p>Unable to process the request because the client provided input failed to satisfy
98+
* request constraints.</p>
9799
*
98100
* @throws {@link TnbServiceException}
99101
* <p>Base exception class for all service exceptions from Tnb service.</p>

‎clients/client-tnb/src/commands/GetSolFunctionPackageContentCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,8 @@ export interface GetSolFunctionPackageContentCommandOutput
8484
* <p>Exception caused by throttling.</p>
8585
*
8686
* @throws {@link ValidationException} (client fault)
87-
* <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
87+
* <p>Unable to process the request because the client provided input failed to satisfy
88+
* request constraints.</p>
8889
*
8990
* @throws {@link TnbServiceException}
9091
* <p>Base exception class for all service exceptions from Tnb service.</p>

‎clients/client-tnb/src/commands/GetSolFunctionPackageDescriptorCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,8 @@ export interface GetSolFunctionPackageDescriptorCommandOutput
8282
* <p>Exception caused by throttling.</p>
8383
*
8484
* @throws {@link ValidationException} (client fault)
85-
* <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
85+
* <p>Unable to process the request because the client provided input failed to satisfy
86+
* request constraints.</p>
8687
*
8788
* @throws {@link TnbServiceException}
8889
* <p>Base exception class for all service exceptions from Tnb service.</p>

0 commit comments

Comments
 (0)