|
45 | 45 | {"shape":"ValidationException"},
|
46 | 46 | {"shape":"AccessDeniedException"}
|
47 | 47 | ],
|
48 |
| - "documentation":"<p>Creates a function package.</p> <p>A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. For more information, see <a href=\"https://docs.aws.amazon.com/tnb/latest/ug/function-packages.html\">Function packages</a> in the <i>Amazon Web Services Telco Network Builder User Guide</i>. </p> <p>Creating a function package is the first step for creating a network in AWS TNB. This request creates an empty container with an ID. The next step is to upload the actual CSAR zip file into that empty container. To upload function package content, see <a href=\"https://docs.aws.amazon.com/TNB/latest/APIReference/API_PutSolFunctionPackageContent.html\">PutSolFunctionPackageContent</a>.</p>" |
| 48 | + "documentation":"<p>Creates a function package.</p> <p>A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. For more information, see <a href=\"https://docs.aws.amazon.com/tnb/latest/ug/function-packages.html\">Function packages</a> in the <i>Amazon Web Services Telco Network Builder User Guide</i>. </p> <p>Creating a function package is the first step for creating a network in AWS TNB. This request creates an empty container with an ID. The next step is to upload the actual CSAR zip file into that empty container. To upload function package content, see <a href=\"https://docs.aws.amazon.com/tnb/latest/APIReference/API_PutSolFunctionPackageContent.html\">PutSolFunctionPackageContent</a>.</p>" |
49 | 49 | },
|
50 | 50 | "CreateSolNetworkInstance":{
|
51 | 51 | "name":"CreateSolNetworkInstance",
|
|
64 | 64 | {"shape":"ResourceNotFoundException"},
|
65 | 65 | {"shape":"AccessDeniedException"}
|
66 | 66 | ],
|
67 |
| - "documentation":"<p>Creates a network instance.</p> <p>A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Creating a network instance is the third step after creating a network package. For more information about network instances, <a href=\"https://docs.aws.amazon.com/tnb/latest/ug/network-instances.html\">Network instances</a> in the <i>Amazon Web Services Telco Network Builder User Guide</i>.</p> <p>Once you create a network instance, you can instantiate it. To instantiate a network, see <a href=\"https://docs.aws.amazon.com/TNB/latest/APIReference/API_InstantiateSolNetworkInstance.html\">InstantiateSolNetworkInstance</a>.</p>" |
| 67 | + "documentation":"<p>Creates a network instance.</p> <p>A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Creating a network instance is the third step after creating a network package. For more information about network instances, <a href=\"https://docs.aws.amazon.com/tnb/latest/ug/network-instances.html\">Network instances</a> in the <i>Amazon Web Services Telco Network Builder User Guide</i>.</p> <p>Once you create a network instance, you can instantiate it. To instantiate a network, see <a href=\"https://docs.aws.amazon.com/tnb/latest/APIReference/API_InstantiateSolNetworkInstance.html\">InstantiateSolNetworkInstance</a>.</p>" |
68 | 68 | },
|
69 | 69 | "CreateSolNetworkPackage":{
|
70 | 70 | "name":"CreateSolNetworkPackage",
|
|
82 | 82 | {"shape":"ValidationException"},
|
83 | 83 | {"shape":"AccessDeniedException"}
|
84 | 84 | ],
|
85 |
| - "documentation":"<p>Creates a network package.</p> <p>A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. For more information, see <a href=\"https://docs.aws.amazon.com/tnb/latest/ug/network-instances.html\">Network instances</a> in the <i>Amazon Web Services Telco Network Builder User Guide</i>. </p> <p>A network package consists of a network service descriptor (NSD) file (required) and any additional files (optional), such as scripts specific to your needs. For example, if you have multiple function packages in your network package, you can use the NSD to define which network functions should run in certain VPCs, subnets, or EKS clusters.</p> <p>This request creates an empty network package container with an ID. Once you create a network package, you can upload the network package content using <a href=\"https://docs.aws.amazon.com/TNB/latest/APIReference/API_PutSolNetworkPackageContent.html\">PutSolNetworkPackageContent</a>.</p>" |
| 85 | + "documentation":"<p>Creates a network package.</p> <p>A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. For more information, see <a href=\"https://docs.aws.amazon.com/tnb/latest/ug/network-instances.html\">Network instances</a> in the <i>Amazon Web Services Telco Network Builder User Guide</i>. </p> <p>A network package consists of a network service descriptor (NSD) file (required) and any additional files (optional), such as scripts specific to your needs. For example, if you have multiple function packages in your network package, you can use the NSD to define which network functions should run in certain VPCs, subnets, or EKS clusters.</p> <p>This request creates an empty network package container with an ID. Once you create a network package, you can upload the network package content using <a href=\"https://docs.aws.amazon.com/tnb/latest/APIReference/API_PutSolNetworkPackageContent.html\">PutSolNetworkPackageContent</a>.</p>" |
86 | 86 | },
|
87 | 87 | "DeleteSolFunctionPackage":{
|
88 | 88 | "name":"DeleteSolFunctionPackage",
|
|
99 | 99 | {"shape":"ResourceNotFoundException"},
|
100 | 100 | {"shape":"AccessDeniedException"}
|
101 | 101 | ],
|
102 |
| - "documentation":"<p>Deletes a function package.</p> <p>A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.</p> <p>To delete a function package, the package must be in a disabled state. To disable a function package, see <a href=\"https://docs.aws.amazon.com/TNB/latest/APIReference/API_UpdateSolFunctionPackage.html\">UpdateSolFunctionPackage</a>. </p>", |
| 102 | + "documentation":"<p>Deletes a function package.</p> <p>A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.</p> <p>To delete a function package, the package must be in a disabled state. To disable a function package, see <a href=\"https://docs.aws.amazon.com/tnb/latest/APIReference/API_UpdateSolFunctionPackage.html\">UpdateSolFunctionPackage</a>. </p>", |
103 | 103 | "idempotent":true
|
104 | 104 | },
|
105 | 105 | "DeleteSolNetworkInstance":{
|
|
117 | 117 | {"shape":"ResourceNotFoundException"},
|
118 | 118 | {"shape":"AccessDeniedException"}
|
119 | 119 | ],
|
120 |
| - "documentation":"<p>Deletes a network instance.</p> <p>A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.</p> <p>To delete a network instance, the instance must be in a stopped or terminated state. To terminate a network instance, see <a href=\"https://docs.aws.amazon.com/TNB/latest/APIReference/API_TerminateSolNetworkInstance.html\">TerminateSolNetworkInstance</a>.</p>", |
| 120 | + "documentation":"<p>Deletes a network instance.</p> <p>A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.</p> <p>To delete a network instance, the instance must be in a stopped or terminated state. To terminate a network instance, see <a href=\"https://docs.aws.amazon.com/tnb/latest/APIReference/API_TerminateSolNetworkInstance.html\">TerminateSolNetworkInstance</a>.</p>", |
121 | 121 | "idempotent":true
|
122 | 122 | },
|
123 | 123 | "DeleteSolNetworkPackage":{
|
|
135 | 135 | {"shape":"ResourceNotFoundException"},
|
136 | 136 | {"shape":"AccessDeniedException"}
|
137 | 137 | ],
|
138 |
| - "documentation":"<p>Deletes network package.</p> <p>A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.</p> <p>To delete a network package, the package must be in a disable state. To disable a network package, see <a href=\"https://docs.aws.amazon.com/TNB/latest/APIReference/API_UpdateSolNetworkPackage.html\">UpdateSolNetworkPackage</a>.</p>", |
| 138 | + "documentation":"<p>Deletes network package.</p> <p>A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.</p> <p>To delete a network package, the package must be in a disable state. To disable a network package, see <a href=\"https://docs.aws.amazon.com/tnb/latest/APIReference/API_UpdateSolNetworkPackage.html\">UpdateSolNetworkPackage</a>.</p>", |
139 | 139 | "idempotent":true
|
140 | 140 | },
|
141 | 141 | "GetSolFunctionInstance":{
|
|
317 | 317 | {"shape":"ResourceNotFoundException"},
|
318 | 318 | {"shape":"AccessDeniedException"}
|
319 | 319 | ],
|
320 |
| - "documentation":"<p>Instantiates a network instance.</p> <p>A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.</p> <p>Before you can instantiate a network instance, you have to create a network instance. For more information, see <a href=\"https://docs.aws.amazon.com/TNB/latest/APIReference/API_CreateSolNetworkInstance.html\">CreateSolNetworkInstance</a>.</p>" |
| 320 | + "documentation":"<p>Instantiates a network instance.</p> <p>A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.</p> <p>Before you can instantiate a network instance, you have to create a network instance. For more information, see <a href=\"https://docs.aws.amazon.com/tnb/latest/APIReference/API_CreateSolNetworkInstance.html\">CreateSolNetworkInstance</a>.</p>" |
321 | 321 | },
|
322 | 322 | "ListSolFunctionInstances":{
|
323 | 323 | "name":"ListSolFunctionInstances",
|
|
588 | 588 | {"shape":"ResourceNotFoundException"},
|
589 | 589 | {"shape":"AccessDeniedException"}
|
590 | 590 | ],
|
591 |
| - "documentation":"<p>Validates function package content. This can be used as a dry run before uploading function package content with <a href=\"https://docs.aws.amazon.com/TNB/latest/APIReference/API_PutSolFunctionPackageContent.html\">PutSolFunctionPackageContent</a>.</p> <p>A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.</p>", |
| 591 | + "documentation":"<p>Validates function package content. This can be used as a dry run before uploading function package content with <a href=\"https://docs.aws.amazon.com/tnb/latest/APIReference/API_PutSolFunctionPackageContent.html\">PutSolFunctionPackageContent</a>.</p> <p>A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.</p>", |
592 | 592 | "idempotent":true
|
593 | 593 | },
|
594 | 594 | "ValidateSolNetworkPackageContent":{
|
|
607 | 607 | {"shape":"ResourceNotFoundException"},
|
608 | 608 | {"shape":"AccessDeniedException"}
|
609 | 609 | ],
|
610 |
| - "documentation":"<p>Validates network package content. This can be used as a dry run before uploading network package content with <a href=\"https://docs.aws.amazon.com/TNB/latest/APIReference/API_PutSolNetworkPackageContent.html\">PutSolNetworkPackageContent</a>.</p> <p>A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.</p>", |
| 610 | + "documentation":"<p>Validates network package content. This can be used as a dry run before uploading network package content with <a href=\"https://docs.aws.amazon.com/tnb/latest/APIReference/API_PutSolNetworkPackageContent.html\">PutSolNetworkPackageContent</a>.</p> <p>A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.</p>", |
611 | 611 | "idempotent":true
|
612 | 612 | }
|
613 | 613 | },
|
|
636 | 636 | "members":{
|
637 | 637 | "nsLcmOpOccId":{
|
638 | 638 | "shape":"NsLcmOpOccId",
|
639 |
| - "documentation":"<p>The ID of a network operation occurrence.</p>", |
| 639 | + "documentation":"<p>The identifier of the network operation.</p>", |
640 | 640 | "location":"uri",
|
641 | 641 | "locationName":"nsLcmOpOccId"
|
642 | 642 | }
|
|
714 | 714 | },
|
715 | 715 | "CreateSolNetworkInstanceInputNsDescriptionString":{
|
716 | 716 | "type":"string",
|
717 |
| - "max":124, |
718 |
| - "min":1 |
| 717 | + "max":255, |
| 718 | + "min":0 |
719 | 719 | },
|
720 | 720 | "CreateSolNetworkInstanceInputNsNameString":{
|
721 | 721 | "type":"string",
|
722 |
| - "max":80, |
| 722 | + "max":100, |
723 | 723 | "min":1
|
724 | 724 | },
|
725 | 725 | "CreateSolNetworkInstanceOutput":{
|
|
1219 | 1219 | "members":{
|
1220 | 1220 | "nsLcmOpOccId":{
|
1221 | 1221 | "shape":"NsLcmOpOccId",
|
1222 |
| - "documentation":"<p>The identifier of the operation occurrence.</p>", |
| 1222 | + "documentation":"<p>The identifier of the network operation.</p>", |
1223 | 1223 | "location":"uri",
|
1224 | 1224 | "locationName":"nsLcmOpOccId"
|
1225 | 1225 | }
|
|
1241 | 1241 | "documentation":"<p>The date that the resource was last modified.</p>"
|
1242 | 1242 | }
|
1243 | 1243 | },
|
1244 |
| - "documentation":"<p>Metadata related to a network operation occurence.</p> <p>A network operation is any operation that is done to your network, such as network instance instantiation or termination.</p>" |
| 1244 | + "documentation":"<p>Metadata related to a network operation occurrence.</p> <p>A network operation is any operation that is done to your network, such as network instance instantiation or termination.</p>" |
1245 | 1245 | },
|
1246 | 1246 | "GetSolNetworkOperationOutput":{
|
1247 | 1247 | "type":"structure",
|
|
1253 | 1253 | },
|
1254 | 1254 | "error":{
|
1255 | 1255 | "shape":"ProblemDetails",
|
1256 |
| - "documentation":"<p>Error related to this specific network operation occurence.</p>" |
| 1256 | + "documentation":"<p>Error related to this specific network operation occurrence.</p>" |
1257 | 1257 | },
|
1258 | 1258 | "id":{
|
1259 | 1259 | "shape":"NsLcmOpOccId",
|
|
1541 | 1541 | "documentation":"<p>ID of the network instance.</p>",
|
1542 | 1542 | "location":"uri",
|
1543 | 1543 | "locationName":"nsInstanceId"
|
| 1544 | + }, |
| 1545 | + "tags":{ |
| 1546 | + "shape":"TagMap", |
| 1547 | + "documentation":"<p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.</p>" |
1544 | 1548 | }
|
1545 | 1549 | }
|
1546 | 1550 | },
|
|
1550 | 1554 | "members":{
|
1551 | 1555 | "nsLcmOpOccId":{
|
1552 | 1556 | "shape":"NsLcmOpOccId",
|
1553 |
| - "documentation":"<p>The identifier of the network instance.</p>" |
| 1557 | + "documentation":"<p>The identifier of the network operation.</p>" |
| 1558 | + }, |
| 1559 | + "tags":{ |
| 1560 | + "shape":"TagMap", |
| 1561 | + "documentation":"<p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.</p>" |
1554 | 1562 | }
|
1555 | 1563 | }
|
1556 | 1564 | },
|
|
1571 | 1579 | "members":{
|
1572 | 1580 | "nsLcmOpOccId":{
|
1573 | 1581 | "shape":"NsLcmOpOccId",
|
1574 |
| - "documentation":"<p>The identifier of the latest network lifecycle management operation occurrence.</p>" |
| 1582 | + "documentation":"<p>The identifier of the network operation.</p>" |
1575 | 1583 | }
|
1576 | 1584 | },
|
1577 | 1585 | "documentation":"<p>Lifecycle management operation details on the network instance.</p> <p>Lifecycle management operations are deploy, update, or delete operations.</p>"
|
|
2520 | 2528 | "documentation":"<p>ID of the network instance.</p>",
|
2521 | 2529 | "location":"uri",
|
2522 | 2530 | "locationName":"nsInstanceId"
|
| 2531 | + }, |
| 2532 | + "tags":{ |
| 2533 | + "shape":"TagMap", |
| 2534 | + "documentation":"<p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.</p>" |
2523 | 2535 | }
|
2524 | 2536 | }
|
2525 | 2537 | },
|
|
2528 | 2540 | "members":{
|
2529 | 2541 | "nsLcmOpOccId":{
|
2530 | 2542 | "shape":"NsLcmOpOccId",
|
2531 |
| - "documentation":"<p>The identifier of the operation occurrence.</p>" |
| 2543 | + "documentation":"<p>The identifier of the network operation.</p>" |
| 2544 | + }, |
| 2545 | + "tags":{ |
| 2546 | + "shape":"TagMap", |
| 2547 | + "documentation":"<p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.</p>" |
2532 | 2548 | }
|
2533 | 2549 | }
|
2534 | 2550 | },
|
|
2631 | 2647 | "location":"uri",
|
2632 | 2648 | "locationName":"nsInstanceId"
|
2633 | 2649 | },
|
| 2650 | + "tags":{ |
| 2651 | + "shape":"TagMap", |
| 2652 | + "documentation":"<p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.</p>" |
| 2653 | + }, |
2634 | 2654 | "updateType":{
|
2635 | 2655 | "shape":"UpdateSolNetworkType",
|
2636 | 2656 | "documentation":"<p>The type of update.</p>"
|
|
2642 | 2662 | "members":{
|
2643 | 2663 | "nsLcmOpOccId":{
|
2644 | 2664 | "shape":"NsLcmOpOccId",
|
2645 |
| - "documentation":"<p>The identifier of the network instance operation occurrence.</p>" |
| 2665 | + "documentation":"<p>The identifier of the network operation.</p>" |
| 2666 | + }, |
| 2667 | + "tags":{ |
| 2668 | + "shape":"TagMap", |
| 2669 | + "documentation":"<p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.</p>" |
2646 | 2670 | }
|
2647 | 2671 | }
|
2648 | 2672 | },
|
|
0 commit comments