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.

Author: awstools

clients/client-tnb/README.md

@@ -6,7 +6,11 @@
 
 AWS SDK for JavaScript Tnb Client for Node.js, Browser and React Native.
 
-<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>
+<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>
 
 ## Installing
 

clients/client-tnb/src/Tnb.ts

@@ -760,7 +760,11 @@ export interface Tnb {
 }
 
 /**
- * <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>
+ * <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>
  * @public
  */
 export class Tnb extends TnbClient implements Tnb {}

clients/client-tnb/src/TnbClient.ts

@@ -438,7 +438,11 @@ export type TnbClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHa
 export interface TnbClientResolvedConfig extends TnbClientResolvedConfigType {}
 
 /**
- * <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>
+ * <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>
  * @public
  */
 export class TnbClient extends __Client<

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

@@ -64,7 +64,8 @@ export interface CancelSolNetworkOperationCommandOutput extends __MetadataBearer
  *  <p>Exception caused by throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
+ *  <p>Unable to process the request because the client provided input failed to satisfy
+ *          request constraints.</p>
  *
  * @throws {@link TnbServiceException}
  * <p>Base exception class for all service exceptions from Tnb service.</p>

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

@@ -34,9 +34,11 @@ export interface CreateSolFunctionPackageCommandOutput extends CreateSolFunction
 
 /**
  * <p>Creates a function package.</p>
- *          <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>.
- *       </p>
- *          <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>
+ *          <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>. </p>
+ *          <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -82,7 +84,8 @@ export interface CreateSolFunctionPackageCommandOutput extends CreateSolFunction
  *  <p>Exception caused by throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
+ *  <p>Unable to process the request because the client provided input failed to satisfy
+ *          request constraints.</p>
  *
  * @throws {@link TnbServiceException}
  * <p>Base exception class for all service exceptions from Tnb service.</p>

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

@@ -34,8 +34,11 @@ export interface CreateSolNetworkInstanceCommandOutput extends CreateSolNetworkI
 
 /**
  * <p>Creates a network instance.</p>
- *          <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>
- *          <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>
+ *          <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>
+ *          <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -86,7 +89,8 @@ export interface CreateSolNetworkInstanceCommandOutput extends CreateSolNetworkI
  *  <p>Exception caused by throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
+ *  <p>Unable to process the request because the client provided input failed to satisfy
+ *          request constraints.</p>
  *
  * @throws {@link TnbServiceException}
  * <p>Base exception class for all service exceptions from Tnb service.</p>

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

@@ -34,10 +34,14 @@ export interface CreateSolNetworkPackageCommandOutput extends CreateSolNetworkPa
 
 /**
  * <p>Creates a network package.</p>
- *          <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>.
- *       </p>
- *          <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>
- *          <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>
+ *          <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>. </p>
+ *          <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>
+ *          <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -83,7 +87,8 @@ export interface CreateSolNetworkPackageCommandOutput extends CreateSolNetworkPa
  *  <p>Exception caused by throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
+ *  <p>Unable to process the request because the client provided input failed to satisfy
+ *          request constraints.</p>
  *
  * @throws {@link TnbServiceException}
  * <p>Base exception class for all service exceptions from Tnb service.</p>

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

@@ -30,8 +30,8 @@ export interface DeleteSolFunctionPackageCommandOutput extends __MetadataBearer
 /**
  * <p>Deletes a function package.</p>
  *          <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>
- *          <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>.
- *       </p>
+ *          <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>. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -66,7 +66,8 @@ export interface DeleteSolFunctionPackageCommandOutput extends __MetadataBearer
  *  <p>Exception caused by throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
+ *  <p>Unable to process the request because the client provided input failed to satisfy
+ *          request constraints.</p>
  *
  * @throws {@link TnbServiceException}
  * <p>Base exception class for all service exceptions from Tnb service.</p>

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

@@ -30,7 +30,8 @@ export interface DeleteSolNetworkInstanceCommandOutput extends __MetadataBearer
 /**
  * <p>Deletes a network instance.</p>
  *          <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>
- *          <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>
+ *          <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -65,7 +66,8 @@ export interface DeleteSolNetworkInstanceCommandOutput extends __MetadataBearer
  *  <p>Exception caused by throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
+ *  <p>Unable to process the request because the client provided input failed to satisfy
+ *          request constraints.</p>
  *
  * @throws {@link TnbServiceException}
  * <p>Base exception class for all service exceptions from Tnb service.</p>

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

@@ -30,7 +30,8 @@ export interface DeleteSolNetworkPackageCommandOutput extends __MetadataBearer {
 /**
  * <p>Deletes network package.</p>
  *          <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>
- *          <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>
+ *          <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -65,7 +66,8 @@ export interface DeleteSolNetworkPackageCommandOutput extends __MetadataBearer {
  *  <p>Exception caused by throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
+ *  <p>Unable to process the request because the client provided input failed to satisfy
+ *          request constraints.</p>
  *
  * @throws {@link TnbServiceException}
  * <p>Base exception class for all service exceptions from Tnb service.</p>

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

@@ -32,7 +32,8 @@ export interface GetSolFunctionInstanceCommandInput extends GetSolFunctionInstan
 export interface GetSolFunctionInstanceCommandOutput extends GetSolFunctionInstanceOutput, __MetadataBearer {}
 
 /**
- * <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>
+ * <p>Gets the details of a network function instance, including the instantiation state and
+ *          metadata from the function package descriptor in the network function package.</p>
  *          <p>A network function instance is a function in a function package .</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -97,7 +98,8 @@ export interface GetSolFunctionInstanceCommandOutput extends GetSolFunctionInsta
  *  <p>Exception caused by throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
+ *  <p>Unable to process the request because the client provided input failed to satisfy
+ *          request constraints.</p>
  *
  * @throws {@link TnbServiceException}
  * <p>Base exception class for all service exceptions from Tnb service.</p>

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

@@ -32,7 +32,8 @@ export interface GetSolFunctionPackageCommandInput extends GetSolFunctionPackage
 export interface GetSolFunctionPackageCommandOutput extends GetSolFunctionPackageOutput, __MetadataBearer {}
 
 /**
- * <p>Gets the details of an individual function package, such as the operational state and whether the package is in use.</p>
+ * <p>Gets the details of an individual function package, such as the operational state and
+ *          whether the package is in use.</p>
  *          <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -93,7 +94,8 @@ export interface GetSolFunctionPackageCommandOutput extends GetSolFunctionPackag
  *  <p>Exception caused by throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
+ *  <p>Unable to process the request because the client provided input failed to satisfy
+ *          request constraints.</p>
  *
  * @throws {@link TnbServiceException}
  * <p>Base exception class for all service exceptions from Tnb service.</p>

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

@@ -84,7 +84,8 @@ export interface GetSolFunctionPackageContentCommandOutput
  *  <p>Exception caused by throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
+ *  <p>Unable to process the request because the client provided input failed to satisfy
+ *          request constraints.</p>
  *
  * @throws {@link TnbServiceException}
  * <p>Base exception class for all service exceptions from Tnb service.</p>

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

@@ -82,7 +82,8 @@ export interface GetSolFunctionPackageDescriptorCommandOutput
  *  <p>Exception caused by throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>Unable to process the request because the client provided input failed to satisfy request constraints.</p>
+ *  <p>Unable to process the request because the client provided input failed to satisfy
+ *          request constraints.</p>
  *
  * @throws {@link TnbServiceException}
  * <p>Base exception class for all service exceptions from Tnb service.</p>