From cee6948a0b747b200aee7b1ead4d3b0840ef983e Mon Sep 17 00:00:00 2001 From: awstools Date: Tue, 30 Jul 2024 18:19:26 +0000 Subject: [PATCH] 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. --- clients/client-tnb/README.md | 6 +- clients/client-tnb/src/Tnb.ts | 6 +- clients/client-tnb/src/TnbClient.ts | 6 +- .../CancelSolNetworkOperationCommand.ts | 3 +- .../CreateSolFunctionPackageCommand.ts | 11 +- .../CreateSolNetworkInstanceCommand.ts | 10 +- .../CreateSolNetworkPackageCommand.ts | 15 +- .../DeleteSolFunctionPackageCommand.ts | 7 +- .../DeleteSolNetworkInstanceCommand.ts | 6 +- .../DeleteSolNetworkPackageCommand.ts | 6 +- .../commands/GetSolFunctionInstanceCommand.ts | 6 +- .../commands/GetSolFunctionPackageCommand.ts | 6 +- .../GetSolFunctionPackageContentCommand.ts | 3 +- .../GetSolFunctionPackageDescriptorCommand.ts | 3 +- .../commands/GetSolNetworkInstanceCommand.ts | 5 +- .../commands/GetSolNetworkOperationCommand.ts | 19 +- .../commands/GetSolNetworkPackageCommand.ts | 3 +- .../GetSolNetworkPackageContentCommand.ts | 3 +- .../GetSolNetworkPackageDescriptorCommand.ts | 3 +- .../InstantiateSolNetworkInstanceCommand.ts | 6 +- .../ListSolFunctionInstancesCommand.ts | 3 +- .../ListSolFunctionPackagesCommand.ts | 3 +- .../ListSolNetworkInstancesCommand.ts | 5 +- .../ListSolNetworkOperationsCommand.ts | 10 +- .../commands/ListSolNetworkPackagesCommand.ts | 3 +- .../commands/ListTagsForResourceCommand.ts | 3 +- .../PutSolFunctionPackageContentCommand.ts | 11 +- .../PutSolNetworkPackageContentCommand.ts | 11 +- .../src/commands/TagResourceCommand.ts | 3 +- .../TerminateSolNetworkInstanceCommand.ts | 3 +- .../src/commands/UntagResourceCommand.ts | 3 +- .../UpdateSolFunctionPackageCommand.ts | 3 +- .../UpdateSolNetworkInstanceCommand.ts | 10 +- .../UpdateSolNetworkPackageCommand.ts | 3 +- ...alidateSolFunctionPackageContentCommand.ts | 14 +- ...ValidateSolNetworkPackageContentCommand.ts | 14 +- clients/client-tnb/src/index.ts | 6 +- clients/client-tnb/src/models/models_0.ts | 239 ++++++++++- .../client-tnb/src/protocols/Aws_restJson1.ts | 61 +++ codegen/sdk-codegen/aws-models/tnb.json | 388 ++++++++++++++++-- 40 files changed, 805 insertions(+), 124 deletions(-) diff --git a/clients/client-tnb/README.md b/clients/client-tnb/README.md index 61cc6f5fb035..0efd0f8294f4 100644 --- a/clients/client-tnb/README.md +++ b/clients/client-tnb/README.md @@ -6,7 +6,11 @@ AWS SDK for JavaScript Tnb Client for Node.js, Browser and React Native. -

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.

+

+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.

## Installing diff --git a/clients/client-tnb/src/Tnb.ts b/clients/client-tnb/src/Tnb.ts index 77792aeee7aa..f930d51b03c9 100644 --- a/clients/client-tnb/src/Tnb.ts +++ b/clients/client-tnb/src/Tnb.ts @@ -760,7 +760,11 @@ export interface Tnb { } /** - *

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.

+ *

+ * 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.

* @public */ export class Tnb extends TnbClient implements Tnb {} diff --git a/clients/client-tnb/src/TnbClient.ts b/clients/client-tnb/src/TnbClient.ts index 455a23891fca..1667e6f2b694 100644 --- a/clients/client-tnb/src/TnbClient.ts +++ b/clients/client-tnb/src/TnbClient.ts @@ -438,7 +438,11 @@ export type TnbClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHa export interface TnbClientResolvedConfig extends TnbClientResolvedConfigType {} /** - *

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.

+ *

+ * 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.

* @public */ export class TnbClient extends __Client< diff --git a/clients/client-tnb/src/commands/CancelSolNetworkOperationCommand.ts b/clients/client-tnb/src/commands/CancelSolNetworkOperationCommand.ts index 6937acf72d44..c5e44ccbae0c 100644 --- a/clients/client-tnb/src/commands/CancelSolNetworkOperationCommand.ts +++ b/clients/client-tnb/src/commands/CancelSolNetworkOperationCommand.ts @@ -64,7 +64,8 @@ export interface CancelSolNetworkOperationCommandOutput extends __MetadataBearer *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/CreateSolFunctionPackageCommand.ts b/clients/client-tnb/src/commands/CreateSolFunctionPackageCommand.ts index 6387b15ff265..b9cb3c738621 100644 --- a/clients/client-tnb/src/commands/CreateSolFunctionPackageCommand.ts +++ b/clients/client-tnb/src/commands/CreateSolFunctionPackageCommand.ts @@ -34,9 +34,11 @@ export interface CreateSolFunctionPackageCommandOutput extends CreateSolFunction /** *

Creates a function package.

- *

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 Function packages in the Amazon Web Services Telco Network Builder User Guide. - *

- *

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 PutSolFunctionPackageContent.

+ *

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 Function packages in the + * Amazon Web Services Telco Network Builder User Guide.

+ *

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 PutSolFunctionPackageContent.

* @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 *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/CreateSolNetworkInstanceCommand.ts b/clients/client-tnb/src/commands/CreateSolNetworkInstanceCommand.ts index 444a753ff087..ca6491bf5eca 100644 --- a/clients/client-tnb/src/commands/CreateSolNetworkInstanceCommand.ts +++ b/clients/client-tnb/src/commands/CreateSolNetworkInstanceCommand.ts @@ -34,8 +34,11 @@ export interface CreateSolNetworkInstanceCommandOutput extends CreateSolNetworkI /** *

Creates a network instance.

- *

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, Network instances in the Amazon Web Services Telco Network Builder User Guide.

- *

Once you create a network instance, you can instantiate it. To instantiate a network, see InstantiateSolNetworkInstance.

+ *

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, Network instances in the + * Amazon Web Services Telco Network Builder User Guide.

+ *

Once you create a network instance, you can instantiate it. To instantiate a network, + * see InstantiateSolNetworkInstance.

* @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 *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/CreateSolNetworkPackageCommand.ts b/clients/client-tnb/src/commands/CreateSolNetworkPackageCommand.ts index 0c3f80243c40..5e52fc87bc60 100644 --- a/clients/client-tnb/src/commands/CreateSolNetworkPackageCommand.ts +++ b/clients/client-tnb/src/commands/CreateSolNetworkPackageCommand.ts @@ -34,10 +34,14 @@ export interface CreateSolNetworkPackageCommandOutput extends CreateSolNetworkPa /** *

Creates a network package.

- *

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 Network instances in the Amazon Web Services Telco Network Builder User Guide. - *

- *

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.

- *

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 PutSolNetworkPackageContent.

+ *

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 Network instances in the + * Amazon Web Services Telco Network Builder User Guide.

+ *

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.

+ *

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 PutSolNetworkPackageContent.

* @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 *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/DeleteSolFunctionPackageCommand.ts b/clients/client-tnb/src/commands/DeleteSolFunctionPackageCommand.ts index baed7495309d..b2316ddb54f9 100644 --- a/clients/client-tnb/src/commands/DeleteSolFunctionPackageCommand.ts +++ b/clients/client-tnb/src/commands/DeleteSolFunctionPackageCommand.ts @@ -30,8 +30,8 @@ export interface DeleteSolFunctionPackageCommandOutput extends __MetadataBearer /** *

Deletes a function package.

*

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.

- *

To delete a function package, the package must be in a disabled state. To disable a function package, see UpdateSolFunctionPackage. - *

+ *

To delete a function package, the package must be in a disabled state. To disable a + * function package, see UpdateSolFunctionPackage.

* @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 *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/DeleteSolNetworkInstanceCommand.ts b/clients/client-tnb/src/commands/DeleteSolNetworkInstanceCommand.ts index caef2328b7b0..2c7a671f8286 100644 --- a/clients/client-tnb/src/commands/DeleteSolNetworkInstanceCommand.ts +++ b/clients/client-tnb/src/commands/DeleteSolNetworkInstanceCommand.ts @@ -30,7 +30,8 @@ export interface DeleteSolNetworkInstanceCommandOutput extends __MetadataBearer /** *

Deletes a network instance.

*

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.

- *

To delete a network instance, the instance must be in a stopped or terminated state. To terminate a network instance, see TerminateSolNetworkInstance.

+ *

To delete a network instance, the instance must be in a stopped or terminated state. To + * terminate a network instance, see TerminateSolNetworkInstance.

* @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 *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/DeleteSolNetworkPackageCommand.ts b/clients/client-tnb/src/commands/DeleteSolNetworkPackageCommand.ts index c9f02a7c08c6..520f28891958 100644 --- a/clients/client-tnb/src/commands/DeleteSolNetworkPackageCommand.ts +++ b/clients/client-tnb/src/commands/DeleteSolNetworkPackageCommand.ts @@ -30,7 +30,8 @@ export interface DeleteSolNetworkPackageCommandOutput extends __MetadataBearer { /** *

Deletes network package.

*

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.

- *

To delete a network package, the package must be in a disable state. To disable a network package, see UpdateSolNetworkPackage.

+ *

To delete a network package, the package must be in a disable state. To disable a + * network package, see UpdateSolNetworkPackage.

* @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 { *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/GetSolFunctionInstanceCommand.ts b/clients/client-tnb/src/commands/GetSolFunctionInstanceCommand.ts index 5180b9b8c182..c290ac7731c6 100644 --- a/clients/client-tnb/src/commands/GetSolFunctionInstanceCommand.ts +++ b/clients/client-tnb/src/commands/GetSolFunctionInstanceCommand.ts @@ -32,7 +32,8 @@ export interface GetSolFunctionInstanceCommandInput extends GetSolFunctionInstan export interface GetSolFunctionInstanceCommandOutput extends GetSolFunctionInstanceOutput, __MetadataBearer {} /** - *

Gets the details of a network function instance, including the instantation state and metadata from the function package descriptor in the network function package.

+ *

Gets the details of a network function instance, including the instantiation state and + * metadata from the function package descriptor in the network function package.

*

A network function instance is a function in a function package .

* @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 *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/GetSolFunctionPackageCommand.ts b/clients/client-tnb/src/commands/GetSolFunctionPackageCommand.ts index aa1071143711..704378123e39 100644 --- a/clients/client-tnb/src/commands/GetSolFunctionPackageCommand.ts +++ b/clients/client-tnb/src/commands/GetSolFunctionPackageCommand.ts @@ -32,7 +32,8 @@ export interface GetSolFunctionPackageCommandInput extends GetSolFunctionPackage export interface GetSolFunctionPackageCommandOutput extends GetSolFunctionPackageOutput, __MetadataBearer {} /** - *

Gets the details of an individual function package, such as the operational state and whether the package is in use.

+ *

Gets the details of an individual function package, such as the operational state and + * whether the package is in use.

*

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..

* @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 *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/GetSolFunctionPackageContentCommand.ts b/clients/client-tnb/src/commands/GetSolFunctionPackageContentCommand.ts index 11cd0246493d..753a0497afea 100644 --- a/clients/client-tnb/src/commands/GetSolFunctionPackageContentCommand.ts +++ b/clients/client-tnb/src/commands/GetSolFunctionPackageContentCommand.ts @@ -84,7 +84,8 @@ export interface GetSolFunctionPackageContentCommandOutput *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/GetSolFunctionPackageDescriptorCommand.ts b/clients/client-tnb/src/commands/GetSolFunctionPackageDescriptorCommand.ts index 104b462e2578..99743b34295d 100644 --- a/clients/client-tnb/src/commands/GetSolFunctionPackageDescriptorCommand.ts +++ b/clients/client-tnb/src/commands/GetSolFunctionPackageDescriptorCommand.ts @@ -82,7 +82,8 @@ export interface GetSolFunctionPackageDescriptorCommandOutput *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/GetSolNetworkInstanceCommand.ts b/clients/client-tnb/src/commands/GetSolNetworkInstanceCommand.ts index 5d021058b6e6..95c8ad5682b9 100644 --- a/clients/client-tnb/src/commands/GetSolNetworkInstanceCommand.ts +++ b/clients/client-tnb/src/commands/GetSolNetworkInstanceCommand.ts @@ -52,7 +52,7 @@ export interface GetSolNetworkInstanceCommandOutput extends GetSolNetworkInstanc * // nsInstanceDescription: "STRING_VALUE", // required * // nsdId: "STRING_VALUE", // required * // nsdInfoId: "STRING_VALUE", // required - * // nsState: "INSTANTIATED" || "NOT_INSTANTIATED" || "IMPAIRED" || "STOPPED" || "DELETED" || "INSTANTIATE_IN_PROGRESS" || "UPDATE_IN_PROGRESS" || "TERMINATE_IN_PROGRESS", + * // nsState: "INSTANTIATED" || "NOT_INSTANTIATED" || "UPDATED" || "IMPAIRED" || "UPDATE_FAILED" || "STOPPED" || "DELETED" || "INSTANTIATE_IN_PROGRESS" || "INTENT_TO_UPDATE_IN_PROGRESS" || "UPDATE_IN_PROGRESS" || "TERMINATE_IN_PROGRESS", * // lcmOpInfo: { // LcmOperationInfo * // nsLcmOpOccId: "STRING_VALUE", // required * // }, @@ -86,7 +86,8 @@ export interface GetSolNetworkInstanceCommandOutput extends GetSolNetworkInstanc *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/GetSolNetworkOperationCommand.ts b/clients/client-tnb/src/commands/GetSolNetworkOperationCommand.ts index de2454f58b2f..b2ef9fe3fde3 100644 --- a/clients/client-tnb/src/commands/GetSolNetworkOperationCommand.ts +++ b/clients/client-tnb/src/commands/GetSolNetworkOperationCommand.ts @@ -32,7 +32,8 @@ export interface GetSolNetworkOperationCommandInput extends GetSolNetworkOperati export interface GetSolNetworkOperationCommandOutput extends GetSolNetworkOperationOutput, __MetadataBearer {} /** - *

Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks.

+ *

Gets the details of a network operation, including the tasks involved in the network + * operation and the status of the tasks.

*

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

* @example * Use a bare-bones client and the command you need to make an API call. @@ -51,11 +52,24 @@ export interface GetSolNetworkOperationCommandOutput extends GetSolNetworkOperat * // operationState: "PROCESSING" || "COMPLETED" || "FAILED" || "CANCELLING" || "CANCELLED", * // nsInstanceId: "STRING_VALUE", * // lcmOperationType: "INSTANTIATE" || "UPDATE" || "TERMINATE", + * // updateType: "MODIFY_VNF_INFORMATION" || "UPDATE_NS", * // error: { // ProblemDetails * // detail: "STRING_VALUE", // required * // title: "STRING_VALUE", * // }, * // metadata: { // GetSolNetworkOperationMetadata + * // updateNsMetadata: { // UpdateNsMetadata + * // nsdInfoId: "STRING_VALUE", // required + * // additionalParamsForNs: "DOCUMENT_VALUE", + * // }, + * // modifyVnfInfoMetadata: { // ModifyVnfInfoMetadata + * // vnfInstanceId: "STRING_VALUE", // required + * // vnfConfigurableProperties: "DOCUMENT_VALUE", // required + * // }, + * // instantiateMetadata: { // InstantiateMetadata + * // nsdInfoId: "STRING_VALUE", // required + * // additionalParamsForNs: "DOCUMENT_VALUE", + * // }, * // createdAt: new Date("TIMESTAMP"), // required * // lastModified: new Date("TIMESTAMP"), // required * // }, @@ -100,7 +114,8 @@ export interface GetSolNetworkOperationCommandOutput extends GetSolNetworkOperat *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/GetSolNetworkPackageCommand.ts b/clients/client-tnb/src/commands/GetSolNetworkPackageCommand.ts index 38778fad744a..40ce4328c63a 100644 --- a/clients/client-tnb/src/commands/GetSolNetworkPackageCommand.ts +++ b/clients/client-tnb/src/commands/GetSolNetworkPackageCommand.ts @@ -95,7 +95,8 @@ export interface GetSolNetworkPackageCommandOutput extends GetSolNetworkPackageO *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/GetSolNetworkPackageContentCommand.ts b/clients/client-tnb/src/commands/GetSolNetworkPackageContentCommand.ts index 6025a6d31fbc..bcab9a5b8129 100644 --- a/clients/client-tnb/src/commands/GetSolNetworkPackageContentCommand.ts +++ b/clients/client-tnb/src/commands/GetSolNetworkPackageContentCommand.ts @@ -81,7 +81,8 @@ export interface GetSolNetworkPackageContentCommandOutput *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/GetSolNetworkPackageDescriptorCommand.ts b/clients/client-tnb/src/commands/GetSolNetworkPackageDescriptorCommand.ts index 18a2b454c169..cbadb427c669 100644 --- a/clients/client-tnb/src/commands/GetSolNetworkPackageDescriptorCommand.ts +++ b/clients/client-tnb/src/commands/GetSolNetworkPackageDescriptorCommand.ts @@ -80,7 +80,8 @@ export interface GetSolNetworkPackageDescriptorCommandOutput *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/InstantiateSolNetworkInstanceCommand.ts b/clients/client-tnb/src/commands/InstantiateSolNetworkInstanceCommand.ts index ac1f7a26d5fd..90bd0c494da0 100644 --- a/clients/client-tnb/src/commands/InstantiateSolNetworkInstanceCommand.ts +++ b/clients/client-tnb/src/commands/InstantiateSolNetworkInstanceCommand.ts @@ -40,7 +40,8 @@ export interface InstantiateSolNetworkInstanceCommandOutput /** *

Instantiates a network instance.

*

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.

- *

Before you can instantiate a network instance, you have to create a network instance. For more information, see CreateSolNetworkInstance.

+ *

Before you can instantiate a network instance, you have to create a network instance. + * For more information, see CreateSolNetworkInstance.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -88,7 +89,8 @@ export interface InstantiateSolNetworkInstanceCommandOutput *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/ListSolFunctionInstancesCommand.ts b/clients/client-tnb/src/commands/ListSolFunctionInstancesCommand.ts index e72eb456b665..f08dfed16985 100644 --- a/clients/client-tnb/src/commands/ListSolFunctionInstancesCommand.ts +++ b/clients/client-tnb/src/commands/ListSolFunctionInstancesCommand.ts @@ -81,7 +81,8 @@ export interface ListSolFunctionInstancesCommandOutput extends ListSolFunctionIn *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/ListSolFunctionPackagesCommand.ts b/clients/client-tnb/src/commands/ListSolFunctionPackagesCommand.ts index 788301fc4bb4..c103317e81c6 100644 --- a/clients/client-tnb/src/commands/ListSolFunctionPackagesCommand.ts +++ b/clients/client-tnb/src/commands/ListSolFunctionPackagesCommand.ts @@ -81,7 +81,8 @@ export interface ListSolFunctionPackagesCommandOutput extends ListSolFunctionPac *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/ListSolNetworkInstancesCommand.ts b/clients/client-tnb/src/commands/ListSolNetworkInstancesCommand.ts index 049c6bc4952a..a4af5511a6ad 100644 --- a/clients/client-tnb/src/commands/ListSolNetworkInstancesCommand.ts +++ b/clients/client-tnb/src/commands/ListSolNetworkInstancesCommand.ts @@ -52,7 +52,7 @@ export interface ListSolNetworkInstancesCommandOutput extends ListSolNetworkInst * // nsInstanceDescription: "STRING_VALUE", // required * // nsdId: "STRING_VALUE", // required * // nsdInfoId: "STRING_VALUE", // required - * // nsState: "INSTANTIATED" || "NOT_INSTANTIATED" || "IMPAIRED" || "STOPPED" || "DELETED" || "INSTANTIATE_IN_PROGRESS" || "UPDATE_IN_PROGRESS" || "TERMINATE_IN_PROGRESS", // required + * // nsState: "INSTANTIATED" || "NOT_INSTANTIATED" || "UPDATED" || "IMPAIRED" || "UPDATE_FAILED" || "STOPPED" || "DELETED" || "INSTANTIATE_IN_PROGRESS" || "INTENT_TO_UPDATE_IN_PROGRESS" || "UPDATE_IN_PROGRESS" || "TERMINATE_IN_PROGRESS", // required * // metadata: { // ListSolNetworkInstanceMetadata * // createdAt: new Date("TIMESTAMP"), // required * // lastModified: new Date("TIMESTAMP"), // required @@ -79,7 +79,8 @@ export interface ListSolNetworkInstancesCommandOutput extends ListSolNetworkInst *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/ListSolNetworkOperationsCommand.ts b/clients/client-tnb/src/commands/ListSolNetworkOperationsCommand.ts index 2d9580981dfb..39193fe27deb 100644 --- a/clients/client-tnb/src/commands/ListSolNetworkOperationsCommand.ts +++ b/clients/client-tnb/src/commands/ListSolNetworkOperationsCommand.ts @@ -28,7 +28,8 @@ export interface ListSolNetworkOperationsCommandInput extends ListSolNetworkOper export interface ListSolNetworkOperationsCommandOutput extends ListSolNetworkOperationsOutput, __MetadataBearer {} /** - *

Lists details for a network operation, including when the operation started and the status of the operation.

+ *

Lists details for a network operation, including when the operation started and the + * status of the operation.

*

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

* @example * Use a bare-bones client and the command you need to make an API call. @@ -37,6 +38,7 @@ export interface ListSolNetworkOperationsCommandOutput extends ListSolNetworkOpe * // const { TnbClient, ListSolNetworkOperationsCommand } = require("@aws-sdk/client-tnb"); // CommonJS import * const client = new TnbClient(config); * const input = { // ListSolNetworkOperationsInput + * nsInstanceId: "STRING_VALUE", * maxResults: Number("int"), * nextToken: "STRING_VALUE", * }; @@ -51,11 +53,14 @@ export interface ListSolNetworkOperationsCommandOutput extends ListSolNetworkOpe * // operationState: "PROCESSING" || "COMPLETED" || "FAILED" || "CANCELLING" || "CANCELLED", // required * // nsInstanceId: "STRING_VALUE", // required * // lcmOperationType: "INSTANTIATE" || "UPDATE" || "TERMINATE", // required + * // updateType: "MODIFY_VNF_INFORMATION" || "UPDATE_NS", * // error: { // ProblemDetails * // detail: "STRING_VALUE", // required * // title: "STRING_VALUE", * // }, * // metadata: { // ListSolNetworkOperationsMetadata + * // nsdInfoId: "STRING_VALUE", + * // vnfInstanceId: "STRING_VALUE", * // createdAt: new Date("TIMESTAMP"), // required * // lastModified: new Date("TIMESTAMP"), // required * // }, @@ -81,7 +86,8 @@ export interface ListSolNetworkOperationsCommandOutput extends ListSolNetworkOpe *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/ListSolNetworkPackagesCommand.ts b/clients/client-tnb/src/commands/ListSolNetworkPackagesCommand.ts index 7763d0812c7b..35424a3a345e 100644 --- a/clients/client-tnb/src/commands/ListSolNetworkPackagesCommand.ts +++ b/clients/client-tnb/src/commands/ListSolNetworkPackagesCommand.ts @@ -85,7 +85,8 @@ export interface ListSolNetworkPackagesCommandOutput extends ListSolNetworkPacka *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/ListTagsForResourceCommand.ts b/clients/client-tnb/src/commands/ListTagsForResourceCommand.ts index f9a2752b9cf9..c97b71a4ebba 100644 --- a/clients/client-tnb/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-tnb/src/commands/ListTagsForResourceCommand.ts @@ -71,7 +71,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/PutSolFunctionPackageContentCommand.ts b/clients/client-tnb/src/commands/PutSolFunctionPackageContentCommand.ts index d17a0806b7a3..d0895f18af9a 100644 --- a/clients/client-tnb/src/commands/PutSolFunctionPackageContentCommand.ts +++ b/clients/client-tnb/src/commands/PutSolFunctionPackageContentCommand.ts @@ -5,7 +5,11 @@ import { Command as $Command } from "@smithy/smithy-client"; import { BlobPayloadInputTypes, MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { PutSolFunctionPackageContentInput, PutSolFunctionPackageContentOutput } from "../models/models_0"; +import { + PutSolFunctionPackageContentInput, + PutSolFunctionPackageContentInputFilterSensitiveLog, + PutSolFunctionPackageContentOutput, +} from "../models/models_0"; import { de_PutSolFunctionPackageContentCommand, se_PutSolFunctionPackageContentCommand, @@ -94,7 +98,8 @@ export interface PutSolFunctionPackageContentCommandOutput *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

@@ -120,7 +125,7 @@ export class PutSolFunctionPackageContentCommand extends $Command }) .s("TNB", "PutSolFunctionPackageContent", {}) .n("TnbClient", "PutSolFunctionPackageContentCommand") - .f(void 0, void 0) + .f(PutSolFunctionPackageContentInputFilterSensitiveLog, void 0) .ser(se_PutSolFunctionPackageContentCommand) .de(de_PutSolFunctionPackageContentCommand) .build() {} diff --git a/clients/client-tnb/src/commands/PutSolNetworkPackageContentCommand.ts b/clients/client-tnb/src/commands/PutSolNetworkPackageContentCommand.ts index 39cb079def2f..62a9a9534f7b 100644 --- a/clients/client-tnb/src/commands/PutSolNetworkPackageContentCommand.ts +++ b/clients/client-tnb/src/commands/PutSolNetworkPackageContentCommand.ts @@ -5,7 +5,11 @@ import { Command as $Command } from "@smithy/smithy-client"; import { BlobPayloadInputTypes, MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { PutSolNetworkPackageContentInput, PutSolNetworkPackageContentOutput } from "../models/models_0"; +import { + PutSolNetworkPackageContentInput, + PutSolNetworkPackageContentInputFilterSensitiveLog, + PutSolNetworkPackageContentOutput, +} from "../models/models_0"; import { de_PutSolNetworkPackageContentCommand, se_PutSolNetworkPackageContentCommand, @@ -95,7 +99,8 @@ export interface PutSolNetworkPackageContentCommandOutput extends PutSolNetworkP *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

@@ -121,7 +126,7 @@ export class PutSolNetworkPackageContentCommand extends $Command }) .s("TNB", "PutSolNetworkPackageContent", {}) .n("TnbClient", "PutSolNetworkPackageContentCommand") - .f(void 0, void 0) + .f(PutSolNetworkPackageContentInputFilterSensitiveLog, void 0) .ser(se_PutSolNetworkPackageContentCommand) .de(de_PutSolNetworkPackageContentCommand) .build() {} diff --git a/clients/client-tnb/src/commands/TagResourceCommand.ts b/clients/client-tnb/src/commands/TagResourceCommand.ts index a875bd09917c..6f3582b6c0b7 100644 --- a/clients/client-tnb/src/commands/TagResourceCommand.ts +++ b/clients/client-tnb/src/commands/TagResourceCommand.ts @@ -67,7 +67,8 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/TerminateSolNetworkInstanceCommand.ts b/clients/client-tnb/src/commands/TerminateSolNetworkInstanceCommand.ts index b0ffeaa7447f..743895292220 100644 --- a/clients/client-tnb/src/commands/TerminateSolNetworkInstanceCommand.ts +++ b/clients/client-tnb/src/commands/TerminateSolNetworkInstanceCommand.ts @@ -84,7 +84,8 @@ export interface TerminateSolNetworkInstanceCommandOutput extends TerminateSolNe *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/UntagResourceCommand.ts b/clients/client-tnb/src/commands/UntagResourceCommand.ts index 35f88a314528..3ecf8257a1a5 100644 --- a/clients/client-tnb/src/commands/UntagResourceCommand.ts +++ b/clients/client-tnb/src/commands/UntagResourceCommand.ts @@ -67,7 +67,8 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/UpdateSolFunctionPackageCommand.ts b/clients/client-tnb/src/commands/UpdateSolFunctionPackageCommand.ts index 210bc37c5eb4..5df6e5dde37e 100644 --- a/clients/client-tnb/src/commands/UpdateSolFunctionPackageCommand.ts +++ b/clients/client-tnb/src/commands/UpdateSolFunctionPackageCommand.ts @@ -67,7 +67,8 @@ export interface UpdateSolFunctionPackageCommandOutput extends UpdateSolFunction *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/UpdateSolNetworkInstanceCommand.ts b/clients/client-tnb/src/commands/UpdateSolNetworkInstanceCommand.ts index 9158536bec79..1250498e733f 100644 --- a/clients/client-tnb/src/commands/UpdateSolNetworkInstanceCommand.ts +++ b/clients/client-tnb/src/commands/UpdateSolNetworkInstanceCommand.ts @@ -35,6 +35,7 @@ export interface UpdateSolNetworkInstanceCommandOutput extends UpdateSolNetworkI /** *

Update a network instance.

*

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.

+ *

Choose the updateType parameter to target the necessary update of the network instance.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -43,11 +44,15 @@ export interface UpdateSolNetworkInstanceCommandOutput extends UpdateSolNetworkI * const client = new TnbClient(config); * const input = { // UpdateSolNetworkInstanceInput * nsInstanceId: "STRING_VALUE", // required - * updateType: "MODIFY_VNF_INFORMATION", // required + * updateType: "MODIFY_VNF_INFORMATION" || "UPDATE_NS", // required * modifyVnfInfoData: { // UpdateSolNetworkModify * vnfInstanceId: "STRING_VALUE", // required * vnfConfigurableProperties: "DOCUMENT_VALUE", // required * }, + * updateNs: { // UpdateSolNetworkServiceData + * nsdInfoId: "STRING_VALUE", // required + * additionalParamsForNs: "DOCUMENT_VALUE", + * }, * tags: { // TagMap * "": "STRING_VALUE", * }, @@ -85,7 +90,8 @@ export interface UpdateSolNetworkInstanceCommandOutput extends UpdateSolNetworkI *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/UpdateSolNetworkPackageCommand.ts b/clients/client-tnb/src/commands/UpdateSolNetworkPackageCommand.ts index 4e059393023b..014de5898aec 100644 --- a/clients/client-tnb/src/commands/UpdateSolNetworkPackageCommand.ts +++ b/clients/client-tnb/src/commands/UpdateSolNetworkPackageCommand.ts @@ -68,7 +68,8 @@ export interface UpdateSolNetworkPackageCommandOutput extends UpdateSolNetworkPa *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

diff --git a/clients/client-tnb/src/commands/ValidateSolFunctionPackageContentCommand.ts b/clients/client-tnb/src/commands/ValidateSolFunctionPackageContentCommand.ts index ae130710dbc3..ee5e96e25635 100644 --- a/clients/client-tnb/src/commands/ValidateSolFunctionPackageContentCommand.ts +++ b/clients/client-tnb/src/commands/ValidateSolFunctionPackageContentCommand.ts @@ -5,7 +5,11 @@ import { Command as $Command } from "@smithy/smithy-client"; import { BlobPayloadInputTypes, MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { ValidateSolFunctionPackageContentInput, ValidateSolFunctionPackageContentOutput } from "../models/models_0"; +import { + ValidateSolFunctionPackageContentInput, + ValidateSolFunctionPackageContentInputFilterSensitiveLog, + ValidateSolFunctionPackageContentOutput, +} from "../models/models_0"; import { de_ValidateSolFunctionPackageContentCommand, se_ValidateSolFunctionPackageContentCommand, @@ -41,7 +45,8 @@ export interface ValidateSolFunctionPackageContentCommandOutput __MetadataBearer {} /** - *

Validates function package content. This can be used as a dry run before uploading function package content with PutSolFunctionPackageContent.

+ *

Validates function package content. This can be used as a dry run before uploading + * function package content with PutSolFunctionPackageContent.

*

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.

* @example * Use a bare-bones client and the command you need to make an API call. @@ -95,7 +100,8 @@ export interface ValidateSolFunctionPackageContentCommandOutput *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

@@ -121,7 +127,7 @@ export class ValidateSolFunctionPackageContentCommand extends $Command }) .s("TNB", "ValidateSolFunctionPackageContent", {}) .n("TnbClient", "ValidateSolFunctionPackageContentCommand") - .f(void 0, void 0) + .f(ValidateSolFunctionPackageContentInputFilterSensitiveLog, void 0) .ser(se_ValidateSolFunctionPackageContentCommand) .de(de_ValidateSolFunctionPackageContentCommand) .build() {} diff --git a/clients/client-tnb/src/commands/ValidateSolNetworkPackageContentCommand.ts b/clients/client-tnb/src/commands/ValidateSolNetworkPackageContentCommand.ts index 2c420e7c0730..6fc228b729cf 100644 --- a/clients/client-tnb/src/commands/ValidateSolNetworkPackageContentCommand.ts +++ b/clients/client-tnb/src/commands/ValidateSolNetworkPackageContentCommand.ts @@ -5,7 +5,11 @@ import { Command as $Command } from "@smithy/smithy-client"; import { BlobPayloadInputTypes, MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { ValidateSolNetworkPackageContentInput, ValidateSolNetworkPackageContentOutput } from "../models/models_0"; +import { + ValidateSolNetworkPackageContentInput, + ValidateSolNetworkPackageContentInputFilterSensitiveLog, + ValidateSolNetworkPackageContentOutput, +} from "../models/models_0"; import { de_ValidateSolNetworkPackageContentCommand, se_ValidateSolNetworkPackageContentCommand, @@ -41,7 +45,8 @@ export interface ValidateSolNetworkPackageContentCommandOutput __MetadataBearer {} /** - *

Validates network package content. This can be used as a dry run before uploading network package content with PutSolNetworkPackageContent.

+ *

Validates network package content. This can be used as a dry run before uploading + * network package content with PutSolNetworkPackageContent.

*

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.

* @example * Use a bare-bones client and the command you need to make an API call. @@ -98,7 +103,8 @@ export interface ValidateSolNetworkPackageContentCommandOutput *

Exception caused by throttling.

* * @throws {@link ValidationException} (client fault) - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* * @throws {@link TnbServiceException} *

Base exception class for all service exceptions from Tnb service.

@@ -124,7 +130,7 @@ export class ValidateSolNetworkPackageContentCommand extends $Command }) .s("TNB", "ValidateSolNetworkPackageContent", {}) .n("TnbClient", "ValidateSolNetworkPackageContentCommand") - .f(void 0, void 0) + .f(ValidateSolNetworkPackageContentInputFilterSensitiveLog, void 0) .ser(se_ValidateSolNetworkPackageContentCommand) .de(de_ValidateSolNetworkPackageContentCommand) .build() {} diff --git a/clients/client-tnb/src/index.ts b/clients/client-tnb/src/index.ts index 1a95fbff8894..4ce984797a44 100644 --- a/clients/client-tnb/src/index.ts +++ b/clients/client-tnb/src/index.ts @@ -1,7 +1,11 @@ // smithy-typescript generated code /* eslint-disable */ /** - *

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.

+ *

+ * 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.

* * @packageDocumentation */ diff --git a/clients/client-tnb/src/models/models_0.ts b/clients/client-tnb/src/models/models_0.ts index 183d8a653d42..f1961417c0d2 100644 --- a/clients/client-tnb/src/models/models_0.ts +++ b/clients/client-tnb/src/models/models_0.ts @@ -97,7 +97,8 @@ export class ThrottlingException extends __BaseException { } /** - *

Unable to process the request because the client provided input failed to satisfy request constraints.

+ *

Unable to process the request because the client provided input failed to satisfy + * request constraints.

* @public */ export class ValidationException extends __BaseException { @@ -750,7 +751,7 @@ export interface GetSolFunctionPackageOutput { usageState: UsageState | undefined; /** - *

Function package descriptor ID.

+ *

Function package descriptor ID.

* @public */ vnfdId?: string; @@ -845,7 +846,8 @@ export interface GetSolFunctionPackageDescriptorInput { vnfPkgId: string | undefined; /** - *

Indicates which content types, expressed as MIME types, the client is able to understand.

+ *

Indicates which content types, expressed as MIME types, the client is able to + * understand.

* @public */ accept: DescriptorContentType | undefined; @@ -933,9 +935,12 @@ export const NsState = { IMPAIRED: "IMPAIRED", INSTANTIATED: "INSTANTIATED", INSTANTIATE_IN_PROGRESS: "INSTANTIATE_IN_PROGRESS", + INTENT_TO_UPDATE_IN_PROGRESS: "INTENT_TO_UPDATE_IN_PROGRESS", NOT_INSTANTIATED: "NOT_INSTANTIATED", STOPPED: "STOPPED", TERMINATE_IN_PROGRESS: "TERMINATE_IN_PROGRESS", + UPDATED: "UPDATED", + UPDATE_FAILED: "UPDATE_FAILED", UPDATE_IN_PROGRESS: "UPDATE_IN_PROGRESS", } as const; @@ -1055,12 +1060,90 @@ export const LcmOperationType = { */ export type LcmOperationType = (typeof LcmOperationType)[keyof typeof LcmOperationType]; +/** + *

Metadata related to the configuration properties used during instantiation of the network instance.

+ * @public + */ +export interface InstantiateMetadata { + /** + *

The network service descriptor used for instantiating the network instance.

+ * @public + */ + nsdInfoId: string | undefined; + + /** + *

The configurable properties used during instantiation.

+ * @public + */ + additionalParamsForNs?: __DocumentType; +} + +/** + *

Metadata related to the configuration properties used during update of a specific + * network function in a network instance.

+ * @public + */ +export interface ModifyVnfInfoMetadata { + /** + *

The network function instance that was updated in the network instance.

+ * @public + */ + vnfInstanceId: string | undefined; + + /** + *

The configurable properties used during update of the network function instance.

+ * @public + */ + vnfConfigurableProperties: __DocumentType | undefined; +} + +/** + *

Metadata related to the configuration properties used during update of a network instance.

+ * @public + */ +export interface UpdateNsMetadata { + /** + *

The network service descriptor used for updating the network instance.

+ * @public + */ + nsdInfoId: string | undefined; + + /** + *

The configurable properties used during update.

+ * @public + */ + additionalParamsForNs?: __DocumentType; +} + /** *

Metadata related to a network operation occurrence.

*

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

* @public */ export interface GetSolNetworkOperationMetadata { + /** + *

Metadata related to the network operation occurrence for network instance updates. + * This is populated only if the lcmOperationType is UPDATE and the + * updateType is UPDATE_NS.

+ * @public + */ + updateNsMetadata?: UpdateNsMetadata; + + /** + *

Metadata related to the network operation occurrence for network function updates in a network instance. + * This is populated only if the lcmOperationType is UPDATE and the + * updateType is MODIFY_VNF_INFORMATION.

+ * @public + */ + modifyVnfInfoMetadata?: ModifyVnfInfoMetadata; + + /** + *

Metadata related to the network operation occurrence for network instantiation. + * This is populated only if the lcmOperationType is INSTANTIATE.

+ * @public + */ + instantiateMetadata?: InstantiateMetadata; + /** *

The date that the resource was created.

* @public @@ -1153,6 +1236,20 @@ export interface GetSolNetworkOperationTaskDetails { taskEndTime?: Date; } +/** + * @public + * @enum + */ +export const UpdateSolNetworkType = { + MODIFY_VNF_INFORMATION: "MODIFY_VNF_INFORMATION", + UPDATE_NS: "UPDATE_NS", +} as const; + +/** + * @public + */ +export type UpdateSolNetworkType = (typeof UpdateSolNetworkType)[keyof typeof UpdateSolNetworkType]; + /** * @public */ @@ -1187,6 +1284,13 @@ export interface GetSolNetworkOperationOutput { */ lcmOperationType?: LcmOperationType; + /** + *

Type of the update. Only present if the network operation + * lcmOperationType is UPDATE.

+ * @public + */ + updateType?: UpdateSolNetworkType; + /** *

Error related to this specific network operation occurrence.

* @public @@ -1243,7 +1347,8 @@ export interface NetworkArtifactMeta { */ export interface GetSolNetworkPackageMetadata { /** - *

Metadata related to the onboarded network service descriptor in the network package.

+ *

Metadata related to the onboarded network service descriptor in the network + * package.

* @public */ nsd?: NetworkArtifactMeta; @@ -1314,7 +1419,8 @@ export interface GetSolNetworkPackageOutput { nsdVersion: string | undefined; /** - *

Identifies the function package for the function package descriptor referenced by the onboarded network package.

+ *

Identifies the function package for the function package descriptor referenced by the + * onboarded network package.

* @public */ vnfPkgIds: string[] | undefined; @@ -1420,7 +1526,7 @@ export interface InstantiateSolNetworkInstanceInput { additionalParamsForNs?: __DocumentType; /** - *

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.

+ *

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

* @public */ tags?: Record; @@ -1437,7 +1543,7 @@ export interface InstantiateSolNetworkInstanceOutput { nsLcmOpOccId: string | undefined; /** - *

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.

+ *

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

* @public */ tags?: Record; @@ -1784,6 +1890,12 @@ export interface ListSolNetworkInstancesOutput { * @public */ export interface ListSolNetworkOperationsInput { + /** + *

Network instance id filter, to retrieve network operations associated to a network instance.

+ * @public + */ + nsInstanceId?: string; + /** *

The maximum number of results to include in the response.

* @public @@ -1803,6 +1915,20 @@ export interface ListSolNetworkOperationsInput { * @public */ export interface ListSolNetworkOperationsMetadata { + /** + *

The network service descriptor id used for the operation.

+ *

Only present if the updateType is UPDATE_NS.

+ * @public + */ + nsdInfoId?: string; + + /** + *

The network function id used for the operation.

+ *

Only present if the updateType is MODIFY_VNF_INFO.

+ * @public + */ + vnfInstanceId?: string; + /** *

The date that the resource was created.

* @public @@ -1851,6 +1977,12 @@ export interface ListSolNetworkOperationsInfo { */ lcmOperationType: LcmOperationType | undefined; + /** + *

Type of the update. Only present if the network operation lcmOperationType is UPDATE.

+ * @public + */ + updateType?: UpdateSolNetworkType; + /** *

Error related to this specific network operation.

* @public @@ -1967,7 +2099,8 @@ export interface ListSolNetworkPackageInfo { nsdInvariantId?: string; /** - *

Identifies the function package for the function package descriptor referenced by the onboarded network package.

+ *

Identifies the function package for the function package descriptor referenced by the + * onboarded network package.

* @public */ vnfPkgIds?: string[]; @@ -2230,7 +2363,7 @@ export interface TerminateSolNetworkInstanceInput { nsInstanceId: string | undefined; /** - *

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.

+ *

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

* @public */ tags?: Record; @@ -2247,7 +2380,7 @@ export interface TerminateSolNetworkInstanceOutput { nsLcmOpOccId?: string; /** - *

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.

+ *

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

* @public */ tags?: Record; @@ -2317,24 +2450,30 @@ export interface UpdateSolNetworkModify { vnfInstanceId: string | undefined; /** - *

Provides values for the configurable properties declared in the function package descriptor.

+ *

Provides values for the configurable properties declared in the function package + * descriptor.

* @public */ vnfConfigurableProperties: __DocumentType | undefined; } /** + *

Information parameters and/or the configurable properties for a network descriptor used for update.

* @public - * @enum */ -export const UpdateSolNetworkType = { - MODIFY_VNF_INFORMATION: "MODIFY_VNF_INFORMATION", -} as const; +export interface UpdateSolNetworkServiceData { + /** + *

ID of the network service descriptor.

+ * @public + */ + nsdInfoId: string | undefined; -/** - * @public - */ -export type UpdateSolNetworkType = (typeof UpdateSolNetworkType)[keyof typeof UpdateSolNetworkType]; + /** + *

Values for the configurable properties declared in the network service descriptor.

+ * @public + */ + additionalParamsForNs?: __DocumentType; +} /** * @public @@ -2348,18 +2487,38 @@ export interface UpdateSolNetworkInstanceInput { /** *

The type of update.

+ *
    + *
  • + *

    Use the MODIFY_VNF_INFORMATION update type, to update a specific network function + * configuration, in the network instance.

    + *
    • + *
  • + *

    Use the UPDATE_NS update type, to update the network instance to a + * new network service descriptor.

    + *
    • + *
* @public */ updateType: UpdateSolNetworkType | undefined; /** - *

Identifies the network function information parameters and/or the configurable properties of the network function to be modified.

+ *

Identifies the network function information parameters and/or the configurable + * properties of the network function to be modified.

+ *

Include this property only if the update type is MODIFY_VNF_INFORMATION.

* @public */ modifyVnfInfoData?: UpdateSolNetworkModify; /** - *

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.

+ *

Identifies the network service descriptor and the configurable + * properties of the descriptor, to be used for the update.

+ *

Include this property only if the update type is UPDATE_NS.

+ * @public + */ + updateNs?: UpdateSolNetworkServiceData; + + /** + *

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

* @public */ tags?: Record; @@ -2376,7 +2535,7 @@ export interface UpdateSolNetworkInstanceOutput { nsLcmOpOccId?: string; /** - *

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.

+ *

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

* @public */ tags?: Record; @@ -2686,6 +2845,22 @@ export const ListTagsForResourceOutputFilterSensitiveLog = (obj: ListTagsForReso ...(obj.tags && { tags: SENSITIVE_STRING }), }); +/** + * @internal + */ +export const PutSolFunctionPackageContentInputFilterSensitiveLog = (obj: PutSolFunctionPackageContentInput): any => ({ + ...obj, + ...(obj.file && { file: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const PutSolNetworkPackageContentInputFilterSensitiveLog = (obj: PutSolNetworkPackageContentInput): any => ({ + ...obj, + ...(obj.file && { file: SENSITIVE_STRING }), +}); + /** * @internal */ @@ -2725,3 +2900,23 @@ export const UpdateSolNetworkInstanceOutputFilterSensitiveLog = (obj: UpdateSolN ...obj, ...(obj.tags && { tags: SENSITIVE_STRING }), }); + +/** + * @internal + */ +export const ValidateSolFunctionPackageContentInputFilterSensitiveLog = ( + obj: ValidateSolFunctionPackageContentInput +): any => ({ + ...obj, + ...(obj.file && { file: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const ValidateSolNetworkPackageContentInputFilterSensitiveLog = ( + obj: ValidateSolNetworkPackageContentInput +): any => ({ + ...obj, + ...(obj.file && { file: SENSITIVE_STRING }), +}); diff --git a/clients/client-tnb/src/protocols/Aws_restJson1.ts b/clients/client-tnb/src/protocols/Aws_restJson1.ts index 5eb097e547c1..4965f055d9d5 100644 --- a/clients/client-tnb/src/protocols/Aws_restJson1.ts +++ b/clients/client-tnb/src/protocols/Aws_restJson1.ts @@ -157,6 +157,7 @@ import { GetSolNetworkOperationMetadata, GetSolNetworkOperationTaskDetails, GetSolNetworkPackageMetadata, + InstantiateMetadata, InternalServerException, ListSolFunctionInstanceInfo, ListSolFunctionInstanceMetadata, @@ -168,10 +169,13 @@ import { ListSolNetworkOperationsMetadata, ListSolNetworkPackageInfo, ListSolNetworkPackageMetadata, + ModifyVnfInfoMetadata, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, + UpdateNsMetadata, UpdateSolNetworkModify, + UpdateSolNetworkServiceData, ValidationException, } from "../models/models_0"; import { TnbServiceException as __BaseException } from "../models/TnbServiceException"; @@ -554,6 +558,7 @@ export const se_ListSolNetworkOperationsCommand = async ( const headers: any = {}; b.bp("/sol/nslcm/v1/ns_lcm_op_occs"); const query: any = map({ + [_nII]: [, input[_nII]!], [_mr]: [() => input.maxResults !== void 0, () => input[_mR]!.toString()], [_nom]: [, input[_nT]!], }); @@ -748,6 +753,7 @@ export const se_UpdateSolNetworkInstanceCommand = async ( take(input, { modifyVnfInfoData: (_) => se_UpdateSolNetworkModify(_, context), tags: (_) => _json(_), + updateNs: (_) => se_UpdateSolNetworkServiceData(_, context), updateType: [], }) ); @@ -1120,6 +1126,7 @@ export const de_GetSolNetworkOperationCommand = async ( operationState: __expectString, tags: _json, tasks: (_) => de_GetSolNetworkOperationTasksList(_, context), + updateType: __expectString, }); Object.assign(contents, doc); return contents; @@ -1738,6 +1745,16 @@ const se_UpdateSolNetworkModify = (input: UpdateSolNetworkModify, context: __Ser }); }; +/** + * serializeAws_restJson1UpdateSolNetworkServiceData + */ +const se_UpdateSolNetworkServiceData = (input: UpdateSolNetworkServiceData, context: __SerdeContext): any => { + return take(input, { + additionalParamsForNs: (_) => se_Document(_, context), + nsdInfoId: [], + }); +}; + /** * serializeAws_restJson1Document */ @@ -1788,7 +1805,10 @@ const de_GetSolNetworkInstanceMetadata = (output: any, context: __SerdeContext): const de_GetSolNetworkOperationMetadata = (output: any, context: __SerdeContext): GetSolNetworkOperationMetadata => { return take(output, { createdAt: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), + instantiateMetadata: (_: any) => de_InstantiateMetadata(_, context), lastModified: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), + modifyVnfInfoMetadata: (_: any) => de_ModifyVnfInfoMetadata(_, context), + updateNsMetadata: (_: any) => de_UpdateNsMetadata(_, context), }) as any; }; @@ -1843,6 +1863,16 @@ const de_GetSolNetworkPackageMetadata = (output: any, context: __SerdeContext): // de_GetSolVnfInfo omitted. +/** + * deserializeAws_restJson1InstantiateMetadata + */ +const de_InstantiateMetadata = (output: any, context: __SerdeContext): InstantiateMetadata => { + return take(output, { + additionalParamsForNs: (_: any) => de_Document(_, context), + nsdInfoId: __expectString, + }) as any; +}; + // de_LcmOperationInfo omitted. /** @@ -1973,6 +2003,7 @@ const de_ListSolNetworkOperationsInfo = (output: any, context: __SerdeContext): metadata: (_: any) => de_ListSolNetworkOperationsMetadata(_, context), nsInstanceId: __expectString, operationState: __expectString, + updateType: __expectString, }) as any; }; @@ -1986,6 +2017,8 @@ const de_ListSolNetworkOperationsMetadata = ( return take(output, { createdAt: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), lastModified: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), + nsdInfoId: __expectString, + vnfInstanceId: __expectString, }) as any; }; @@ -2043,6 +2076,16 @@ const de_ListSolNetworkPackageResources = (output: any, context: __SerdeContext) return retVal; }; +/** + * deserializeAws_restJson1ModifyVnfInfoMetadata + */ +const de_ModifyVnfInfoMetadata = (output: any, context: __SerdeContext): ModifyVnfInfoMetadata => { + return take(output, { + vnfConfigurableProperties: (_: any) => de_Document(_, context), + vnfInstanceId: __expectString, + }) as any; +}; + // de_NetworkArtifactMeta omitted. // de_OverrideList omitted. @@ -2059,12 +2102,29 @@ const de_ListSolNetworkPackageResources = (output: any, context: __SerdeContext) // de_ToscaOverride omitted. +/** + * deserializeAws_restJson1UpdateNsMetadata + */ +const de_UpdateNsMetadata = (output: any, context: __SerdeContext): UpdateNsMetadata => { + return take(output, { + additionalParamsForNs: (_: any) => de_Document(_, context), + nsdInfoId: __expectString, + }) as any; +}; + // de_ValidateSolFunctionPackageContentMetadata omitted. // de_ValidateSolNetworkPackageContentMetadata omitted. // de_VnfPkgIdList omitted. +/** + * deserializeAws_restJson1Document + */ +const de_Document = (output: any, context: __SerdeContext): __DocumentType => { + return output; +}; + const deserializeMetadata = (output: __HttpResponse): __ResponseMetadata => ({ httpStatusCode: output.statusCode, requestId: @@ -2091,6 +2151,7 @@ const _dR = "dryRun"; const _dr = "dry_run"; const _mR = "maxResults"; const _mr = "max_results"; +const _nII = "nsInstanceId"; const _nT = "nextToken"; const _nom = "nextpage_opaque_marker"; const _tK = "tagKeys"; diff --git a/codegen/sdk-codegen/aws-models/tnb.json b/codegen/sdk-codegen/aws-models/tnb.json index a58c37d91adf..31177ff9518e 100644 --- a/codegen/sdk-codegen/aws-models/tnb.json +++ b/codegen/sdk-codegen/aws-models/tnb.json @@ -101,7 +101,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a function package.

\n

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 Function packages in the Amazon Web Services Telco Network Builder User Guide. \n

\n

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 PutSolFunctionPackageContent.

", + "smithy.api#documentation": "

Creates a function package.

\n

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 Function packages in the\n Amazon Web Services Telco Network Builder User Guide.

\n

Creating a function package is the first step for creating a network in AWS TNB. This\n request creates an empty container with an ID. The next step is to upload the actual CSAR\n zip file into that empty container. To upload function package content, see PutSolFunctionPackageContent.

", "smithy.api#examples": [ { "title": "Create a Sol function package", @@ -221,7 +221,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a network instance.

\n

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, Network instances in the Amazon Web Services Telco Network Builder User Guide.

\n

Once you create a network instance, you can instantiate it. To instantiate a network, see InstantiateSolNetworkInstance.

", + "smithy.api#documentation": "

Creates a network instance.

\n

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\n package. For more information about network instances, Network instances in the\n Amazon Web Services Telco Network Builder User Guide.

\n

Once you create a network instance, you can instantiate it. To instantiate a network,\n see InstantiateSolNetworkInstance.

", "smithy.api#examples": [ { "title": "Create a Sol Network Instance", @@ -361,7 +361,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a network package.

\n

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 Network instances in the Amazon Web Services Telco Network Builder User Guide. \n

\n

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.

\n

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 PutSolNetworkPackageContent.

", + "smithy.api#documentation": "

Creates a network package.

\n

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 Network instances in the\n Amazon Web Services Telco Network Builder User Guide.

\n

A network package consists of a network service descriptor (NSD) file (required) and any\n additional files (optional), such as scripts specific to your needs. For example, if you\n have multiple function packages in your network package, you can use the NSD to define\n which network functions should run in certain VPCs, subnets, or EKS clusters.

\n

This request creates an empty network package container with an ID. Once you create a\n network package, you can upload the network package content using PutSolNetworkPackageContent.

", "smithy.api#examples": [ { "title": "Create a Sol network package", @@ -478,7 +478,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a function package.

\n

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.

\n

To delete a function package, the package must be in a disabled state. To disable a function package, see UpdateSolFunctionPackage.\n

", + "smithy.api#documentation": "

Deletes a function package.

\n

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.

\n

To delete a function package, the package must be in a disabled state. To disable a\n function package, see UpdateSolFunctionPackage.

", "smithy.api#examples": [ { "title": "Delete a function package", @@ -537,7 +537,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a network instance.

\n

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.

\n

To delete a network instance, the instance must be in a stopped or terminated state. To terminate a network instance, see TerminateSolNetworkInstance.

", + "smithy.api#documentation": "

Deletes a network instance.

\n

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.

\n

To delete a network instance, the instance must be in a stopped or terminated state. To\n terminate a network instance, see TerminateSolNetworkInstance.

", "smithy.api#examples": [ { "title": "Delete a Sol Network Instance.", @@ -596,7 +596,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes network package.

\n

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.

\n

To delete a network package, the package must be in a disable state. To disable a network package, see UpdateSolNetworkPackage.

", + "smithy.api#documentation": "

Deletes network package.

\n

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.

\n

To delete a network package, the package must be in a disable state. To disable a\n network package, see UpdateSolNetworkPackage.

", "smithy.api#examples": [ { "title": "Delete a Sol network package", @@ -717,7 +717,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the details of a network function instance, including the instantation state and metadata from the function package descriptor in the network function package.

\n

A network function instance is a function in a function package .

", + "smithy.api#documentation": "

Gets the details of a network function instance, including the instantiation state and\n metadata from the function package descriptor in the network function package.

\n

A network function instance is a function in a function package .

", "smithy.api#examples": [ { "title": "Get a Sol Network Function Instance details", @@ -910,7 +910,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the details of an individual function package, such as the operational state and whether the package is in use.

\n

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..

", + "smithy.api#documentation": "

Gets the details of an individual function package, such as the operational state and\n whether the package is in use.

\n

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..

", "smithy.api#examples": [ { "title": "Describe a function package with correct vnfPkgId", @@ -1098,7 +1098,7 @@ "accept": { "target": "com.amazonaws.tnb#DescriptorContentType", "traits": { - "smithy.api#documentation": "

Indicates which content types, expressed as MIME types, the client is able to understand.

", + "smithy.api#documentation": "

Indicates which content types, expressed as MIME types, the client is able to\n understand.

", "smithy.api#httpHeader": "Accept", "smithy.api#required": {} } @@ -1217,7 +1217,7 @@ "vnfdId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Function package descriptor ID.

" + "smithy.api#documentation": "

Function package descriptor ID.

" } }, "vnfProvider": { @@ -1462,7 +1462,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks.

\n

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

", + "smithy.api#documentation": "

Gets the details of a network operation, including the tasks involved in the network\n operation and the status of the tasks.

\n

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

", "smithy.api#examples": [ { "title": "Get Sol Network Instantiate operation", @@ -1476,6 +1476,85 @@ "operationState": "COMPLETED", "lcmOperationType": "INSTANTIATE", "metadata": { + "instantiateMetadata": { + "nsdInfoId": "np-0d0f3e2eae4fc1ac1", + "additionalParamsForNs": { + "cidr_block": "10.0.0.0/16", + "availability_zone": "us-west-2a" + } + }, + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + }, + "tasks": [ + { + "taskName": "HookExecution", + "taskContext": { + "cloudWatchLogsARN": "arn:aws:logs:us-east-1:123456789000:log-group:/aws/codebuild/TestProject:log-stream:a4dc6b0b-2ea3-48c5-bb30-636c4f376b81" + }, + "taskStatus": "IN_PROGRESS", + "taskStartTime": "2022-06-10T19:48:34Z", + "taskEndTime": "2022-06-10T21:48:33Z" + } + ] + } + }, + { + "title": "Get Sol Network Update operation", + "input": { + "nsLcmOpOccId": "no-0d5b823eb5c2a9241" + }, + "output": { + "id": "no-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", + "nsInstanceId": "ni-0d5b823eb5c2a9241", + "operationState": "COMPLETED", + "lcmOperationType": "UPDATE", + "updateType": "UPDATE_NS", + "metadata": { + "updateNsMetadata": { + "nsdInfoId": "np-0d0f3e2eae4fc1ac1", + "additionalParamsForNs": { + "cidr_block": "10.0.0.0/16", + "availability_zone": "us-west-2a" + } + }, + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + }, + "tasks": [ + { + "taskName": "HookExecution", + "taskContext": { + "cloudWatchLogsARN": "arn:aws:logs:us-east-1:123456789000:log-group:/aws/codebuild/TestProject:log-stream:a4dc6b0b-2ea3-48c5-bb30-636c4f376b81" + }, + "taskStatus": "IN_PROGRESS", + "taskStartTime": "2022-06-10T19:48:34Z", + "taskEndTime": "2022-06-10T21:48:33Z" + } + ] + } + }, + { + "title": "Get Sol Network Update operation", + "input": { + "nsLcmOpOccId": "no-0d5b823eb5c2a9241" + }, + "output": { + "id": "no-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", + "nsInstanceId": "ni-0d5b823eb5c2a9241", + "operationState": "COMPLETED", + "lcmOperationType": "UPDATE", + "updateType": "MODIFY_VNF_INFORMATION", + "metadata": { + "modifyVnfInfoMetadata": { + "vnfInstanceId": "fi-0d5b823eb5c2a9241", + "vnfConfigurableProperties": { + "pcf.port": "8080", + "pcf.pods": "10" + } + }, "createdAt": "2022-06-10T19:48:34Z", "lastModified": "2022-06-10T21:48:33Z" }, @@ -1561,6 +1640,24 @@ "com.amazonaws.tnb#GetSolNetworkOperationMetadata": { "type": "structure", "members": { + "updateNsMetadata": { + "target": "com.amazonaws.tnb#UpdateNsMetadata", + "traits": { + "smithy.api#documentation": "

Metadata related to the network operation occurrence for network instance updates.\n This is populated only if the lcmOperationType is UPDATE and the\n updateType is UPDATE_NS.

" + } + }, + "modifyVnfInfoMetadata": { + "target": "com.amazonaws.tnb#ModifyVnfInfoMetadata", + "traits": { + "smithy.api#documentation": "

Metadata related to the network operation occurrence for network function updates in a network instance.\n This is populated only if the lcmOperationType is UPDATE and the\n updateType is MODIFY_VNF_INFORMATION.

" + } + }, + "instantiateMetadata": { + "target": "com.amazonaws.tnb#InstantiateMetadata", + "traits": { + "smithy.api#documentation": "

Metadata related to the network operation occurrence for network instantiation.\n This is populated only if the lcmOperationType is INSTANTIATE.

" + } + }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { @@ -1616,6 +1713,12 @@ "smithy.api#documentation": "

Type of the operation represented by this occurrence.

" } }, + "updateType": { + "target": "com.amazonaws.tnb#UpdateSolNetworkType", + "traits": { + "smithy.api#documentation": "

Type of the update. Only present if the network operation\n lcmOperationType is UPDATE.

" + } + }, "error": { "target": "com.amazonaws.tnb#ProblemDetails", "traits": { @@ -1964,7 +2067,7 @@ "nsd": { "target": "com.amazonaws.tnb#NetworkArtifactMeta", "traits": { - "smithy.api#documentation": "

Metadata related to the onboarded network service descriptor in the network package.

" + "smithy.api#documentation": "

Metadata related to the onboarded network service descriptor in the network\n package.

" } }, "createdAt": { @@ -2050,7 +2153,7 @@ "vnfPkgIds": { "target": "com.amazonaws.tnb#VnfPkgIdList", "traits": { - "smithy.api#documentation": "

Identifies the function package for the function package descriptor referenced by the onboarded network package.

", + "smithy.api#documentation": "

Identifies the function package for the function package descriptor referenced by the\n onboarded network package.

", "smithy.api#required": {} } }, @@ -2137,6 +2240,27 @@ "smithy.api#documentation": "

The metadata of a network function.

\n

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.

" } }, + "com.amazonaws.tnb#InstantiateMetadata": { + "type": "structure", + "members": { + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "

The network service descriptor used for instantiating the network instance.

", + "smithy.api#required": {} + } + }, + "additionalParamsForNs": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

The configurable properties used during instantiation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata related to the configuration properties used during instantiation of the network instance.

" + } + }, "com.amazonaws.tnb#InstantiateSolNetworkInstance": { "type": "operation", "input": { @@ -2166,7 +2290,7 @@ } ], "traits": { - "smithy.api#documentation": "

Instantiates a network instance.

\n

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.

\n

Before you can instantiate a network instance, you have to create a network instance. For more information, see CreateSolNetworkInstance.

", + "smithy.api#documentation": "

Instantiates a network instance.

\n

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.

\n

Before you can instantiate a network instance, you have to create a network instance.\n For more information, see CreateSolNetworkInstance.

", "smithy.api#examples": [ { "title": "Instantiate a Sol Network Instance", @@ -2231,7 +2355,7 @@ "tags": { "target": "com.amazonaws.tnb#TagMap", "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.

" + "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

" } } }, @@ -2252,7 +2376,7 @@ "tags": { "target": "com.amazonaws.tnb#TagMap", "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.

" + "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

" } } }, @@ -3049,7 +3173,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists details for a network operation, including when the operation started and the status of the operation.

\n

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

", + "smithy.api#documentation": "

Lists details for a network operation, including when the operation started and the\n status of the operation.

\n

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

", "smithy.api#examples": [ { "title": "List Sol Network Instantiate operations", @@ -3063,6 +3187,7 @@ "operationState": "COMPLETED", "lcmOperationType": "INSTANTIATE", "metadata": { + "nsdInfoId": "np-0d0f3e2eae4fc1ac1", "createdAt": "2022-06-10T19:48:34Z", "lastModified": "2022-06-10T21:48:33Z" } @@ -3089,12 +3214,59 @@ "detail": "An error occurred (InsufficientInstanceCapacity) when calling the RunInstances operation (reached max retries: 4). We currently do not have sufficient capacity in the Availability Zone you requested" }, "metadata": { + "nsdInfoId": "np-0d0f3e2eae4fc1ac1", "createdAt": "2022-06-10T19:48:33Z", "lastModified": "2022-06-10T19:48:33Z" } } ] } + }, + { + "title": "List Sol Network Update operations", + "input": { + "nsInstanceId": "ni-0d5b823eb5c2a9241" + }, + "output": { + "networkOperations": [ + { + "id": "no-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", + "nsInstanceId": "ni-0d5b823eb5c2a9241", + "operationState": "COMPLETED", + "lcmOperationType": "UPDATE", + "updateType": "MODIFY_VNF_INFORMATION", + "metadata": { + "vnfInstanceId": "fi-0d5b823eb5c2a9241", + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + } + } + ] + } + }, + { + "title": "List Sol Network Update operations", + "input": { + "nsInstanceId": "ni-0d5b823eb5c2a9241" + }, + "output": { + "networkOperations": [ + { + "id": "no-0d5b823eb5c2a9241", + "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", + "nsInstanceId": "ni-0d5b823eb5c2a9241", + "operationState": "COMPLETED", + "lcmOperationType": "UPDATE", + "updateType": "UPDATE_NS", + "metadata": { + "nsdInfoId": "np-0d0f3e2eae4fc1ac1", + "createdAt": "2022-06-10T19:48:34Z", + "lastModified": "2022-06-10T21:48:33Z" + } + } + ] + } } ], "smithy.api#http": { @@ -3148,6 +3320,12 @@ "smithy.api#required": {} } }, + "updateType": { + "target": "com.amazonaws.tnb#UpdateSolNetworkType", + "traits": { + "smithy.api#documentation": "

Type of the update. Only present if the network operation lcmOperationType is UPDATE.

" + } + }, "error": { "target": "com.amazonaws.tnb#ProblemDetails", "traits": { @@ -3168,6 +3346,13 @@ "com.amazonaws.tnb#ListSolNetworkOperationsInput": { "type": "structure", "members": { + "nsInstanceId": { + "target": "com.amazonaws.tnb#NsInstanceId", + "traits": { + "smithy.api#documentation": "

Network instance id filter, to retrieve network operations associated to a network instance.

", + "smithy.api#httpQuery": "nsInstanceId" + } + }, "maxResults": { "target": "smithy.api#Integer", "traits": { @@ -3194,6 +3379,18 @@ "com.amazonaws.tnb#ListSolNetworkOperationsMetadata": { "type": "structure", "members": { + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "

The network service descriptor id used for the operation.

\n

Only present if the updateType is UPDATE_NS.

" + } + }, + "vnfInstanceId": { + "target": "com.amazonaws.tnb#VnfInstanceId", + "traits": { + "smithy.api#documentation": "

The network function id used for the operation.

\n

Only present if the updateType is MODIFY_VNF_INFO.

" + } + }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { @@ -3312,7 +3509,7 @@ "vnfPkgIds": { "target": "com.amazonaws.tnb#VnfPkgIdList", "traits": { - "smithy.api#documentation": "

Identifies the function package for the function package descriptor referenced by the onboarded network package.

" + "smithy.api#documentation": "

Identifies the function package for the function package descriptor referenced by the\n onboarded network package.

" } }, "metadata": { @@ -3584,6 +3781,28 @@ "smithy.api#output": {} } }, + "com.amazonaws.tnb#ModifyVnfInfoMetadata": { + "type": "structure", + "members": { + "vnfInstanceId": { + "target": "com.amazonaws.tnb#VnfInstanceId", + "traits": { + "smithy.api#documentation": "

The network function instance that was updated in the network instance.

", + "smithy.api#required": {} + } + }, + "vnfConfigurableProperties": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

The configurable properties used during update of the network function instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata related to the configuration properties used during update of a specific\n network function in a network instance.

" + } + }, "com.amazonaws.tnb#NetworkArtifactMeta": { "type": "structure", "members": { @@ -3672,12 +3891,24 @@ "smithy.api#enumValue": "NOT_INSTANTIATED" } }, + "UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED" + } + }, "IMPAIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPAIRED" } }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, "STOPPED": { "target": "smithy.api#Unit", "traits": { @@ -3696,6 +3927,12 @@ "smithy.api#enumValue": "INSTANTIATE_IN_PROGRESS" } }, + "INTENT_TO_UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTENT_TO_UPDATE_IN_PROGRESS" + } + }, "UPDATE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { @@ -3942,7 +4179,7 @@ } }, "file": { - "target": "smithy.api#Blob", + "target": "com.amazonaws.tnb#SensitiveBlob", "traits": { "smithy.api#documentation": "

Function package file.

", "smithy.api#httpPayload": {}, @@ -4100,7 +4337,7 @@ } }, "file": { - "target": "smithy.api#Blob", + "target": "com.amazonaws.tnb#SensitiveBlob", "traits": { "smithy.api#documentation": "

Network package file.

", "smithy.api#httpPayload": {}, @@ -4196,6 +4433,12 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.tnb#SensitiveBlob": { + "type": "blob", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.tnb#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -4347,7 +4590,7 @@ "additionalExposedHeaders": ["x-amzn-errortype", "x-amzn-requestid", "x-amzn-trace-id"], "maxAge": 86400 }, - "smithy.api#documentation": "

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.

", + "smithy.api#documentation": "

\n Amazon Web Services Telco Network Builder (TNB) is a network automation service that helps\n you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of\n your telecommunication network functions throughout planning, deployment, and\n post-deployment activities.

", "smithy.api#title": "AWS Telco Network Builder", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -5243,7 +5486,7 @@ "tags": { "target": "com.amazonaws.tnb#TagMap", "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.

" + "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

" } } }, @@ -5263,7 +5506,7 @@ "tags": { "target": "com.amazonaws.tnb#TagMap", "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.

" + "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

" } } }, @@ -5372,6 +5615,27 @@ "smithy.api#output": {} } }, + "com.amazonaws.tnb#UpdateNsMetadata": { + "type": "structure", + "members": { + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "

The network service descriptor used for updating the network instance.

", + "smithy.api#required": {} + } + }, + "additionalParamsForNs": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

The configurable properties used during update.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata related to the configuration properties used during update of a network instance.

" + } + }, "com.amazonaws.tnb#UpdateSolFunctionPackage": { "type": "operation", "input": { @@ -5494,7 +5758,7 @@ } ], "traits": { - "smithy.api#documentation": "

Update a network instance.

\n

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.

", + "smithy.api#documentation": "

Update a network instance.

\n

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.

\n

Choose the updateType parameter to target the necessary update of the network instance.

", "smithy.api#examples": [ { "title": "Update a Sol Network Instance", @@ -5518,6 +5782,29 @@ "Name": "Resource" } } + }, + { + "title": "Update a Sol Network Instance", + "input": { + "nsInstanceId": "ni-0d5b823eb5c2a9241", + "updateType": "UPDATE_NS", + "updateNs": { + "nsdInfoId": "np-0d5b823eb5c2a9241", + "additionalParamsForNs": { + "cidr_block": "10.0.0.0/16", + "availability_zone": "us-west-2a" + } + }, + "tags": { + "Name": "Resource" + } + }, + "output": { + "nsLcmOpOccId": "no-0d5b823eb5c2a9241", + "tags": { + "Name": "Resource" + } + } } ], "smithy.api#http": { @@ -5541,20 +5828,26 @@ "updateType": { "target": "com.amazonaws.tnb#UpdateSolNetworkType", "traits": { - "smithy.api#documentation": "

The type of update.

", + "smithy.api#documentation": "

The type of update.

\n
    \n
  • \n

    Use the MODIFY_VNF_INFORMATION update type, to update a specific network function\n configuration, in the network instance.

    \n
    • \n
  • \n

    Use the UPDATE_NS update type, to update the network instance to a\n new network service descriptor.

    \n
    • \n
", "smithy.api#required": {} } }, "modifyVnfInfoData": { "target": "com.amazonaws.tnb#UpdateSolNetworkModify", "traits": { - "smithy.api#documentation": "

Identifies the network function information parameters and/or the configurable properties of the network function to be modified.

" + "smithy.api#documentation": "

Identifies the network function information parameters and/or the configurable\n properties of the network function to be modified.

\n

Include this property only if the update type is MODIFY_VNF_INFORMATION.

" + } + }, + "updateNs": { + "target": "com.amazonaws.tnb#UpdateSolNetworkServiceData", + "traits": { + "smithy.api#documentation": "

Identifies the network service descriptor and the configurable\n properties of the descriptor, to be used for the update.

\n

Include this property only if the update type is UPDATE_NS.

" } }, "tags": { "target": "com.amazonaws.tnb#TagMap", "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.

" + "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

" } } }, @@ -5574,7 +5867,7 @@ "tags": { "target": "com.amazonaws.tnb#TagMap", "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.

" + "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

" } } }, @@ -5595,7 +5888,7 @@ "vnfConfigurableProperties": { "target": "smithy.api#Document", "traits": { - "smithy.api#documentation": "

Provides values for the configurable properties declared in the function package descriptor.

", + "smithy.api#documentation": "

Provides values for the configurable properties declared in the function package\n descriptor.

", "smithy.api#required": {} } } @@ -5697,6 +5990,27 @@ "smithy.api#output": {} } }, + "com.amazonaws.tnb#UpdateSolNetworkServiceData": { + "type": "structure", + "members": { + "nsdInfoId": { + "target": "com.amazonaws.tnb#NsdInfoId", + "traits": { + "smithy.api#documentation": "

ID of the network service descriptor.

", + "smithy.api#required": {} + } + }, + "additionalParamsForNs": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

Values for the configurable properties declared in the network service descriptor.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information parameters and/or the configurable properties for a network descriptor used for update.

" + } + }, "com.amazonaws.tnb#UpdateSolNetworkType": { "type": "enum", "members": { @@ -5705,6 +6019,12 @@ "traits": { "smithy.api#enumValue": "MODIFY_VNF_INFORMATION" } + }, + "UPDATE_NS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_NS" + } } } }, @@ -5751,7 +6071,7 @@ } ], "traits": { - "smithy.api#documentation": "

Validates function package content. This can be used as a dry run before uploading function package content with PutSolFunctionPackageContent.

\n

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.

", + "smithy.api#documentation": "

Validates function package content. This can be used as a dry run before uploading\n function package content with PutSolFunctionPackageContent.

\n

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.

", "smithy.api#examples": [ { "title": "Validate a Function Package content", @@ -5801,7 +6121,7 @@ } }, "file": { - "target": "smithy.api#Blob", + "target": "com.amazonaws.tnb#SensitiveBlob", "traits": { "smithy.api#documentation": "

Function package file.

", "smithy.api#httpPayload": {}, @@ -5900,7 +6220,7 @@ } ], "traits": { - "smithy.api#documentation": "

Validates network package content. This can be used as a dry run before uploading network package content with PutSolNetworkPackageContent.

\n

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.

", + "smithy.api#documentation": "

Validates network package content. This can be used as a dry run before uploading\n network package content with PutSolNetworkPackageContent.

\n

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.

", "smithy.api#examples": [ { "title": "Validate the network package content of a NSD archive", @@ -5959,7 +6279,7 @@ } }, "file": { - "target": "smithy.api#Blob", + "target": "com.amazonaws.tnb#SensitiveBlob", "traits": { "smithy.api#documentation": "

Network package file.

", "smithy.api#httpPayload": {}, @@ -6050,7 +6370,7 @@ } }, "traits": { - "smithy.api#documentation": "

Unable to process the request because the client provided input failed to satisfy request constraints.

", + "smithy.api#documentation": "

Unable to process the request because the client provided input failed to satisfy\n request constraints.

", "smithy.api#error": "client", "smithy.api#httpError": 400 }