From 48d3de3ee890c31ee07385d203c189ee8892dd02 Mon Sep 17 00:00:00 2001 From: rchache <105247787+rchache@users.noreply.github.com> Date: Wed, 21 Oct 2026 14:48:49 -0400 Subject: [PATCH] Delete models/tnb/service/2008-10-21 directory --- .../service/2008-10-21/tnb-2008-10-21.json | 6612 ----------------- 1 file changed, 6612 deletions(-) delete mode 100644 models/tnb/service/2008-10-21/tnb-2008-10-21.json diff --git a/models/tnb/service/2008-10-21/tnb-2008-10-21.json b/models/tnb/service/2008-10-21/tnb-2008-10-21.json deleted file mode 100644 index 62d539571..000000000 --- a/models/tnb/service/2008-10-21/tnb-2008-10-21.json +++ /dev/null @@ -1,6612 +0,0 @@ -{ - "smithy": "2.0", - "shapes": { - "com.amazonaws.tnb#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Insufficient permissions to make request.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.tnb#CancelSolNetworkOperation": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#CancelSolNetworkOperationInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Cancels a network 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": "Cancel a in-progress Sol Network Operation.", - "input": { - "nsLcmOpOccId": "no-0d5b823eb5c2a9241" - } - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/sol/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel", - "code": 202 - } - } - }, - "com.amazonaws.tnb#CancelSolNetworkOperationInput": { - "type": "structure", - "members": { - "nsLcmOpOccId": { - "target": "com.amazonaws.tnb#NsLcmOpOccId", - "traits": { - "smithy.api#documentation": "

The identifier of the network operation.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#CreateSolFunctionPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#CreateSolFunctionPackageInput" - }, - "output": { - "target": "com.amazonaws.tnb#CreateSolFunctionPackageOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "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\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", - "input": { - "tags": { - "Name": "Resource" - } - }, - "output": { - "onboardingState": "CREATED", - "operationalState": "DISABLED", - "usageState": "NOT_IN_USE", - "id": "fp-07aa863e53460a2a6", - "arn": "arn:aws:tnb:us-west-2:123456789000:function-package/fp-07aa863e53460a2a6", - "tags": { - "Name": "Resource" - } - } - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/sol/vnfpkgm/v1/vnf_packages", - "code": 201 - } - } - }, - "com.amazonaws.tnb#CreateSolFunctionPackageInput": { - "type": "structure", - "members": { - "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. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#CreateSolFunctionPackageOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

ID of the function package.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#VnfPkgArn", - "traits": { - "smithy.api#documentation": "

Function package ARN.

", - "smithy.api#required": {} - } - }, - "onboardingState": { - "target": "com.amazonaws.tnb#OnboardingState", - "traits": { - "smithy.api#documentation": "

Onboarding state of the function package.

", - "smithy.api#required": {} - } - }, - "operationalState": { - "target": "com.amazonaws.tnb#OperationalState", - "traits": { - "smithy.api#documentation": "

Operational state of the function package.

", - "smithy.api#required": {} - } - }, - "usageState": { - "target": "com.amazonaws.tnb#UsageState", - "traits": { - "smithy.api#documentation": "

Usage state of the function package.

", - "smithy.api#required": {} - } - }, - "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. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#CreateSolNetworkInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#CreateSolNetworkInstanceInput" - }, - "output": { - "target": "com.amazonaws.tnb#CreateSolNetworkInstanceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "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\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", - "input": { - "nsdInfoId": "np-0d5b823eb5c2a9241", - "nsName": "CITY Instance", - "nsDescription": "Test network for CITY", - "tags": { - "Name": "Resource" - } - }, - "output": { - "id": "ni-07aa863e53460a2a6", - "nsdInfoId": "np-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-instance/ni-07aa863e53460a2a6", - "nsInstanceName": "CITY Instance", - "tags": { - "Name": "Resource" - } - } - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/sol/nslcm/v1/ns_instances", - "code": 201 - } - } - }, - "com.amazonaws.tnb#CreateSolNetworkInstanceInput": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID for network service descriptor.

", - "smithy.api#required": {} - } - }, - "nsName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network instance name.

", - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#required": {} - } - }, - "nsDescription": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network instance description.

", - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "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. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#CreateSolNetworkInstanceOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

Network instance ID.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsInstanceArn", - "traits": { - "smithy.api#documentation": "

Network instance ARN.

", - "smithy.api#required": {} - } - }, - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

Network service descriptor ID.

", - "smithy.api#required": {} - } - }, - "nsInstanceName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network instance name.

", - "smithy.api#required": {} - } - }, - "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. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#CreateSolNetworkPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#CreateSolNetworkPackageInput" - }, - "output": { - "target": "com.amazonaws.tnb#CreateSolNetworkPackageOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "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\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", - "input": { - "tags": { - "Name": "Resource" - } - }, - "output": { - "id": "np-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241", - "nsdOnboardingState": "CREATED", - "nsdOperationalState": "DISABLED", - "nsdUsageState": "NOT_IN_USE", - "tags": { - "Name": "Resource" - } - } - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/sol/nsd/v1/ns_descriptors", - "code": 201 - } - } - }, - "com.amazonaws.tnb#CreateSolNetworkPackageInput": { - "type": "structure", - "members": { - "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. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#CreateSolNetworkPackageOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID of the network package.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsdInfoArn", - "traits": { - "smithy.api#documentation": "

Network package ARN.

", - "smithy.api#required": {} - } - }, - "nsdOnboardingState": { - "target": "com.amazonaws.tnb#NsdOnboardingState", - "traits": { - "smithy.api#documentation": "

Onboarding state of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - }, - "nsdOperationalState": { - "target": "com.amazonaws.tnb#NsdOperationalState", - "traits": { - "smithy.api#documentation": "

Operational state of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - }, - "nsdUsageState": { - "target": "com.amazonaws.tnb#NsdUsageState", - "traits": { - "smithy.api#documentation": "

Usage state of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - }, - "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. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#DeleteSolFunctionPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#DeleteSolFunctionPackageInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "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\n function package, see UpdateSolFunctionPackage.

", - "smithy.api#examples": [ - { - "title": "Delete a function package", - "input": { - "vnfPkgId": "fp-07aa863e53460a2a6" - } - } - ], - "smithy.api#http": { - "method": "DELETE", - "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}", - "code": 204 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.tnb#DeleteSolFunctionPackageInput": { - "type": "structure", - "members": { - "vnfPkgId": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

ID of the function package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#DeleteSolNetworkInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#DeleteSolNetworkInstanceInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "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\n terminate a network instance, see TerminateSolNetworkInstance.

", - "smithy.api#examples": [ - { - "title": "Delete a Sol Network Instance.", - "input": { - "nsInstanceId": "ni-07aa863e53460a2a6" - } - } - ], - "smithy.api#http": { - "method": "DELETE", - "uri": "/sol/nslcm/v1/ns_instances/{nsInstanceId}", - "code": 204 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.tnb#DeleteSolNetworkInstanceInput": { - "type": "structure", - "members": { - "nsInstanceId": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

Network instance ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#DeleteSolNetworkPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#DeleteSolNetworkPackageInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "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\n network package, see UpdateSolNetworkPackage.

", - "smithy.api#examples": [ - { - "title": "Delete a Sol network package", - "input": { - "nsdInfoId": "np-0d5b823eb5c2a9241" - } - } - ], - "smithy.api#http": { - "method": "DELETE", - "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}", - "code": 204 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.tnb#DeleteSolNetworkPackageInput": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID of the network service descriptor in the network package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#DescriptorContentType": { - "type": "enum", - "members": { - "TEXT_PLAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "text/plain" - } - } - } - }, - "com.amazonaws.tnb#ErrorCause": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.tnb#ErrorDetails": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 10240 - } - } - }, - "com.amazonaws.tnb#ErrorInfo": { - "type": "structure", - "members": { - "cause": { - "target": "com.amazonaws.tnb#ErrorCause", - "traits": { - "smithy.api#documentation": "

Error cause.

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

Error details.

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

Provides error information.

" - } - }, - "com.amazonaws.tnb#FunctionArtifactMeta": { - "type": "structure", - "members": { - "overrides": { - "target": "com.amazonaws.tnb#OverrideList", - "traits": { - "smithy.api#documentation": "

Lists of function package overrides.

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

Metadata for function package artifacts.

\n

Artifacts are the contents of the package descriptor file and the state of the package.

" - } - }, - "com.amazonaws.tnb#GetSolFunctionInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#GetSolFunctionInstanceInput" - }, - "output": { - "target": "com.amazonaws.tnb#GetSolFunctionInstanceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "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", - "input": { - "vnfInstanceId": "fi-b9439c34c1ef86c54" - }, - "output": { - "id": "fi-b9439c34c1ef86c54", - "arn": "arn:aws:tnb:us-west-2:123456789000:function-instance/fi-b9439c34c1ef86c54", - "nsInstanceId": "ni-07aa863e53460a2a6", - "vnfPkgId": "fp-07aa863e53460a2a6", - "vnfdId": "6625a858-2157-4d74-9197-a6ff67d51f3e", - "vnfProvider": "VNFBuilder", - "vnfProductName": "VNFBuilder-AMF", - "vnfdVersion": "1.0", - "instantiationState": "INSTANTIATED", - "instantiatedVnfInfo": { - "vnfState": "STARTED", - "vnfcResourceInfo": [ - { - "metadata": { - "cluster": "TestCluster", - "nodeGroup": "Core-EKS-TEST01-EKSNodeGroup-94BNRKWRV6MP", - "helmChart": "VnfHelmChart01" - } - } - ] - }, - "metadata": { - "createdAt": "2022-06-10T19:48:33Z", - "lastModified": "2022-06-10T19:48:33Z" - } - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/vnflcm/v1/vnf_instances/{vnfInstanceId}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionInstanceInput": { - "type": "structure", - "members": { - "vnfInstanceId": { - "target": "com.amazonaws.tnb#VnfInstanceId", - "traits": { - "smithy.api#documentation": "

ID of the network function.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionInstanceMetadata": { - "type": "structure", - "members": { - "createdAt": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

The metadata of a network function instance.

\n

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

" - } - }, - "com.amazonaws.tnb#GetSolFunctionInstanceOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#VnfInstanceId", - "traits": { - "smithy.api#documentation": "

Network function instance ID.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#VnfInstanceArn", - "traits": { - "smithy.api#documentation": "

Network function instance ARN.

", - "smithy.api#required": {} - } - }, - "nsInstanceId": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

Network instance ID.

", - "smithy.api#required": {} - } - }, - "vnfPkgId": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

Function package ID.

", - "smithy.api#required": {} - } - }, - "vnfdId": { - "target": "com.amazonaws.tnb#VnfdId", - "traits": { - "smithy.api#documentation": "

Function package descriptor ID.

", - "smithy.api#required": {} - } - }, - "vnfProvider": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network function provider.

" - } - }, - "vnfProductName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network function product name.

" - } - }, - "vnfdVersion": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Function package descriptor version.

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

Network function instantiation state.

", - "smithy.api#required": {} - } - }, - "instantiatedVnfInfo": { - "target": "com.amazonaws.tnb#GetSolVnfInfo" - }, - "metadata": { - "target": "com.amazonaws.tnb#GetSolFunctionInstanceMetadata", - "traits": { - "smithy.api#required": {} - } - }, - "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. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#GetSolFunctionPackageInput" - }, - "output": { - "target": "com.amazonaws.tnb#GetSolFunctionPackageOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "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", - "input": { - "vnfPkgId": "fp-07aa863e53460a2a6" - }, - "output": { - "id": "fp-07aa863e53460a2a6", - "arn": "arn:aws:tnb:us-west-2:123456789000:function-package/fp-07aa863e53460a2a6", - "onboardingState": "ONBOARDED", - "operationalState": "ENABLED", - "usageState": "IN_USE", - "vnfdId": "eefaac4a-cf5c-4b1f-869e-9d31a9fa6d71", - "vnfProvider": "VNFBuilder", - "vnfProductName": "NRF", - "vnfdVersion": "1.0.0", - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z", - "vnfd": { - "overrides": [] - } - } - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionPackageContent": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#GetSolFunctionPackageContentInput" - }, - "output": { - "target": "com.amazonaws.tnb#GetSolFunctionPackageContentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the contents of 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.

", - "smithy.api#examples": [ - { - "title": "Get the content of a function package", - "input": { - "accept": "application/zip", - "vnfPkgId": "fp-07aa863e53460a2a6" - }, - "output": { - "contentType": "application/zip", - "packageContent": "dGVzdCBjb250ZW50IGhlcmU=" - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionPackageContentInput": { - "type": "structure", - "members": { - "vnfPkgId": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

ID of the function package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "accept": { - "target": "com.amazonaws.tnb#PackageContentType", - "traits": { - "smithy.api#documentation": "

The format of the package that you want to download from the function packages.

", - "smithy.api#httpHeader": "Accept", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionPackageContentOutput": { - "type": "structure", - "members": { - "contentType": { - "target": "com.amazonaws.tnb#PackageContentType", - "traits": { - "smithy.api#documentation": "

Indicates the media type of the resource.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "packageContent": { - "target": "smithy.api#Blob", - "traits": { - "smithy.api#documentation": "

Contents of the function package.

", - "smithy.api#httpPayload": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionPackageDescriptor": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#GetSolFunctionPackageDescriptorInput" - }, - "output": { - "target": "com.amazonaws.tnb#GetSolFunctionPackageDescriptorOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets a function package descriptor in a function package.

\n

A function package descriptor is a .yaml file in a function package that uses the TOSCA standard to describe how the network function in the function package should run on your network.

\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": "Get the descriptor of a function package", - "input": { - "accept": "text/plain", - "vnfPkgId": "fp-07aa863e53460a2a6" - }, - "output": { - "contentType": "text/plain", - "vnfd": "dGVzdCBjb250ZW50IGhlcmU=" - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionPackageDescriptorInput": { - "type": "structure", - "members": { - "vnfPkgId": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

ID of the function package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "accept": { - "target": "com.amazonaws.tnb#DescriptorContentType", - "traits": { - "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": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionPackageDescriptorOutput": { - "type": "structure", - "members": { - "contentType": { - "target": "com.amazonaws.tnb#DescriptorContentType", - "traits": { - "smithy.api#documentation": "

Indicates the media type of the resource.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "vnfd": { - "target": "smithy.api#Blob", - "traits": { - "smithy.api#documentation": "

Contents of the function package descriptor.

", - "smithy.api#httpPayload": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionPackageInput": { - "type": "structure", - "members": { - "vnfPkgId": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

ID of the function package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionPackageMetadata": { - "type": "structure", - "members": { - "vnfd": { - "target": "com.amazonaws.tnb#FunctionArtifactMeta", - "traits": { - "smithy.api#documentation": "

Metadata related to the function package descriptor of the function package.

" - } - }, - "createdAt": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata related to the 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.

" - } - }, - "com.amazonaws.tnb#GetSolFunctionPackageOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

Function package ID.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#VnfPkgArn", - "traits": { - "smithy.api#documentation": "

Function package ARN.

", - "smithy.api#required": {} - } - }, - "onboardingState": { - "target": "com.amazonaws.tnb#OnboardingState", - "traits": { - "smithy.api#documentation": "

Function package onboarding state.

", - "smithy.api#required": {} - } - }, - "operationalState": { - "target": "com.amazonaws.tnb#OperationalState", - "traits": { - "smithy.api#documentation": "

Function package operational state.

", - "smithy.api#required": {} - } - }, - "usageState": { - "target": "com.amazonaws.tnb#UsageState", - "traits": { - "smithy.api#documentation": "

Function package usage state.

", - "smithy.api#required": {} - } - }, - "vnfdId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Function package descriptor ID.

" - } - }, - "vnfProvider": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network function provider.

" - } - }, - "vnfProductName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network function product name.

" - } - }, - "vnfdVersion": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Function package descriptor version.

" - } - }, - "metadata": { - "target": "com.amazonaws.tnb#GetSolFunctionPackageMetadata" - }, - "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. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#GetSolInstantiatedVnfInfo": { - "type": "structure", - "members": { - "vnfState": { - "target": "com.amazonaws.tnb#VnfOperationalState", - "traits": { - "smithy.api#documentation": "

State of the network function.

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

Information about 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#GetSolNetworkInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#GetSolNetworkInstanceInput" - }, - "output": { - "target": "com.amazonaws.tnb#GetSolNetworkInstanceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the details of the 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#examples": [ - { - "title": "Get a Sol Network Instance details", - "input": { - "nsInstanceId": "ni-07aa863e53460a2a6" - }, - "output": { - "id": "ni-07aa863e53460a2a6", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-instance/ni-07aa863e53460a2a6", - "nsInstanceName": "CITY Instance", - "nsInstanceDescription": "Network service for CITY", - "nsdId": "6625a858-2157-4d74-9197-a6ff67d51f3e", - "nsdInfoId": "np-07aa863e53460a2a6", - "nsState": "INSTANTIATED", - "metadata": { - "createdAt": "2022-06-10T19:48:33Z", - "lastModified": "2022-06-10T19:48:33Z" - }, - "lcmOpInfo": { - "nsLcmOpOccId": "no-0d5b823eb5c2a9241" - } - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/nslcm/v1/ns_instances/{nsInstanceId}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkInstanceInput": { - "type": "structure", - "members": { - "nsInstanceId": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

ID of the network instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkInstanceMetadata": { - "type": "structure", - "members": { - "createdAt": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

The metadata of 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.

" - } - }, - "com.amazonaws.tnb#GetSolNetworkInstanceOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

Network instance ID.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsInstanceArn", - "traits": { - "smithy.api#documentation": "

Network instance ARN.

", - "smithy.api#required": {} - } - }, - "nsInstanceName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network instance name.

", - "smithy.api#required": {} - } - }, - "nsInstanceDescription": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network instance description.

", - "smithy.api#required": {} - } - }, - "nsdId": { - "target": "com.amazonaws.tnb#NsdId", - "traits": { - "smithy.api#documentation": "

Network service descriptor ID.

", - "smithy.api#required": {} - } - }, - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

Network service descriptor info ID.

", - "smithy.api#required": {} - } - }, - "nsState": { - "target": "com.amazonaws.tnb#NsState", - "traits": { - "smithy.api#documentation": "

Network instance state.

" - } - }, - "lcmOpInfo": { - "target": "com.amazonaws.tnb#LcmOperationInfo" - }, - "metadata": { - "target": "com.amazonaws.tnb#GetSolNetworkInstanceMetadata", - "traits": { - "smithy.api#required": {} - } - }, - "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. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkOperation": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#GetSolNetworkOperationInput" - }, - "output": { - "target": "com.amazonaws.tnb#GetSolNetworkOperationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "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", - "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": "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" - }, - "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 Instantiate operation which has a failure", - "input": { - "nsLcmOpOccId": "no-0d5b823eb5c2a9241" - }, - "output": { - "id": "no-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "operationState": "FAILED", - "lcmOperationType": "INSTANTIATE", - "error": { - "title": "InternalServerException", - "detail": "The service encountered an error. Sorry for the inconvenience." - }, - "metadata": { - "createdAt": "2022-06-10T19:48:33Z", - "lastModified": "2022-06-10T19: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" - }, - { - "taskName": "HookExecution", - "taskErrorDetails": { - "cause": "InternalServerException", - "details": "The service encountered an error. Sorry for the inconvenience." - }, - "taskStatus": "ERROR", - "taskStartTime": "2022-06-10T19:48:34Z", - "taskEndTime": "2022-06-10T21:48:33Z" - } - ] - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkOperationInput": { - "type": "structure", - "members": { - "nsLcmOpOccId": { - "target": "com.amazonaws.tnb#NsLcmOpOccId", - "traits": { - "smithy.api#documentation": "

The identifier of the network operation.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "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": { - "smithy.api#documentation": "

The date that the resource was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata related to a network operation occurrence.

\n

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

" - } - }, - "com.amazonaws.tnb#GetSolNetworkOperationOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsLcmOpOccId", - "traits": { - "smithy.api#documentation": "

ID of this network operation occurrence.

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

Network operation ARN.

", - "smithy.api#required": {} - } - }, - "operationState": { - "target": "com.amazonaws.tnb#NsLcmOperationState", - "traits": { - "smithy.api#documentation": "

The state of the network operation.

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

ID of the network operation instance.

" - } - }, - "lcmOperationType": { - "target": "com.amazonaws.tnb#LcmOperationType", - "traits": { - "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": { - "smithy.api#documentation": "

Error related to this specific network operation occurrence.

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

Metadata of this network operation occurrence.

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

All tasks associated with this operation occurrence.

" - } - }, - "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. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkOperationTaskDetails": { - "type": "structure", - "members": { - "taskName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Task name.

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

Context for the network operation task.

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

Task error details.

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

Task status.

" - } - }, - "taskStartTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

Task start time.

", - "smithy.api#timestampFormat": "date-time" - } - }, - "taskEndTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

Task end time.

", - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

Gets the details of a network operation.

\n

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

" - } - }, - "com.amazonaws.tnb#GetSolNetworkOperationTasksList": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#GetSolNetworkOperationTaskDetails" - } - }, - "com.amazonaws.tnb#GetSolNetworkPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#GetSolNetworkPackageInput" - }, - "output": { - "target": "com.amazonaws.tnb#GetSolNetworkPackageOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the details of 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.

", - "smithy.api#examples": [ - { - "title": "Describe an individual Sol network package", - "input": { - "nsdInfoId": "np-0d5b823eb5c2a9241" - }, - "output": { - "id": "np-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241", - "nsdId": "be1abe66-1fcc-11ec-9621-0242ac130002", - "nsdName": "Sample-City", - "nsdVersion": "1.0", - "vnfPkgIds": [ - "fp-0b627c4a170a97f79", - "fp-8c253b2e898d23f92" - ], - "nsdOnboardingState": "ONBOARDED", - "nsdOperationalState": "ENABLED", - "nsdUsageState": "IN_USE", - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z", - "nsd": { - "overrides": [ - { - "name": "cidr_block", - "defaultValue": "10.0.0.0/24" - }, - { - "name": "some_vnf.vnf_prop" - } - ] - } - } - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkPackageContent": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#GetSolNetworkPackageContentInput" - }, - "output": { - "target": "com.amazonaws.tnb#GetSolNetworkPackageContentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the contents of 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.

", - "smithy.api#examples": [ - { - "title": "Get a network package Content", - "input": { - "accept": "application/zip", - "nsdInfoId": "np-0d5b823eb5c2a9241" - }, - "output": { - "contentType": "application/zip", - "nsdContent": "dGVzdCBjb250ZW50IGhlcmU=" - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkPackageContentInput": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID of the network service descriptor in the network package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "accept": { - "target": "com.amazonaws.tnb#PackageContentType", - "traits": { - "smithy.api#documentation": "

The format of the package you want to download from the network package.

", - "smithy.api#httpHeader": "Accept", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkPackageContentOutput": { - "type": "structure", - "members": { - "contentType": { - "target": "com.amazonaws.tnb#PackageContentType", - "traits": { - "smithy.api#documentation": "

Indicates the media type of the resource.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "nsdContent": { - "target": "smithy.api#Blob", - "traits": { - "smithy.api#documentation": "

Content of the network service descriptor in the network package.

", - "smithy.api#httpPayload": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkPackageDescriptor": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#GetSolNetworkPackageDescriptorInput" - }, - "output": { - "target": "com.amazonaws.tnb#GetSolNetworkPackageDescriptorOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the content of the network service descriptor.

\n

A network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.

", - "smithy.api#examples": [ - { - "title": "Get the descriptor of a Network Pacakge", - "input": { - "nsdInfoId": "np-0d5b823eb5c2a9241" - }, - "output": { - "contentType": "text/plain", - "nsd": "dGVzdCBjb250ZW50IGhlcmU=" - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}/nsd" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkPackageDescriptorInput": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID of the network service descriptor in the network package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkPackageDescriptorOutput": { - "type": "structure", - "members": { - "contentType": { - "target": "com.amazonaws.tnb#DescriptorContentType", - "traits": { - "smithy.api#documentation": "

Indicates the media type of the resource.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "nsd": { - "target": "smithy.api#Blob", - "traits": { - "smithy.api#documentation": "

Contents of the network service descriptor in the network package.

", - "smithy.api#httpPayload": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkPackageInput": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID of the network service descriptor in the network package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkPackageMetadata": { - "type": "structure", - "members": { - "nsd": { - "target": "com.amazonaws.tnb#NetworkArtifactMeta", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "createdAt": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata associated with 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.

" - } - }, - "com.amazonaws.tnb#GetSolNetworkPackageOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

Network package ID.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsdInfoArn", - "traits": { - "smithy.api#documentation": "

Network package ARN.

", - "smithy.api#required": {} - } - }, - "nsdOnboardingState": { - "target": "com.amazonaws.tnb#NsdOnboardingState", - "traits": { - "smithy.api#documentation": "

Network service descriptor onboarding state.

", - "smithy.api#required": {} - } - }, - "nsdOperationalState": { - "target": "com.amazonaws.tnb#NsdOperationalState", - "traits": { - "smithy.api#documentation": "

Network service descriptor operational state.

", - "smithy.api#required": {} - } - }, - "nsdUsageState": { - "target": "com.amazonaws.tnb#NsdUsageState", - "traits": { - "smithy.api#documentation": "

Network service descriptor usage state.

", - "smithy.api#required": {} - } - }, - "nsdId": { - "target": "com.amazonaws.tnb#NsdId", - "traits": { - "smithy.api#documentation": "

Network service descriptor ID.

", - "smithy.api#required": {} - } - }, - "nsdName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network service descriptor name.

", - "smithy.api#required": {} - } - }, - "nsdVersion": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network service descriptor version.

", - "smithy.api#required": {} - } - }, - "vnfPkgIds": { - "target": "com.amazonaws.tnb#VnfPkgIdList", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "metadata": { - "target": "com.amazonaws.tnb#GetSolNetworkPackageMetadata", - "traits": { - "smithy.api#required": {} - } - }, - "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. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#GetSolVnfInfo": { - "type": "structure", - "members": { - "vnfState": { - "target": "com.amazonaws.tnb#VnfOperationalState", - "traits": { - "smithy.api#documentation": "

State of the network function instance.

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

Compute info used by the network function instance.

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

Information about the network function.

\n

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

" - } - }, - "com.amazonaws.tnb#GetSolVnfcResourceInfo": { - "type": "structure", - "members": { - "metadata": { - "target": "com.amazonaws.tnb#GetSolVnfcResourceInfoMetadata", - "traits": { - "smithy.api#documentation": "

The metadata of the network function compute.

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

Details of resource associated with 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#GetSolVnfcResourceInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#GetSolVnfcResourceInfo" - } - }, - "com.amazonaws.tnb#GetSolVnfcResourceInfoMetadata": { - "type": "structure", - "members": { - "nodeGroup": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Information about the node group.

" - } - }, - "cluster": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Information about the cluster.

" - } - }, - "helmChart": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Information about the helm chart.

" - } - } - }, - "traits": { - "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": { - "target": "com.amazonaws.tnb#InstantiateSolNetworkInstanceInput" - }, - "output": { - "target": "com.amazonaws.tnb#InstantiateSolNetworkInstanceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "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.\n For more information, see CreateSolNetworkInstance.

", - "smithy.api#examples": [ - { - "title": "Instantiate a Sol Network Instance", - "input": { - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "tags": { - "Name": "Resource" - } - }, - "output": { - "nsLcmOpOccId": "no-0d5b823eb5c2a9241", - "tags": { - "Name": "Resource" - } - } - }, - { - "title": "Instantiate a Sol Network Instance with Overrides", - "input": { - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "additionalParamsForNs": { - "cidr_block": "10.0.0.0/16", - "availability_zone": "us-west-2a" - } - }, - "output": { - "nsLcmOpOccId": "no-0d5b823eb5c2a9241" - } - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/sol/nslcm/v1/ns_instances/{nsInstanceId}/instantiate", - "code": 201 - } - } - }, - "com.amazonaws.tnb#InstantiateSolNetworkInstanceInput": { - "type": "structure", - "members": { - "nsInstanceId": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

ID of the network instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dryRun": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#httpQuery": "dry_run" - } - }, - "additionalParamsForNs": { - "target": "smithy.api#Document", - "traits": { - "smithy.api#documentation": "

Provides values for the configurable properties.

" - } - }, - "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 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.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#InstantiateSolNetworkInstanceOutput": { - "type": "structure", - "members": { - "nsLcmOpOccId": { - "target": "com.amazonaws.tnb#NsLcmOpOccId", - "traits": { - "smithy.api#documentation": "

The identifier of the network operation.

", - "smithy.api#required": {} - } - }, - "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 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.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Unexpected error occurred. Problem on the server.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.tnb#LcmOperationInfo": { - "type": "structure", - "members": { - "nsLcmOpOccId": { - "target": "com.amazonaws.tnb#NsLcmOpOccId", - "traits": { - "smithy.api#documentation": "

The identifier of the network operation.

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

Lifecycle management operation details on the network instance.

\n

Lifecycle management operations are deploy, update, or delete operations.

" - } - }, - "com.amazonaws.tnb#LcmOperationType": { - "type": "enum", - "members": { - "INSTANTIATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSTANTIATE" - } - }, - "UPDATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE" - } - }, - "TERMINATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TERMINATE" - } - } - } - }, - "com.amazonaws.tnb#ListSolFunctionInstanceInfo": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#VnfInstanceId", - "traits": { - "smithy.api#documentation": "

Network function instance ID.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#VnfInstanceArn", - "traits": { - "smithy.api#documentation": "

Network function instance ARN.

", - "smithy.api#required": {} - } - }, - "nsInstanceId": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

Network instance ID.

", - "smithy.api#required": {} - } - }, - "vnfPkgId": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

Function package ID.

", - "smithy.api#required": {} - } - }, - "vnfPkgName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Function package name.

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

Network function instance instantiation state.

", - "smithy.api#required": {} - } - }, - "instantiatedVnfInfo": { - "target": "com.amazonaws.tnb#GetSolInstantiatedVnfInfo" - }, - "metadata": { - "target": "com.amazonaws.tnb#ListSolFunctionInstanceMetadata", - "traits": { - "smithy.api#documentation": "

Network function instance metadata.

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

Lists information about a network function instance.

\n

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

" - } - }, - "com.amazonaws.tnb#ListSolFunctionInstanceMetadata": { - "type": "structure", - "members": { - "createdAt": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

When the network function instance was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

When the network function instance was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

Lists network function instance metadata.

\n

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

" - } - }, - "com.amazonaws.tnb#ListSolFunctionInstanceResources": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#ListSolFunctionInstanceInfo" - } - }, - "com.amazonaws.tnb#ListSolFunctionInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#ListSolFunctionInstancesInput" - }, - "output": { - "target": "com.amazonaws.tnb#ListSolFunctionInstancesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists network function instances.

\n

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

", - "smithy.api#examples": [ - { - "title": "List Sol Function instances", - "input": {}, - "output": { - "functionInstances": [ - { - "id": "fi-b9439c34c1ef86c54", - "arn": "arn:aws:tnb:us-west-2:123456789000:function-instance/fi-b9439c34c1ef86c54", - "nsInstanceId": "ni-07aa863e53460a2a6", - "vnfPkgId": "fp-07aa863e53460a2a6", - "instantiationState": "INSTANTIATED", - "instantiatedVnfInfo": { - "vnfState": "STARTED" - }, - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - }, - { - "id": "fi-b9439c34c1efabcd1", - "arn": "arn:aws:tnb:us-west-2:123456789000:function-instance/fi-b9439c34c1efabcd1", - "nsInstanceId": "ni-07aa863e53460a123", - "vnfPkgId": "fp-146a863e53460a2a6", - "instantiationState": "INSTANTIATED", - "instantiatedVnfInfo": { - "vnfState": "STOPPED" - }, - "metadata": { - "createdAt": "2022-06-10T11:48:34Z", - "lastModified": "2023-06-28T21:48:33Z" - } - } - ] - } - }, - { - "title": "List Sol Function Instances with nextToken and maxResults", - "input": { - "maxResults": 25, - "nextToken": "" - }, - "output": { - "functionInstances": [ - { - "id": "fi-b9439c34c1ef86c54", - "arn": "arn:aws:tnb:us-west-2:123456789000:function-instance/fi-b9439c34c1ef86c54", - "nsInstanceId": "ni-07aa863e53460a2a6", - "vnfPkgId": "fp-07aa863e53460a2a6", - "instantiationState": "INSTANTIATED", - "instantiatedVnfInfo": { - "vnfState": "STARTED" - }, - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - } - ] - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/vnflcm/v1/vnf_instances" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "functionInstances" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#ListSolFunctionInstancesInput": { - "type": "structure", - "members": { - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response.

", - "smithy.api#httpQuery": "max_results", - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextpage_opaque_marker" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#ListSolFunctionInstancesOutput": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

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

Network function instances.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ListSolFunctionPackageInfo": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

ID of the function package.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#VnfPkgArn", - "traits": { - "smithy.api#documentation": "

Function package ARN.

", - "smithy.api#required": {} - } - }, - "onboardingState": { - "target": "com.amazonaws.tnb#OnboardingState", - "traits": { - "smithy.api#documentation": "

Onboarding state of the function package.

", - "smithy.api#required": {} - } - }, - "operationalState": { - "target": "com.amazonaws.tnb#OperationalState", - "traits": { - "smithy.api#documentation": "

Operational state of the function package.

", - "smithy.api#required": {} - } - }, - "usageState": { - "target": "com.amazonaws.tnb#UsageState", - "traits": { - "smithy.api#documentation": "

Usage state of the function package.

", - "smithy.api#required": {} - } - }, - "vnfdId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Identifies the function package and the function package descriptor.

" - } - }, - "vnfProvider": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Provider of the function package and the function package descriptor.

" - } - }, - "vnfProductName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The product name for the network function.

" - } - }, - "vnfdVersion": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Identifies the version of the function package descriptor.

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

The metadata of the function package.

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

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

" - } - }, - "com.amazonaws.tnb#ListSolFunctionPackageMetadata": { - "type": "structure", - "members": { - "createdAt": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details for the function package metadata.

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

" - } - }, - "com.amazonaws.tnb#ListSolFunctionPackageResources": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#ListSolFunctionPackageInfo" - } - }, - "com.amazonaws.tnb#ListSolFunctionPackages": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#ListSolFunctionPackagesInput" - }, - "output": { - "target": "com.amazonaws.tnb#ListSolFunctionPackagesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists information about function packages.

\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": "List information about multiple function packages without PaginationToken", - "input": { - "maxResults": 25, - "nextToken": "" - }, - "output": { - "nextToken": "ug2E9SheCpyAmeLItmHF99a8GNI6yAHxXIvgBkdiA2ixKvqdhYpNBLWHDl6vGnWt7Y4CB6m1Dkz86gSwcDouMO1pSrN%2BlGY2kbNtfTeMgnuB6bmwP/UU12r7MkHQyPCWMYG8OuCXkDBOYeX8qjRDTJ5vxAyrwtynaB6XDNDZA2DscCjcD7kpNzf3xlPRCwd6", - "functionPackages": [ - { - "id": "fp-07aa863e53460a2a6", - "arn": "arn:aws:tnb:us-west-2:123456789000:function-package/fp-07aa863e53460a2a6", - "onboardingState": "ONBOARDED", - "operationalState": "ENABLED", - "usageState": "IN_USE", - "vnfdId": "arn:aws:tnb:123456789000:vnf/nrf", - "vnfProvider": "VNFBuilder", - "vnfProductName": "NRF", - "vnfdVersion": "1.0", - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - } - ] - } - }, - { - "title": "List information about multiple function packages with PaginationToken", - "input": { - "maxResults": 25, - "nextToken": "ug2E9SheCpyAmeLItmHF99a8GNI6yAHxXIvgBkdiA2ixKvqdhYpNBLWHDl6vGnWt7Y4CB6m1Dkz86gSwcDouMO1pSrN%2BlGY2kbNtfTeMgnuB6bmwP/UU12r7MkHQyPCWMYG8OuCXkDBOYeX8qjRDTJ5vxAyrwtynaB6XDNDZA2DscCjcD7kpNzf3xlPRCwd6" - }, - "output": { - "nextToken": "ug2E9SheCpyAmeLItmHF98uvZTosFhZ1wyglENkc3UZ12UuRLmtGtojRynFjRR5zW%2FycBL6QX8AU%2B1IRWL%2BVjNNL7KBiaD87KM9WcUMQzryLtOazGHexujJncJJ0YGsxSLSrmPGx7dM1EoNKX8oxYA%3D%3D", - "functionPackages": [ - { - "id": "fp-07aa863e53460a2a6", - "arn": "arn:aws:tnb:us-west-2:123456789000:function-package/fp-07aa863e53460a2a6", - "onboardingState": "ONBOARDED", - "operationalState": "ENABLED", - "usageState": "IN_USE", - "vnfdId": "arn:aws:tnb:123456789000:vnf/nrf", - "vnfProvider": "VNFBuilder", - "vnfProductName": "NRF", - "vnfdVersion": "1.0", - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - } - ] - } - }, - { - "title": "No more function packages to return", - "input": { - "maxResults": 25, - "nextToken": "ug2E9SheCpyAmeLItmHF98uvZTosFhZ1wyglENkc3UZ12UuRLmtGtojRynFjRR5zW%2FycBL6QX8AU%2B1IRWL%2BVjNNL7KBiaD87KM9WcUMQzryLtOazGHexujJncJJ0YGsxSLSrmPGx7dM1EoNKX8oxYA%3D%3D" - }, - "output": { - "functionPackages": [] - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/vnfpkgm/v1/vnf_packages" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "functionPackages" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#ListSolFunctionPackagesInput": { - "type": "structure", - "members": { - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response.

", - "smithy.api#httpQuery": "max_results", - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextpage_opaque_marker" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#ListSolFunctionPackagesOutput": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

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

Function packages. 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#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ListSolNetworkInstanceInfo": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

ID of the network instance.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsInstanceArn", - "traits": { - "smithy.api#documentation": "

Network instance ARN.

", - "smithy.api#required": {} - } - }, - "nsInstanceName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Human-readable name of the network instance.

", - "smithy.api#required": {} - } - }, - "nsInstanceDescription": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Human-readable description of the network instance.

", - "smithy.api#required": {} - } - }, - "nsdId": { - "target": "com.amazonaws.tnb#NsdId", - "traits": { - "smithy.api#documentation": "

ID of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - }, - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - }, - "nsState": { - "target": "com.amazonaws.tnb#NsState", - "traits": { - "smithy.api#documentation": "

The state of the network instance.

", - "smithy.api#required": {} - } - }, - "metadata": { - "target": "com.amazonaws.tnb#ListSolNetworkInstanceMetadata", - "traits": { - "smithy.api#documentation": "

The metadata of the network instance.

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

Info about the specific 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.

" - } - }, - "com.amazonaws.tnb#ListSolNetworkInstanceMetadata": { - "type": "structure", - "members": { - "createdAt": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata details for 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.

" - } - }, - "com.amazonaws.tnb#ListSolNetworkInstanceResources": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#ListSolNetworkInstanceInfo" - } - }, - "com.amazonaws.tnb#ListSolNetworkInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#ListSolNetworkInstancesInput" - }, - "output": { - "target": "com.amazonaws.tnb#ListSolNetworkInstancesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists your network instances.

\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#examples": [ - { - "title": "List Sol Network Instantiate instances", - "input": {}, - "output": { - "networkInstances": [ - { - "id": "ni-07aa863e53460a2a6", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-instance/ni-07aa863e53460a2a6", - "nsInstanceName": "CITY Instance", - "nsInstanceDescription": "Network service for CITY", - "nsdId": "e851fd14-abe3-4535-85e6-6060636fd519", - "nsdInfoId": "np-0d5b823eb5c2a9241", - "nsState": "INSTANTIATED", - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - } - ] - } - }, - { - "title": "List Sol Network Instances with nextToken and maxResults", - "input": { - "maxResults": 25, - "nextToken": "" - }, - "output": { - "networkInstances": [ - { - "id": "ni-07aa863e53460a2a6", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-instance/ni-07aa863e53460a2a6", - "nsInstanceName": "CITY Instance", - "nsInstanceDescription": "Network service for CITY", - "nsdId": "e851fd14-abe3-4535-85e6-6060636fd519", - "nsdInfoId": "np-0d5b823eb5c2a9241", - "nsState": "INSTANTIATED", - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - } - ] - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/nslcm/v1/ns_instances" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "networkInstances" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#ListSolNetworkInstancesInput": { - "type": "structure", - "members": { - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response.

", - "smithy.api#httpQuery": "max_results", - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextpage_opaque_marker" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#ListSolNetworkInstancesOutput": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

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

Lists network instances.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ListSolNetworkOperations": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#ListSolNetworkOperationsInput" - }, - "output": { - "target": "com.amazonaws.tnb#ListSolNetworkOperationsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "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", - "input": {}, - "output": { - "networkOperations": [ - { - "id": "no-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "operationState": "COMPLETED", - "lcmOperationType": "INSTANTIATE", - "metadata": { - "nsdInfoId": "np-0d0f3e2eae4fc1ac1", - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - } - ] - } - }, - { - "title": "List Sol Network Instantiate operations with nextToken and maxResults", - "input": { - "maxResults": 25, - "nextToken": "" - }, - "output": { - "networkOperations": [ - { - "id": "no-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "operationState": "COMPLETED", - "lcmOperationType": "INSTANTIATE", - "error": { - "title": "InsufficientInstanceCapacity", - "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": { - "method": "GET", - "uri": "/sol/nslcm/v1/ns_lcm_op_occs" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "networkOperations" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#ListSolNetworkOperationsInfo": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsLcmOpOccId", - "traits": { - "smithy.api#documentation": "

ID of this network operation.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsLcmOpOccArn", - "traits": { - "smithy.api#documentation": "

Network operation ARN.

", - "smithy.api#required": {} - } - }, - "operationState": { - "target": "com.amazonaws.tnb#NsLcmOperationState", - "traits": { - "smithy.api#documentation": "

The state of the network operation.

", - "smithy.api#required": {} - } - }, - "nsInstanceId": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

ID of the network instance related to this operation.

", - "smithy.api#required": {} - } - }, - "lcmOperationType": { - "target": "com.amazonaws.tnb#LcmOperationType", - "traits": { - "smithy.api#documentation": "

Type of lifecycle management network operation.

", - "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": { - "smithy.api#documentation": "

Error related to this specific network operation.

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

Metadata related to this network operation.

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

Information parameters for a network operation.

" - } - }, - "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": { - "smithy.api#documentation": "

The maximum number of results to include in the response.

", - "smithy.api#httpQuery": "max_results", - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextpage_opaque_marker" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "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": { - "smithy.api#documentation": "

The date that the resource was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata related to a network operation.

\n

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

" - } - }, - "com.amazonaws.tnb#ListSolNetworkOperationsOutput": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

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

Lists network operation occurrences. Lifecycle management operations are deploy, update, or delete operations.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ListSolNetworkOperationsResources": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#ListSolNetworkOperationsInfo" - } - }, - "com.amazonaws.tnb#ListSolNetworkPackageInfo": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID of the individual network package.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsdInfoArn", - "traits": { - "smithy.api#documentation": "

Network package ARN.

", - "smithy.api#required": {} - } - }, - "nsdOnboardingState": { - "target": "com.amazonaws.tnb#NsdOnboardingState", - "traits": { - "smithy.api#documentation": "

Onboarding state of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - }, - "nsdOperationalState": { - "target": "com.amazonaws.tnb#NsdOperationalState", - "traits": { - "smithy.api#documentation": "

Operational state of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - }, - "nsdUsageState": { - "target": "com.amazonaws.tnb#NsdUsageState", - "traits": { - "smithy.api#documentation": "

Usage state of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - }, - "nsdId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

ID of the network service descriptor on which the network package is based.

" - } - }, - "nsdName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Name of the onboarded network service descriptor in the network package.

" - } - }, - "nsdVersion": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Version of the onboarded network service descriptor in the network package.

" - } - }, - "nsdDesigner": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Designer of the onboarded network service descriptor in the network package.

" - } - }, - "nsdInvariantId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Identifies a network service descriptor in a version independent manner.

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

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

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

The metadata of the network package.

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

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

" - } - }, - "com.amazonaws.tnb#ListSolNetworkPackageMetadata": { - "type": "structure", - "members": { - "createdAt": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata related to 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.

" - } - }, - "com.amazonaws.tnb#ListSolNetworkPackageResources": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#ListSolNetworkPackageInfo" - } - }, - "com.amazonaws.tnb#ListSolNetworkPackages": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#ListSolNetworkPackagesInput" - }, - "output": { - "target": "com.amazonaws.tnb#ListSolNetworkPackagesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists network packages.

\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": "List information about multiple network packages without PaginationToken", - "input": { - "maxResults": 25, - "nextToken": "" - }, - "output": { - "nextToken": "ug2E9SheCpyAmeLItmHF99a8GNI6yAHxXIvgBkdiA2ixKvqdhYpNBLWHDl6vGnWt7Y4CB6m1Dkz86gSwcDouMO1pSrN%2BlGY2kbNtfTeMgnuB6bmwP/UU12r7MkHQyPCWMYG8OuCXkDBOYeX8qjRDTJ5vxAyrwtynaB6XDNDZA2DscCjcD7kpNzf3xlPRCwd6", - "networkPackages": [ - { - "id": "np-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241", - "nsdId": "be1abe66-1fcc-11ec-9621-0242ac130002", - "nsdName": "Sample-City", - "nsdVersion": "1.0", - "nsdDesigner": "Sample", - "nsdInvariantId": "SAMPLE_CITY", - "vnfPkgIds": [ - "fp-0b627c4a170a97f79", - "fp-09a2ba09fad0212cd" - ], - "nsdOnboardingState": "ONBOARDED", - "nsdOperationalState": "ENABLED", - "nsdUsageState": "IN_USE", - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - }, - { - "id": "np-0d5b823eb5c2a9789", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9789", - "nsdOnboardingState": "CREATED", - "nsdOperationalState": "DISABLED", - "nsdUsageState": "NOT_IN_USE", - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - } - ] - } - }, - { - "title": "List information about multiple network packages with PaginationToken", - "input": { - "maxResults": 25, - "nextToken": "ug2E9SheCpyAmeLItmHF95t1rBBsFyzy5hsuauDTqaukll3AGHaTz%2B4utHS3OMuMcyKW6Hmk25aB6wtV%2BFxCx9Adw5fDSq9D8lVa6sr0Sq0BF7Fj0mYegd0a/XiFP4j/58ZIrtRl0M3Z55Z/wTqwIietXJVfFX84ZnIMjiEiFb3KIIdrKS8vSgMZ18t3Gj5p" - }, - "output": { - "nextToken": "ug2E9SheCpyAmeLItmHF93AYTN36C2xOijk0IW9FbkywwkM3QphGA%2BMbsKhEhOl3nacLxMMiBL9WOhOdo/ZCXfmS2/tHpzuWjvSODvivIJONDw3bUxYqjsT2w/lDWekKm9cRGhLaK6kCr1XBvm3USj/r6dBDL3gHYrwfmEGL7MRffCgc2IqYOL6O2Mhvbn89", - "networkPackages": [ - { - "id": "np-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241", - "nsdId": "be1abe66-1fcc-11ec-9621-0242ac130002", - "nsdName": "Sample-City", - "nsdVersion": "1.0", - "nsdDesigner": "Sample", - "nsdInvariantId": "SAMPLE_CITY", - "vnfPkgIds": [ - "fp-0b627c4a170a97f79", - "fp-09a2ba09fad0212cd" - ], - "nsdOnboardingState": "ONBOARDED", - "nsdOperationalState": "ENABLED", - "nsdUsageState": "IN_USE", - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - } - ] - } - }, - { - "title": "No more network packages to return", - "input": {}, - "output": { - "networkPackages": [] - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/nsd/v1/ns_descriptors" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "networkPackages" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#ListSolNetworkPackagesInput": { - "type": "structure", - "members": { - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response.

", - "smithy.api#httpQuery": "max_results", - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextpage_opaque_marker" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#ListSolNetworkPackagesOutput": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

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

Network packages. 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#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#ListTagsForResourceInput" - }, - "output": { - "target": "com.amazonaws.tnb#ListTagsForResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists tags for AWS TNB resources.

", - "smithy.api#http": { - "uri": "/tags/{resourceArn}", - "method": "GET" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#ListTagsForResourceInput": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.tnb#TNBResourceArn", - "traits": { - "smithy.api#documentation": "

Resource ARN.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#ListTagsForResourceOutput": { - "type": "structure", - "members": { - "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. You can use tags to search and filter your resources or track your Amazon Web Services costs.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "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": { - "overrides": { - "target": "com.amazonaws.tnb#OverrideList", - "traits": { - "smithy.api#documentation": "

Lists network package overrides.

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

Metadata for network package artifacts.

\n

Artifacts are the contents of the package descriptor file and the state of the package.

" - } - }, - "com.amazonaws.tnb#NsInstanceArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(network-instance/ni-[a-f0-9]{17})$" - } - }, - "com.amazonaws.tnb#NsInstanceId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^ni-[a-f0-9]{17}$" - } - }, - "com.amazonaws.tnb#NsLcmOpOccArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(network-operation/no-[a-f0-9]{17})$" - } - }, - "com.amazonaws.tnb#NsLcmOpOccId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^no-[a-f0-9]{17}$" - } - }, - "com.amazonaws.tnb#NsLcmOperationState": { - "type": "enum", - "members": { - "PROCESSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROCESSING" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "CANCELLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLING" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - } - } - }, - "com.amazonaws.tnb#NsState": { - "type": "enum", - "members": { - "INSTANTIATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSTANTIATED" - } - }, - "NOT_INSTANTIATED": { - "target": "smithy.api#Unit", - "traits": { - "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": { - "smithy.api#enumValue": "STOPPED" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "INSTANTIATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "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": { - "smithy.api#enumValue": "UPDATE_IN_PROGRESS" - } - }, - "TERMINATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TERMINATE_IN_PROGRESS" - } - } - } - }, - "com.amazonaws.tnb#NsdId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - } - }, - "com.amazonaws.tnb#NsdInfoArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(network-package/np-[a-f0-9]{17})$" - } - }, - "com.amazonaws.tnb#NsdInfoId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^np-[a-f0-9]{17}$" - } - }, - "com.amazonaws.tnb#NsdOnboardingState": { - "type": "enum", - "members": { - "CREATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATED" - } - }, - "ONBOARDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ONBOARDED" - } - }, - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ERROR" - } - } - } - }, - "com.amazonaws.tnb#NsdOperationalState": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.tnb#NsdUsageState": { - "type": "enum", - "members": { - "IN_USE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_USE" - } - }, - "NOT_IN_USE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_IN_USE" - } - } - } - }, - "com.amazonaws.tnb#OnboardingState": { - "type": "enum", - "members": { - "CREATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATED" - } - }, - "ONBOARDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ONBOARDED" - } - }, - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ERROR" - } - } - } - }, - "com.amazonaws.tnb#OperationalState": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.tnb#OverrideList": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#ToscaOverride" - } - }, - "com.amazonaws.tnb#PackageContentType": { - "type": "enum", - "members": { - "APPLICATION_ZIP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "application/zip" - } - } - } - }, - "com.amazonaws.tnb#PaginationToken": { - "type": "string" - }, - "com.amazonaws.tnb#ProblemDetails": { - "type": "structure", - "members": { - "detail": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

A human-readable explanation specific to this occurrence of the problem.

", - "smithy.api#required": {} - } - }, - "title": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

A human-readable title of the problem type.

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

Details related to problems with AWS TNB resources.

" - } - }, - "com.amazonaws.tnb#PutSolFunctionPackageContent": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#PutSolFunctionPackageContentInput" - }, - "output": { - "target": "com.amazonaws.tnb#PutSolFunctionPackageContentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Uploads the contents of 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.

", - "smithy.api#examples": [ - { - "title": "Upload a function package content", - "input": { - "vnfPkgId": "fp-07aa863e53460a2a6", - "contentType": "application/zip", - "file": "UEsDBBQAAAAAAPqLiVMAAAAAAAAAAAAAAAAMACAAZnJlZTVnYy1hbWYvVVQNAAcIrrJhBK" - }, - "output": { - "id": "fp-07aa863e53460a2a6", - "vnfdId": "0d72acd9-e45d-4644-9bcd-1fe67cd0e2c8", - "vnfProductName": "Sample AMF", - "vnfProvider": "Sample", - "vnfdVersion": "1.0.0", - "metadata": { - "vnfd": { - "overrides": [] - } - } - } - } - ], - "smithy.api#http": { - "method": "PUT", - "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content", - "code": 202 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.tnb#PutSolFunctionPackageContentInput": { - "type": "structure", - "members": { - "vnfPkgId": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

Function package ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "contentType": { - "target": "com.amazonaws.tnb#PackageContentType", - "traits": { - "smithy.api#documentation": "

Function package content type.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "file": { - "target": "com.amazonaws.tnb#SensitiveBlob", - "traits": { - "smithy.api#documentation": "

Function package file.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#PutSolFunctionPackageContentMetadata": { - "type": "structure", - "members": { - "vnfd": { - "target": "com.amazonaws.tnb#FunctionArtifactMeta" - } - }, - "traits": { - "smithy.api#documentation": "

Update metadata in 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.

" - } - }, - "com.amazonaws.tnb#PutSolFunctionPackageContentOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

Function package ID.

", - "smithy.api#required": {} - } - }, - "vnfdId": { - "target": "com.amazonaws.tnb#VnfdId", - "traits": { - "smithy.api#documentation": "

Function package descriptor ID.

", - "smithy.api#required": {} - } - }, - "vnfProductName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Function product name.

", - "smithy.api#required": {} - } - }, - "vnfProvider": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Function provider.

", - "smithy.api#required": {} - } - }, - "vnfdVersion": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Function package descriptor version.

", - "smithy.api#required": {} - } - }, - "metadata": { - "target": "com.amazonaws.tnb#PutSolFunctionPackageContentMetadata", - "traits": { - "smithy.api#documentation": "

Function package metadata.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#PutSolNetworkPackageContent": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#PutSolNetworkPackageContentInput" - }, - "output": { - "target": "com.amazonaws.tnb#PutSolNetworkPackageContentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Uploads the contents of 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.

", - "smithy.api#examples": [ - { - "title": "Upload the network package content of an NSD archive", - "input": { - "nsdInfoId": "np-0d5b823eb5c2a9241", - "contentType": "application/zip", - "file": "UEsDBBQAAAAAAPqLiVMAAAAAAAAAAAAAA" - }, - "output": { - "id": "np-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241", - "nsdId": "0d72acd9-e45d-4644-9bcd-1fe67cd0e2c8", - "nsdName": "Sample Single Cluster", - "nsdVersion": "1.0.0", - "vnfPkgIds": [ - "fp-1234567890abcdabc", - "fp-0b627c4a170a97f79" - ], - "metadata": { - "nsd": { - "overrides": [ - { - "name": "cidr_block", - "defaultValue": "10.0.0.0/24" - }, - { - "name": "some_vnf.vnf_prop" - } - ] - } - } - } - } - ], - "smithy.api#http": { - "method": "PUT", - "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.tnb#PutSolNetworkPackageContentInput": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

Network service descriptor info ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "contentType": { - "target": "com.amazonaws.tnb#PackageContentType", - "traits": { - "smithy.api#documentation": "

Network package content type.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "file": { - "target": "com.amazonaws.tnb#SensitiveBlob", - "traits": { - "smithy.api#documentation": "

Network package file.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#PutSolNetworkPackageContentMetadata": { - "type": "structure", - "members": { - "nsd": { - "target": "com.amazonaws.tnb#NetworkArtifactMeta" - } - }, - "traits": { - "smithy.api#documentation": "

Update metadata in 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.

" - } - }, - "com.amazonaws.tnb#PutSolNetworkPackageContentOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

Network package ID.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsdInfoArn", - "traits": { - "smithy.api#documentation": "

Network package ARN.

", - "smithy.api#required": {} - } - }, - "nsdId": { - "target": "com.amazonaws.tnb#NsdId", - "traits": { - "smithy.api#documentation": "

Network service descriptor ID.

", - "smithy.api#required": {} - } - }, - "nsdName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network service descriptor name.

", - "smithy.api#required": {} - } - }, - "nsdVersion": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network service descriptor version.

", - "smithy.api#required": {} - } - }, - "vnfPkgIds": { - "target": "com.amazonaws.tnb#VnfPkgIdList", - "traits": { - "smithy.api#documentation": "

Function package IDs.

", - "smithy.api#required": {} - } - }, - "metadata": { - "target": "com.amazonaws.tnb#PutSolNetworkPackageContentMetadata", - "traits": { - "smithy.api#documentation": "

Network package metadata.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Request references a resource that doesn't exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.tnb#SensitiveBlob": { - "type": "blob", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.tnb#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Service quotas have been exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.tnb#StringMap": { - "type": "map", - "key": { - "target": "smithy.api#String" - }, - "value": { - "target": "smithy.api#String" - } - }, - "com.amazonaws.tnb#TNB": { - "type": "service", - "version": "2008-10-21", - "operations": [ - { - "target": "com.amazonaws.tnb#CancelSolNetworkOperation" - }, - { - "target": "com.amazonaws.tnb#CreateSolFunctionPackage" - }, - { - "target": "com.amazonaws.tnb#CreateSolNetworkInstance" - }, - { - "target": "com.amazonaws.tnb#CreateSolNetworkPackage" - }, - { - "target": "com.amazonaws.tnb#DeleteSolFunctionPackage" - }, - { - "target": "com.amazonaws.tnb#DeleteSolNetworkInstance" - }, - { - "target": "com.amazonaws.tnb#DeleteSolNetworkPackage" - }, - { - "target": "com.amazonaws.tnb#GetSolFunctionInstance" - }, - { - "target": "com.amazonaws.tnb#GetSolFunctionPackage" - }, - { - "target": "com.amazonaws.tnb#GetSolFunctionPackageContent" - }, - { - "target": "com.amazonaws.tnb#GetSolFunctionPackageDescriptor" - }, - { - "target": "com.amazonaws.tnb#GetSolNetworkInstance" - }, - { - "target": "com.amazonaws.tnb#GetSolNetworkOperation" - }, - { - "target": "com.amazonaws.tnb#GetSolNetworkPackage" - }, - { - "target": "com.amazonaws.tnb#GetSolNetworkPackageContent" - }, - { - "target": "com.amazonaws.tnb#GetSolNetworkPackageDescriptor" - }, - { - "target": "com.amazonaws.tnb#InstantiateSolNetworkInstance" - }, - { - "target": "com.amazonaws.tnb#ListSolFunctionInstances" - }, - { - "target": "com.amazonaws.tnb#ListSolFunctionPackages" - }, - { - "target": "com.amazonaws.tnb#ListSolNetworkInstances" - }, - { - "target": "com.amazonaws.tnb#ListSolNetworkOperations" - }, - { - "target": "com.amazonaws.tnb#ListSolNetworkPackages" - }, - { - "target": "com.amazonaws.tnb#ListTagsForResource" - }, - { - "target": "com.amazonaws.tnb#PutSolFunctionPackageContent" - }, - { - "target": "com.amazonaws.tnb#PutSolNetworkPackageContent" - }, - { - "target": "com.amazonaws.tnb#TagResource" - }, - { - "target": "com.amazonaws.tnb#TerminateSolNetworkInstance" - }, - { - "target": "com.amazonaws.tnb#UntagResource" - }, - { - "target": "com.amazonaws.tnb#UpdateSolFunctionPackage" - }, - { - "target": "com.amazonaws.tnb#UpdateSolNetworkInstance" - }, - { - "target": "com.amazonaws.tnb#UpdateSolNetworkPackage" - }, - { - "target": "com.amazonaws.tnb#ValidateSolFunctionPackageContent" - }, - { - "target": "com.amazonaws.tnb#ValidateSolNetworkPackageContent" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "tnb", - "apiVersion": "v1", - "arnNamespace": "tnb" - }, - "aws.auth#sigv4": { - "name": "tnb" - }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": { - "additionalAllowedHeaders": [ - "*", - "content-type", - "x-amz-content-sha256", - "x-amz-user-agent", - "x-amzn-platform-id", - "x-amzn-trace-id" - ], - "additionalExposedHeaders": [ - "x-amzn-errortype", - "x-amzn-requestid", - "x-amzn-trace-id" - ], - "maxAge": 86400 - }, - "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#endpointBdd": { - "version": "1.1", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "string" - } - }, - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - }, - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - }, - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "results": [ - { - "conditions": [], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://tnb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://tnb-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://tnb.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://tnb.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "root": 2, - "nodeCount": 13, - "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "string" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://tnb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://tnb-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://tnb.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://tnb.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "type": "tree" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://tnb-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://tnb.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://tnb-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://tnb.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://tnb-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://tnb.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.tnb#TNBResourceArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws:tnb:[a-z0-9-]+:[^:]*:.*$" - } - }, - "com.amazonaws.tnb#TagKey": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(?!aws:).{1,128}$" - } - }, - "com.amazonaws.tnb#TagKeys": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.tnb#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.tnb#TagKey" - }, - "value": { - "target": "com.amazonaws.tnb#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.tnb#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#TagResourceInput" - }, - "output": { - "target": "com.amazonaws.tnb#TagResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Tags an AWS TNB resource.

\n

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

", - "smithy.api#http": { - "uri": "/tags/{resourceArn}", - "method": "POST" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.tnb#TagResourceInput": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.tnb#TNBResourceArn", - "traits": { - "smithy.api#documentation": "

Resource ARN.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "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. You can use tags to search and filter your resources or track your Amazon Web Services costs.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#TagResourceOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.tnb#TaskStatus": { - "type": "enum", - "members": { - "SCHEDULED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCHEDULED" - } - }, - "STARTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTED" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ERROR" - } - }, - "SKIPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SKIPPED" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - } - } - }, - "com.amazonaws.tnb#TerminateSolNetworkInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#TerminateSolNetworkInstanceInput" - }, - "output": { - "target": "com.amazonaws.tnb#TerminateSolNetworkInstanceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Terminates 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

You must terminate a network instance before you can delete it.

", - "smithy.api#examples": [ - { - "title": "Terminate a Sol Network Instance", - "input": { - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "tags": { - "Name": "Resource" - } - }, - "output": { - "nsLcmOpOccId": "no-0d5b823eb5c2a9241", - "tags": { - "Name": "Resource" - } - } - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/sol/nslcm/v1/ns_instances/{nsInstanceId}/terminate", - "code": 201 - } - } - }, - "com.amazonaws.tnb#TerminateSolNetworkInstanceInput": { - "type": "structure", - "members": { - "nsInstanceId": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

ID of the network instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "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 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.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#TerminateSolNetworkInstanceOutput": { - "type": "structure", - "members": { - "nsLcmOpOccId": { - "target": "com.amazonaws.tnb#NsLcmOpOccId", - "traits": { - "smithy.api#documentation": "

The identifier of the network operation.

" - } - }, - "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 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.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Exception caused by throttling.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.tnb#ToscaOverride": { - "type": "structure", - "members": { - "name": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Name of the TOSCA override.

" - } - }, - "defaultValue": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Default value for the override.

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

Overrides of the TOSCA node.

" - } - }, - "com.amazonaws.tnb#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#UntagResourceInput" - }, - "output": { - "target": "com.amazonaws.tnb#UntagResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Untags an AWS TNB resource.

\n

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

", - "smithy.api#http": { - "uri": "/tags/{resourceArn}", - "method": "DELETE" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.tnb#UntagResourceInput": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.tnb#TNBResourceArn", - "traits": { - "smithy.api#documentation": "

Resource ARN.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.tnb#TagKeys", - "traits": { - "smithy.api#documentation": "

Tag keys.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#UntagResourceOutput": { - "type": "structure", - "members": {}, - "traits": { - "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": { - "target": "com.amazonaws.tnb#UpdateSolFunctionPackageInput" - }, - "output": { - "target": "com.amazonaws.tnb#UpdateSolFunctionPackageOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the operational state of 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.

", - "smithy.api#examples": [ - { - "title": "Enable a function package's Operational State", - "input": { - "vnfPkgId": "fp-07aa863e53460a2a6", - "operationalState": "ENABLED" - }, - "output": { - "operationalState": "ENABLED" - } - }, - { - "title": "Disable a function package's Operational State", - "input": { - "vnfPkgId": "fp-07aa863e53460a2a6", - "operationalState": "DISABLED" - }, - "output": { - "operationalState": "DISABLED" - } - } - ], - "smithy.api#http": { - "method": "PATCH", - "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}" - } - } - }, - "com.amazonaws.tnb#UpdateSolFunctionPackageInput": { - "type": "structure", - "members": { - "vnfPkgId": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

ID of the function package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "operationalState": { - "target": "com.amazonaws.tnb#OperationalState", - "traits": { - "smithy.api#documentation": "

Operational state of the function package.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#UpdateSolFunctionPackageOutput": { - "type": "structure", - "members": { - "operationalState": { - "target": "com.amazonaws.tnb#OperationalState", - "traits": { - "smithy.api#documentation": "

Operational state of the function package.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#UpdateSolNetworkInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#UpdateSolNetworkInstanceInput" - }, - "output": { - "target": "com.amazonaws.tnb#UpdateSolNetworkInstanceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "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.

\n

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

", - "smithy.api#examples": [ - { - "title": "Update a Sol Network Instance", - "input": { - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "updateType": "MODIFY_VNF_INFORMATION", - "modifyVnfInfoData": { - "vnfInstanceId": "fi-0d5b823eb5c2a9241", - "vnfConfigurableProperties": { - "pcf.port": "8080", - "pcf.pods": "10" - } - }, - "tags": { - "Name": "Resource" - } - }, - "output": { - "nsLcmOpOccId": "no-0d5b823eb5c2a9241", - "tags": { - "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": { - "method": "POST", - "uri": "/sol/nslcm/v1/ns_instances/{nsInstanceId}/update", - "code": 201 - } - } - }, - "com.amazonaws.tnb#UpdateSolNetworkInstanceInput": { - "type": "structure", - "members": { - "nsInstanceId": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

ID of the network instance.

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

The type of update.

\n ", - "smithy.api#required": {} - } - }, - "modifyVnfInfoData": { - "target": "com.amazonaws.tnb#UpdateSolNetworkModify", - "traits": { - "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 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.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#UpdateSolNetworkInstanceOutput": { - "type": "structure", - "members": { - "nsLcmOpOccId": { - "target": "com.amazonaws.tnb#NsLcmOpOccId", - "traits": { - "smithy.api#documentation": "

The identifier of the network operation.

" - } - }, - "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 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.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#UpdateSolNetworkModify": { - "type": "structure", - "members": { - "vnfInstanceId": { - "target": "com.amazonaws.tnb#VnfInstanceId", - "traits": { - "smithy.api#documentation": "

ID of the network function instance.

\n

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

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

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

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

Information parameters and/or the configurable properties for a network function.

\n

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

" - } - }, - "com.amazonaws.tnb#UpdateSolNetworkPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#UpdateSolNetworkPackageInput" - }, - "output": { - "target": "com.amazonaws.tnb#UpdateSolNetworkPackageOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the operational state of 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.

\n

A network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.

", - "smithy.api#examples": [ - { - "title": "Enable a network package's Operational State", - "input": { - "nsdInfoId": "np-0d5b823eb5c2a9241", - "nsdOperationalState": "ENABLED" - }, - "output": { - "nsdOperationalState": "ENABLED" - } - }, - { - "title": "Disable a network package's Operational State", - "input": { - "nsdInfoId": "np-0d5b823eb5c2a9241", - "nsdOperationalState": "DISABLED" - }, - "output": { - "nsdOperationalState": "DISABLED" - } - } - ], - "smithy.api#http": { - "method": "PATCH", - "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}" - } - } - }, - "com.amazonaws.tnb#UpdateSolNetworkPackageInput": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID of the network service descriptor in the network package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nsdOperationalState": { - "target": "com.amazonaws.tnb#NsdOperationalState", - "traits": { - "smithy.api#documentation": "

Operational state of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#UpdateSolNetworkPackageOutput": { - "type": "structure", - "members": { - "nsdOperationalState": { - "target": "com.amazonaws.tnb#NsdOperationalState", - "traits": { - "smithy.api#documentation": "

Operational state of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "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": { - "MODIFY_VNF_INFORMATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MODIFY_VNF_INFORMATION" - } - }, - "UPDATE_NS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_NS" - } - } - } - }, - "com.amazonaws.tnb#UsageState": { - "type": "enum", - "members": { - "IN_USE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_USE" - } - }, - "NOT_IN_USE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_IN_USE" - } - } - } - }, - "com.amazonaws.tnb#ValidateSolFunctionPackageContent": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#ValidateSolFunctionPackageContentInput" - }, - "output": { - "target": "com.amazonaws.tnb#ValidateSolFunctionPackageContentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "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", - "input": { - "vnfPkgId": "fp-07aa863e53460a2a6", - "contentType": "application/zip", - "file": "UEsDBBQAAAAAAPqLiVMAAAAAAAAAAAAAAAAMACAAZnJlZTVnYy1hbWYvVVQNAAcIrrJhBK" - }, - "output": { - "id": "fp-07aa863e53460a2a6", - "vnfdId": "0d72acd9-e45d-4644-9bcd-1fe67cd0e2c8", - "vnfProductName": "Sample AMF", - "vnfProvider": "Sample", - "vnfdVersion": "1.0.0", - "metadata": { - "vnfd": { - "overrides": [] - } - } - } - } - ], - "smithy.api#http": { - "method": "PUT", - "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content/validate", - "code": 202 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.tnb#ValidateSolFunctionPackageContentInput": { - "type": "structure", - "members": { - "vnfPkgId": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

Function package ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "contentType": { - "target": "com.amazonaws.tnb#PackageContentType", - "traits": { - "smithy.api#documentation": "

Function package content type.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "file": { - "target": "com.amazonaws.tnb#SensitiveBlob", - "traits": { - "smithy.api#documentation": "

Function package file.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#ValidateSolFunctionPackageContentMetadata": { - "type": "structure", - "members": { - "vnfd": { - "target": "com.amazonaws.tnb#FunctionArtifactMeta" - } - }, - "traits": { - "smithy.api#documentation": "

Validates function package content metadata.

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

" - } - }, - "com.amazonaws.tnb#ValidateSolFunctionPackageContentOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

Function package ID.

", - "smithy.api#required": {} - } - }, - "vnfdId": { - "target": "com.amazonaws.tnb#VnfdId", - "traits": { - "smithy.api#documentation": "

Function package descriptor ID.

", - "smithy.api#required": {} - } - }, - "vnfProductName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network function product name.

", - "smithy.api#required": {} - } - }, - "vnfProvider": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network function provider.

", - "smithy.api#required": {} - } - }, - "vnfdVersion": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Function package descriptor version.

", - "smithy.api#required": {} - } - }, - "metadata": { - "target": "com.amazonaws.tnb#ValidateSolFunctionPackageContentMetadata", - "traits": { - "smithy.api#documentation": "

Function package metadata.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ValidateSolNetworkPackageContent": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#ValidateSolNetworkPackageContentInput" - }, - "output": { - "target": "com.amazonaws.tnb#ValidateSolNetworkPackageContentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "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", - "input": { - "nsdInfoId": "np-0d5b823eb5c2a9241", - "contentType": "application/zip", - "file": "UEsDBBQAAAAAAPqLiVMAAAAAAAAAAAAAA" - }, - "output": { - "id": "np-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241", - "nsdId": "0d72acd9-e45d-4644-9bcd-1fe67cd0e2c8", - "nsdName": "Sample Single Cluster", - "nsdVersion": "1.0.0", - "vnfPkgIds": [ - "fp-1234567890abcdabc", - "fp-0b627c4a170a97f79" - ], - "metadata": { - "nsd": { - "overrides": [ - { - "name": "cidr_block", - "defaultValue": "10.0.0.0/24" - }, - { - "name": "some_vnf.vnf_prop" - } - ] - } - } - } - } - ], - "smithy.api#http": { - "method": "PUT", - "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content/validate", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.tnb#ValidateSolNetworkPackageContentInput": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

Network service descriptor file.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "contentType": { - "target": "com.amazonaws.tnb#PackageContentType", - "traits": { - "smithy.api#documentation": "

Network package content type.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "file": { - "target": "com.amazonaws.tnb#SensitiveBlob", - "traits": { - "smithy.api#documentation": "

Network package file.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#ValidateSolNetworkPackageContentMetadata": { - "type": "structure", - "members": { - "nsd": { - "target": "com.amazonaws.tnb#NetworkArtifactMeta" - } - }, - "traits": { - "smithy.api#documentation": "

Validates network package content metadata.

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

" - } - }, - "com.amazonaws.tnb#ValidateSolNetworkPackageContentOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

Network package ID.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsdInfoArn", - "traits": { - "smithy.api#documentation": "

Network package ARN.

", - "smithy.api#required": {} - } - }, - "nsdId": { - "target": "com.amazonaws.tnb#NsdId", - "traits": { - "smithy.api#documentation": "

Network service descriptor ID.

", - "smithy.api#required": {} - } - }, - "nsdName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network service descriptor name.

", - "smithy.api#required": {} - } - }, - "nsdVersion": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network service descriptor version.

", - "smithy.api#required": {} - } - }, - "vnfPkgIds": { - "target": "com.amazonaws.tnb#VnfPkgIdList", - "traits": { - "smithy.api#documentation": "

Function package IDs.

", - "smithy.api#required": {} - } - }, - "metadata": { - "target": "com.amazonaws.tnb#ValidateSolNetworkPackageContentMetadata", - "traits": { - "smithy.api#documentation": "

Network package metadata.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "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 - } - }, - "com.amazonaws.tnb#VnfInstanceArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(function-instance/fi-[a-f0-9]{17})$" - } - }, - "com.amazonaws.tnb#VnfInstanceId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^fi-[a-f0-9]{17}$" - } - }, - "com.amazonaws.tnb#VnfInstantiationState": { - "type": "enum", - "members": { - "INSTANTIATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSTANTIATED" - } - }, - "NOT_INSTANTIATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_INSTANTIATED" - } - } - } - }, - "com.amazonaws.tnb#VnfOperationalState": { - "type": "enum", - "members": { - "STARTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTED" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - } - } - }, - "com.amazonaws.tnb#VnfPkgArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(function-package/fp-[a-f0-9]{17})$" - } - }, - "com.amazonaws.tnb#VnfPkgId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^fp-[a-f0-9]{17}$" - } - }, - "com.amazonaws.tnb#VnfPkgIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#VnfPkgId" - } - }, - "com.amazonaws.tnb#VnfdId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - } - } - } -} \ No newline at end of file