id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
tnb-api-001
|
tnb-api.pdf
| 1 |
API Reference AWS Telco Network Builder API Version 2008-10-21 Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS Telco Network Builder API Reference AWS Telco Network Builder: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS Telco Network Builder Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 CancelSolNetworkOperation ...................................................................................................................... 4 Request Syntax ........................................................................................................................................ 4 URI Request Parameters ........................................................................................................................ 4 Request Body ........................................................................................................................................... 4 Response Syntax ...................................................................................................................................... 4 Response Elements ................................................................................................................................. 4 Errors .......................................................................................................................................................... 4 See Also ..................................................................................................................................................... 5 CreateSolFunctionPackage .......................................................................................................................... 7 Request Syntax ........................................................................................................................................ 7 URI Request Parameters ........................................................................................................................ 7 Request Body ........................................................................................................................................... 7 Response Syntax ...................................................................................................................................... 8 Response Elements ................................................................................................................................. 8 Errors .......................................................................................................................................................... 9 See Also .................................................................................................................................................. 10 CreateSolNetworkInstance ....................................................................................................................... 12 Request Syntax ...................................................................................................................................... 12 URI Request Parameters ...................................................................................................................... 12 Request Body ......................................................................................................................................... 12 Response Syntax ................................................................................................................................... 13 Response Elements ............................................................................................................................... 14 Errors ....................................................................................................................................................... 15 See Also .................................................................................................................................................. 16 CreateSolNetworkPackage ........................................................................................................................ 17 Request Syntax ...................................................................................................................................... 17 URI Request Parameters ...................................................................................................................... 17 Request Body ......................................................................................................................................... 17 Response Syntax ................................................................................................................................... 18 Response Elements ............................................................................................................................... 18 Errors ....................................................................................................................................................... 19 See Also .................................................................................................................................................. 20 API Version 2008-10-21 iii AWS Telco Network Builder API Reference DeleteSolFunctionPackage ....................................................................................................................... 22 Request Syntax ...................................................................................................................................... 22 URI Request Parameters ...................................................................................................................... 22 Request Body ......................................................................................................................................... 22 Response Syntax ................................................................................................................................... 22 Response Elements ............................................................................................................................... 22 Errors ....................................................................................................................................................... 23 See Also .................................................................................................................................................. 23 DeleteSolNetworkInstance ....................................................................................................................... 25 Request Syntax ...................................................................................................................................... 25 URI Request Parameters ...................................................................................................................... 25 Request Body ......................................................................................................................................... 25 Response Syntax ................................................................................................................................... 25 Response Elements ............................................................................................................................... 25 Errors ....................................................................................................................................................... 26 See Also .................................................................................................................................................. 26 DeleteSolNetworkPackage ....................................................................................................................... 28 Request Syntax ...................................................................................................................................... 28 URI Request Parameters ...................................................................................................................... 28 Request Body ......................................................................................................................................... 28 Response Syntax ................................................................................................................................... 28 Response Elements ............................................................................................................................... 28 Errors ....................................................................................................................................................... 29 See Also .................................................................................................................................................. 29 GetSolFunctionInstance ............................................................................................................................ 31 Request Syntax ...................................................................................................................................... 31 URI Request Parameters ...................................................................................................................... 31 Request Body ......................................................................................................................................... 31 Response Syntax ................................................................................................................................... 31 Response Elements ............................................................................................................................... 32 Errors ....................................................................................................................................................... 34 See Also .................................................................................................................................................. 35 GetSolFunctionPackage ............................................................................................................................. 36 Request Syntax ...................................................................................................................................... 36 URI Request Parameters ...................................................................................................................... 36 Request Body ......................................................................................................................................... 36 API Version 2008-10-21 iv AWS Telco Network Builder API Reference Response Syntax ................................................................................................................................... 36 Response Elements ............................................................................................................................... 37 Errors ....................................................................................................................................................... 39 See Also .................................................................................................................................................. 40 GetSolFunctionPackageContent .............................................................................................................. 41 Request Syntax ...................................................................................................................................... 41 URI Request Parameters ...................................................................................................................... 41 Request Body ......................................................................................................................................... 41 Response Syntax ................................................................................................................................... 41 Response Elements ............................................................................................................................... 42 Errors ....................................................................................................................................................... 42 See Also .................................................................................................................................................. 43 GetSolFunctionPackageDescriptor .......................................................................................................... 44 Request Syntax ...................................................................................................................................... 44 URI Request Parameters ...................................................................................................................... 44 Request Body ......................................................................................................................................... 44 Response Syntax ................................................................................................................................... 45 Response Elements ............................................................................................................................... 45 Errors ....................................................................................................................................................... 45 See Also .................................................................................................................................................. 46 GetSolNetworkInstance ............................................................................................................................. 47 Request Syntax ...................................................................................................................................... 47 URI Request Parameters ...................................................................................................................... 47 Request Body ......................................................................................................................................... 47 Response Syntax ................................................................................................................................... 47 Response Elements ............................................................................................................................... 48 Errors ....................................................................................................................................................... 50 See Also .................................................................................................................................................. 51 GetSolNetworkOperation ......................................................................................................................... 52 Request Syntax ...................................................................................................................................... 52 URI Request Parameters ...................................................................................................................... 52 Request Body ......................................................................................................................................... 52 Response Syntax ................................................................................................................................... 52 Response Elements ............................................................................................................................... 53 Errors ....................................................................................................................................................... 55 See Also .................................................................................................................................................. 56 API Version 2008-10-21 v AWS Telco Network Builder API Reference GetSolNetworkPackage ............................................................................................................................. 58 Request Syntax ...................................................................................................................................... 58 URI Request Parameters ...................................................................................................................... 58 Request Body ......................................................................................................................................... 58 Response Syntax ................................................................................................................................... 58 Response Elements ............................................................................................................................... 59 Errors ....................................................................................................................................................... 61 See Also .................................................................................................................................................. 62 GetSolNetworkPackageContent .............................................................................................................. 63 Request Syntax ...................................................................................................................................... 63 URI Request Parameters ...................................................................................................................... 63 Request Body ......................................................................................................................................... 63 Response Syntax ................................................................................................................................... 63 Response Elements ............................................................................................................................... 64 Errors ....................................................................................................................................................... 64 See Also .................................................................................................................................................. 65 GetSolNetworkPackageDescriptor .......................................................................................................... 66 Request Syntax ...................................................................................................................................... 66 URI Request Parameters ...................................................................................................................... 66 Request Body ......................................................................................................................................... 66 Response Syntax ................................................................................................................................... 66 Response Elements ............................................................................................................................... 66 Errors ....................................................................................................................................................... 67 See Also .................................................................................................................................................. 68 InstantiateSolNetworkInstance ................................................................................................................ 69 Request Syntax ...................................................................................................................................... 69 URI Request Parameters ...................................................................................................................... 69 Request Body ......................................................................................................................................... 70 Response Syntax ................................................................................................................................... 70 Response Elements ............................................................................................................................... 71 Errors ....................................................................................................................................................... 71 See Also .................................................................................................................................................. 72 ListSolFunctionInstances ........................................................................................................................... 74 Request Syntax ...................................................................................................................................... 74 URI Request Parameters ...................................................................................................................... 74 Request Body ......................................................................................................................................... 74 API Version 2008-10-21 vi AWS Telco Network Builder API Reference Response Syntax ................................................................................................................................... 74 Response Elements ............................................................................................................................... 75 Errors ....................................................................................................................................................... 75 See Also .................................................................................................................................................. 76 ListSolFunctionPackages ........................................................................................................................... 77 Request Syntax ...................................................................................................................................... 77 URI Request Parameters ...................................................................................................................... 77 Request Body ......................................................................................................................................... 77 Response Syntax ................................................................................................................................... 77 Response Elements ............................................................................................................................... 78 Errors ....................................................................................................................................................... 78 See Also .................................................................................................................................................. 79 ListSolNetworkInstances ........................................................................................................................... 81 Request Syntax ...................................................................................................................................... 81 URI Request Parameters ...................................................................................................................... 81 Request Body ......................................................................................................................................... 81 Response Syntax ................................................................................................................................... 81 Response Elements ............................................................................................................................... 82 Errors ....................................................................................................................................................... 82 See Also .................................................................................................................................................. 83 ListSolNetworkOperations ........................................................................................................................ 84 Request Syntax ...................................................................................................................................... 84 URI Request Parameters
|
tnb-api-002
|
tnb-api.pdf
| 2 |
Body ......................................................................................................................................... 74 API Version 2008-10-21 vi AWS Telco Network Builder API Reference Response Syntax ................................................................................................................................... 74 Response Elements ............................................................................................................................... 75 Errors ....................................................................................................................................................... 75 See Also .................................................................................................................................................. 76 ListSolFunctionPackages ........................................................................................................................... 77 Request Syntax ...................................................................................................................................... 77 URI Request Parameters ...................................................................................................................... 77 Request Body ......................................................................................................................................... 77 Response Syntax ................................................................................................................................... 77 Response Elements ............................................................................................................................... 78 Errors ....................................................................................................................................................... 78 See Also .................................................................................................................................................. 79 ListSolNetworkInstances ........................................................................................................................... 81 Request Syntax ...................................................................................................................................... 81 URI Request Parameters ...................................................................................................................... 81 Request Body ......................................................................................................................................... 81 Response Syntax ................................................................................................................................... 81 Response Elements ............................................................................................................................... 82 Errors ....................................................................................................................................................... 82 See Also .................................................................................................................................................. 83 ListSolNetworkOperations ........................................................................................................................ 84 Request Syntax ...................................................................................................................................... 84 URI Request Parameters ...................................................................................................................... 84 Request Body ......................................................................................................................................... 84 Response Syntax ................................................................................................................................... 84 Response Elements ............................................................................................................................... 85 Errors ....................................................................................................................................................... 86 See Also .................................................................................................................................................. 86 ListSolNetworkPackages ........................................................................................................................... 88 Request Syntax ...................................................................................................................................... 88 URI Request Parameters ...................................................................................................................... 88 Request Body ......................................................................................................................................... 88 Response Syntax ................................................................................................................................... 88 Response Elements ............................................................................................................................... 89 Errors ....................................................................................................................................................... 89 See Also .................................................................................................................................................. 90 API Version 2008-10-21 vii AWS Telco Network Builder API Reference ListTagsForResource ................................................................................................................................... 92 Request Syntax ...................................................................................................................................... 92 URI Request Parameters ...................................................................................................................... 92 Request Body ......................................................................................................................................... 92 Response Syntax ................................................................................................................................... 92 Response Elements ............................................................................................................................... 92 Errors ....................................................................................................................................................... 93 See Also .................................................................................................................................................. 94 PutSolFunctionPackageContent .............................................................................................................. 95 Request Syntax ...................................................................................................................................... 95 URI Request Parameters ...................................................................................................................... 95 Request Body ......................................................................................................................................... 95 Response Syntax ................................................................................................................................... 96 Response Elements ............................................................................................................................... 96 Errors ....................................................................................................................................................... 97 See Also .................................................................................................................................................. 98 PutSolNetworkPackageContent .............................................................................................................. 99 Request Syntax ...................................................................................................................................... 99 URI Request Parameters ...................................................................................................................... 99 Request Body ......................................................................................................................................... 99 Response Syntax ................................................................................................................................. 100 Response Elements ............................................................................................................................ 100 Errors ..................................................................................................................................................... 101 See Also ................................................................................................................................................ 102 TagResource .............................................................................................................................................. 104 Request Syntax .................................................................................................................................... 104 URI Request Parameters ................................................................................................................... 104 Request Body ....................................................................................................................................... 104 Response Syntax ................................................................................................................................. 105 Response Elements ............................................................................................................................ 105 Errors ..................................................................................................................................................... 105 See Also ................................................................................................................................................ 106 TerminateSolNetworkInstance .............................................................................................................. 107 Request Syntax .................................................................................................................................... 107 URI Request Parameters ................................................................................................................... 107 Request Body ....................................................................................................................................... 107 API Version 2008-10-21 viii AWS Telco Network Builder API Reference Response Syntax ................................................................................................................................. 108 Response Elements ............................................................................................................................ 108 Errors ..................................................................................................................................................... 109 See Also ................................................................................................................................................ 110 UntagResource .......................................................................................................................................... 111 Request Syntax .................................................................................................................................... 111 URI Request Parameters ................................................................................................................... 111 Request Body ....................................................................................................................................... 111 Response Syntax ................................................................................................................................. 111 Response Elements ............................................................................................................................ 112 Errors ..................................................................................................................................................... 112 See Also ................................................................................................................................................ 112 UpdateSolFunctionPackage ................................................................................................................... 114 Request Syntax .................................................................................................................................... 114 URI Request Parameters ................................................................................................................... 114 Request Body ....................................................................................................................................... 114 Response Syntax ................................................................................................................................. 115 Response Elements ............................................................................................................................ 115 Errors ..................................................................................................................................................... 115 See Also ................................................................................................................................................ 116 UpdateSolNetworkInstance ................................................................................................................... 117 Request Syntax .................................................................................................................................... 117 URI Request Parameters ................................................................................................................... 117 Request Body ....................................................................................................................................... 118 Response Syntax ................................................................................................................................. 119 Response Elements ............................................................................................................................ 119 Errors ..................................................................................................................................................... 120 See Also ................................................................................................................................................ 121 UpdateSolNetworkPackage .................................................................................................................... 122 Request Syntax .................................................................................................................................... 122 URI Request Parameters ................................................................................................................... 122 Request Body ....................................................................................................................................... 122 Response Syntax ................................................................................................................................. 123 Response Elements ............................................................................................................................ 123 Errors ..................................................................................................................................................... 123 See Also ................................................................................................................................................ 124 API Version 2008-10-21 ix AWS Telco Network Builder API Reference ValidateSolFunctionPackageContent ................................................................................................... 125 Request Syntax .................................................................................................................................... 125 URI Request Parameters ................................................................................................................... 125 Request Body ....................................................................................................................................... 125 Response Syntax ................................................................................................................................. 126 Response Elements ............................................................................................................................ 126 Errors ..................................................................................................................................................... 127 See Also ................................................................................................................................................ 128 ValidateSolNetworkPackageContent ................................................................................................... 129 Request Syntax .................................................................................................................................... 129 URI Request Parameters ................................................................................................................... 129 Request Body ....................................................................................................................................... 129 Response Syntax ................................................................................................................................. 130 Response Elements ............................................................................................................................ 130 Errors ..................................................................................................................................................... 131 See Also ................................................................................................................................................ 132 Data Types ................................................................................................................................... 134 ErrorInfo ..................................................................................................................................................... 136 Contents ............................................................................................................................................... 136 See Also ................................................................................................................................................ 136 FunctionArtifactMeta .............................................................................................................................. 137 Contents ............................................................................................................................................... 137 See Also ................................................................................................................................................ 137 GetSolFunctionInstanceMetadata ......................................................................................................... 138 Contents ............................................................................................................................................... 138 See Also ................................................................................................................................................ 138 GetSolFunctionPackageMetadata ......................................................................................................... 139 Contents ............................................................................................................................................... 139 See Also ................................................................................................................................................ 139 GetSolInstantiatedVnfInfo ...................................................................................................................... 141 Contents ............................................................................................................................................... 141 See Also ................................................................................................................................................ 141 GetSolNetworkInstanceMetadata ......................................................................................................... 142 Contents ............................................................................................................................................... 142 See Also ................................................................................................................................................ 142 GetSolNetworkOperationMetadata ...................................................................................................... 143 API Version 2008-10-21 x AWS Telco Network Builder API Reference Contents ............................................................................................................................................... 143 See Also ................................................................................................................................................ 144 GetSolNetworkOperationTaskDetails ................................................................................................... 145 Contents ............................................................................................................................................... 145 See Also ................................................................................................................................................ 146 GetSolNetworkPackageMetadata ......................................................................................................... 147 Contents ............................................................................................................................................... 147 See Also ................................................................................................................................................ 147 GetSolVnfcResourceInfo ......................................................................................................................... 149 Contents ............................................................................................................................................... 149 See Also ................................................................................................................................................ 149 GetSolVnfcResourceInfoMetadata ........................................................................................................ 150 Contents ............................................................................................................................................... 150 See Also ................................................................................................................................................ 150 GetSolVnfInfo ........................................................................................................................................... 152 Contents ............................................................................................................................................... 152 See Also ................................................................................................................................................ 152 InstantiateMetadata ................................................................................................................................ 153 Contents ............................................................................................................................................... 153 See Also ................................................................................................................................................ 153 LcmOperationInfo .................................................................................................................................... 154 Contents ............................................................................................................................................... 154 See Also ................................................................................................................................................ 154 ListSolFunctionInstanceInfo ................................................................................................................... 155 Contents ............................................................................................................................................... 155 See Also ................................................................................................................................................ 156 ListSolFunctionInstanceMetadata ......................................................................................................... 158 Contents ............................................................................................................................................... 158 See Also ................................................................................................................................................ 158 ListSolFunctionPackageInfo ................................................................................................................... 159 Contents ............................................................................................................................................... 159 See Also ................................................................................................................................................ 161 ListSolFunctionPackageMetadata ......................................................................................................... 162 Contents ............................................................................................................................................... 162 See Also ................................................................................................................................................ 162 ListSolNetworkInstanceInfo ................................................................................................................... 163 API Version 2008-10-21 xi AWS Telco Network Builder API Reference Contents ............................................................................................................................................... 163 See Also ................................................................................................................................................ 164 ListSolNetworkInstanceMetadata ......................................................................................................... 166 Contents ............................................................................................................................................... 166 See Also ................................................................................................................................................ 166 ListSolNetworkOperationsInfo .............................................................................................................. 167 Contents ............................................................................................................................................... 167 See Also ................................................................................................................................................ 168 ListSolNetworkOperationsMetadata .................................................................................................... 170 Contents ............................................................................................................................................... 170 See Also ................................................................................................................................................ 171 ListSolNetworkPackageInfo ................................................................................................................... 172 Contents ............................................................................................................................................... 172 See Also ................................................................................................................................................ 174 ListSolNetworkPackageMetadata ......................................................................................................... 175 Contents ............................................................................................................................................... 175 See Also ................................................................................................................................................ 175 ModifyVnfInfoMetadata .......................................................................................................................... 176 Contents ............................................................................................................................................... 176 See Also ................................................................................................................................................ 176 NetworkArtifactMeta ............................................................................................................................... 177
|
tnb-api-003
|
tnb-api.pdf
| 3 |
Contents ............................................................................................................................................... 159 See Also ................................................................................................................................................ 161 ListSolFunctionPackageMetadata ......................................................................................................... 162 Contents ............................................................................................................................................... 162 See Also ................................................................................................................................................ 162 ListSolNetworkInstanceInfo ................................................................................................................... 163 API Version 2008-10-21 xi AWS Telco Network Builder API Reference Contents ............................................................................................................................................... 163 See Also ................................................................................................................................................ 164 ListSolNetworkInstanceMetadata ......................................................................................................... 166 Contents ............................................................................................................................................... 166 See Also ................................................................................................................................................ 166 ListSolNetworkOperationsInfo .............................................................................................................. 167 Contents ............................................................................................................................................... 167 See Also ................................................................................................................................................ 168 ListSolNetworkOperationsMetadata .................................................................................................... 170 Contents ............................................................................................................................................... 170 See Also ................................................................................................................................................ 171 ListSolNetworkPackageInfo ................................................................................................................... 172 Contents ............................................................................................................................................... 172 See Also ................................................................................................................................................ 174 ListSolNetworkPackageMetadata ......................................................................................................... 175 Contents ............................................................................................................................................... 175 See Also ................................................................................................................................................ 175 ModifyVnfInfoMetadata .......................................................................................................................... 176 Contents ............................................................................................................................................... 176 See Also ................................................................................................................................................ 176 NetworkArtifactMeta ............................................................................................................................... 177 Contents ............................................................................................................................................... 177 See Also ................................................................................................................................................ 177 ProblemDetails ......................................................................................................................................... 178 Contents ............................................................................................................................................... 178 See Also ................................................................................................................................................ 178 PutSolFunctionPackageContentMetadata .......................................................................................... 179 Contents ............................................................................................................................................... 179 See Also ................................................................................................................................................ 179 PutSolNetworkPackageContentMetadata ........................................................................................... 180 Contents ............................................................................................................................................... 180 See Also ................................................................................................................................................ 180 ToscaOverride ........................................................................................................................................... 181 Contents ............................................................................................................................................... 181 See Also ................................................................................................................................................ 181 UpdateNsMetadata .................................................................................................................................. 182 API Version 2008-10-21 xii AWS Telco Network Builder API Reference Contents ............................................................................................................................................... 182 See Also ................................................................................................................................................ 182 UpdateSolNetworkModify ...................................................................................................................... 183 Contents ............................................................................................................................................... 183 See Also ................................................................................................................................................ 183 UpdateSolNetworkServiceData ............................................................................................................. 184 Contents ............................................................................................................................................... 184 See Also ................................................................................................................................................ 184 ValidateSolFunctionPackageContentMetadata .................................................................................. 185 Contents ............................................................................................................................................... 185 See Also ................................................................................................................................................ 185 ValidateSolNetworkPackageContentMetadata .................................................................................. 186 Contents ............................................................................................................................................... 186 See Also ................................................................................................................................................ 186 Common Parameters ................................................................................................................... 187 Common Errors ............................................................................................................................ 190 API Version 2008-10-21 xiii AWS Telco Network Builder Welcome API Reference AWS Telco Network Builder (TNB) is a network automation service that helps you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of your telecommunication network functions throughout planning, deployment, and post-deployment activities. This document was last published on May 21, 2025. API Version 2008-10-21 1 AWS Telco Network Builder API Reference Actions The following actions are supported: • CancelSolNetworkOperation • CreateSolFunctionPackage • CreateSolNetworkInstance • CreateSolNetworkPackage • DeleteSolFunctionPackage • DeleteSolNetworkInstance • DeleteSolNetworkPackage • GetSolFunctionInstance • GetSolFunctionPackage • GetSolFunctionPackageContent • GetSolFunctionPackageDescriptor • GetSolNetworkInstance • GetSolNetworkOperation • GetSolNetworkPackage • GetSolNetworkPackageContent • GetSolNetworkPackageDescriptor • InstantiateSolNetworkInstance • ListSolFunctionInstances • ListSolFunctionPackages • ListSolNetworkInstances • ListSolNetworkOperations • ListSolNetworkPackages • ListTagsForResource • PutSolFunctionPackageContent • PutSolNetworkPackageContent • TagResource • TerminateSolNetworkInstance API Version 2008-10-21 2 AWS Telco Network Builder • UntagResource • UpdateSolFunctionPackage • UpdateSolNetworkInstance • UpdateSolNetworkPackage • ValidateSolFunctionPackageContent • ValidateSolNetworkPackageContent API Reference API Version 2008-10-21 3 AWS Telco Network Builder API Reference CancelSolNetworkOperation Cancels a network operation. A network operation is any operation that is done to your network, such as network instance instantiation or termination. Request Syntax POST /sol/nslcm/v1/ns_lcm_op_occs/nsLcmOpOccId/cancel HTTP/1.1 URI Request Parameters The request uses the following URI parameters. nsLcmOpOccId The identifier of the network operation. Pattern: ^no-[a-f0-9]{17}$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 202 Response Elements If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. CancelSolNetworkOperation API Version 2008-10-21 4 API Reference AWS Telco Network Builder AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2008-10-21 5 AWS Telco Network Builder • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2008-10-21 6 AWS Telco Network Builder API Reference CreateSolFunctionPackage Creates a function package. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. For more information, see Function packages in the AWS Telco Network Builder User Guide. Creating a function package is the first step for creating a network in AWS TNB. This request creates an empty container with an ID. The next step is to upload the actual CSAR zip file into that empty container. To upload function package content, see PutSolFunctionPackageContent. Request Syntax POST /sol/vnfpkgm/v1/vnf_packages HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. tags A tag is a label that you assign to
|
tnb-api-004
|
tnb-api.pdf
| 4 |
the AWS Telco Network Builder User Guide. Creating a function package is the first step for creating a network in AWS TNB. This request creates an empty container with an ID. The next step is to upload the actual CSAR zip file into that empty container. To upload function package content, see PutSolFunctionPackageContent. Request Syntax POST /sol/vnfpkgm/v1/vnf_packages HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. tags A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. CreateSolFunctionPackage API Version 2008-10-21 7 AWS Telco Network Builder API Reference Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No Response Syntax HTTP/1.1 201 Content-type: application/json { "arn": "string", "id": "string", "onboardingState": "string", "operationalState": "string", "tags": { "string" : "string" }, "usageState": "string" } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. arn Function package ARN. Type: String 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})$ id ID of the function package. Response Syntax API Version 2008-10-21 8 API Reference AWS Telco Network Builder Type: String Pattern: ^fp-[a-f0-9]{17}$ onboardingState Onboarding state of the function package. Type: String Valid Values: CREATED | ONBOARDED | ERROR operationalState Operational state of the function package. Type: String Valid Values: ENABLED | DISABLED tags A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. usageState Usage state of the function package. Type: String Valid Values: IN_USE | NOT_IN_USE Errors For information about the errors that are common to all actions, see Common Errors. Errors API Version 2008-10-21 9 API Reference AWS Telco Network Builder AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ServiceQuotaExceededException Service quotas have been exceeded. HTTP Status Code: 402 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2008-10-21 10 AWS Telco Network Builder • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2008-10-21 11 AWS Telco Network Builder API Reference CreateSolNetworkInstance Creates a network instance. A network instance is a single network created in AWS TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Creating a network instance is the third step after creating a network package. For more information about network instances, Network instances in the AWS Telco Network Builder User Guide. Once you create a network instance, you can instantiate it. To instantiate a network, see InstantiateSolNetworkInstance. Request Syntax POST /sol/nslcm/v1/ns_instances HTTP/1.1 Content-type: application/json { "nsDescription": "string", "nsdInfoId": "string", "nsName": "string", "tags": { "string" : "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. nsDescription Network instance description. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. CreateSolNetworkInstance API Version 2008-10-21 12 API Reference AWS Telco Network Builder Required: No nsdInfoId ID for network service descriptor. Type: String Pattern: ^np-[a-f0-9]{17}$ Required: Yes nsName Network instance name. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: Yes tags A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of
|
tnb-api-005
|
tnb-api.pdf
| 5 |
Required: No nsdInfoId ID for network service descriptor. Type: String Pattern: ^np-[a-f0-9]{17}$ Required: Yes nsName Network instance name. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: Yes tags A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No Response Syntax HTTP/1.1 201 Content-type: application/json { "arn": "string", Response Syntax API Version 2008-10-21 13 AWS Telco Network Builder API Reference "id": "string", "nsdInfoId": "string", "nsInstanceName": "string", "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. arn Network instance ARN. Type: String 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})$ id Network instance ID. Type: String Pattern: ^ni-[a-f0-9]{17}$ nsdInfoId Network service descriptor ID. Type: String Pattern: ^np-[a-f0-9]{17}$ nsInstanceName Network instance name. Type: String Response Elements API Version 2008-10-21 14 AWS Telco Network Builder tags API Reference A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ServiceQuotaExceededException Service quotas have been exceeded. HTTP Status Code: 402 ThrottlingException Exception caused by throttling. Errors API Version 2008-10-21 15 AWS Telco Network Builder HTTP Status Code: 429 ValidationException API Reference Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 16 AWS Telco Network Builder API Reference CreateSolNetworkPackage Creates a network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the AWS infrastructure you want to deploy them on. For more information, see Network instances in the AWS Telco Network Builder User Guide. A network package consists of a network service descriptor (NSD) file (required) and any additional files (optional), such as scripts specific to your needs. For example, if you have multiple function packages in your network package, you can use the NSD to define which network functions should run in certain VPCs, subnets, or EKS clusters. This request creates an empty network package container with an ID. Once you create a network package, you can upload the network package content using PutSolNetworkPackageContent. Request Syntax POST /sol/nsd/v1/ns_descriptors HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. tags A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs. Type: String to string map CreateSolNetworkPackage API Version 2008-10-21 17 AWS Telco Network Builder API Reference Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No Response Syntax HTTP/1.1 201 Content-type: application/json { "arn": "string", "id": "string", "nsdOnboardingState": "string", "nsdOperationalState": "string", "nsdUsageState": "string", "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. arn Network package ARN. Type: String 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})$ id ID of the network package. Response Syntax API Version 2008-10-21 18 API Reference AWS Telco Network Builder Type: String Pattern: ^np-[a-f0-9]{17}$ nsdOnboardingState Onboarding state of the network
|
tnb-api-006
|
tnb-api.pdf
| 6 |
Length Constraints: Minimum length of 0. Maximum length of 256. Required: No Response Syntax HTTP/1.1 201 Content-type: application/json { "arn": "string", "id": "string", "nsdOnboardingState": "string", "nsdOperationalState": "string", "nsdUsageState": "string", "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. arn Network package ARN. Type: String 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})$ id ID of the network package. Response Syntax API Version 2008-10-21 18 API Reference AWS Telco Network Builder Type: String Pattern: ^np-[a-f0-9]{17}$ nsdOnboardingState Onboarding state of the network service descriptor in the network package. Type: String Valid Values: CREATED | ONBOARDED | ERROR nsdOperationalState Operational state of the network service descriptor in the network package. Type: String Valid Values: ENABLED | DISABLED nsdUsageState Usage state of the network service descriptor in the network package. Type: String Valid Values: IN_USE | NOT_IN_USE tags A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. Errors API Version 2008-10-21 19 API Reference AWS Telco Network Builder AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ServiceQuotaExceededException Service quotas have been exceeded. HTTP Status Code: 402 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2008-10-21 20 AWS Telco Network Builder • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2008-10-21 21 AWS Telco Network Builder API Reference DeleteSolFunctionPackage Deletes a function package. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. To delete a function package, the package must be in a disabled state. To disable a function package, see UpdateSolFunctionPackage. Request Syntax DELETE /sol/vnfpkgm/v1/vnf_packages/vnfPkgId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. vnfPkgId ID of the function package. Pattern: ^fp-[a-f0-9]{17}$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 204 Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. DeleteSolFunctionPackage API Version 2008-10-21 22 AWS Telco Network Builder Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Errors API Version 2008-10-21 23 AWS Telco Network Builder • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2008-10-21 24 AWS Telco Network Builder API Reference DeleteSolNetworkInstance Deletes a network instance. A network instance is a single network created in AWS TNB that can be deployed and on which life- cycle operations (like terminate, update, and delete) can be performed. To delete a network instance, the instance must be in a stopped or terminated state. To terminate a network instance, see TerminateSolNetworkInstance. Request Syntax DELETE /sol/nslcm/v1/ns_instances/nsInstanceId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. nsInstanceId Network instance ID. Pattern: ^ni-[a-f0-9]{17}$ Required: Yes Request
|
tnb-api-007
|
tnb-api.pdf
| 7 |
• AWS SDK for Ruby V3 API Reference See Also API Version 2008-10-21 24 AWS Telco Network Builder API Reference DeleteSolNetworkInstance Deletes a network instance. A network instance is a single network created in AWS TNB that can be deployed and on which life- cycle operations (like terminate, update, and delete) can be performed. To delete a network instance, the instance must be in a stopped or terminated state. To terminate a network instance, see TerminateSolNetworkInstance. Request Syntax DELETE /sol/nslcm/v1/ns_instances/nsInstanceId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. nsInstanceId Network instance ID. Pattern: ^ni-[a-f0-9]{17}$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 204 Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. DeleteSolNetworkInstance API Version 2008-10-21 25 AWS Telco Network Builder Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Errors API Version 2008-10-21 26 AWS Telco Network Builder • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2008-10-21 27 AWS Telco Network Builder API Reference DeleteSolNetworkPackage Deletes network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the AWS infrastructure you want to deploy them on. To delete a network package, the package must be in a disable state. To disable a network package, see UpdateSolNetworkPackage. Request Syntax DELETE /sol/nsd/v1/ns_descriptors/nsdInfoId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. nsdInfoId ID of the network service descriptor in the network package. Pattern: ^np-[a-f0-9]{17}$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 204 Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. DeleteSolNetworkPackage API Version 2008-10-21 28 AWS Telco Network Builder Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Errors API Version 2008-10-21 29 AWS Telco Network Builder • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2008-10-21 30 AWS Telco Network Builder API Reference GetSolFunctionInstance Gets the details of a network function instance, including the instantiation state and metadata from the function package descriptor in the network function package. A network function instance is a function in a function package . Request Syntax GET /sol/vnflcm/v1/vnf_instances/vnfInstanceId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. vnfInstanceId ID of the network function. Pattern: ^fi-[a-f0-9]{17}$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "arn": "string", "id": "string", "instantiatedVnfInfo": { "vnfcResourceInfo": [ { "metadata": { "cluster": "string", GetSolFunctionInstance API Version 2008-10-21 31 AWS Telco Network Builder API Reference "helmChart": "string", "nodeGroup": "string" } } ], "vnfState": "string" }, "instantiationState": "string", "metadata": { "createdAt": "string", "lastModified": "string" }, "nsInstanceId": "string", "tags": { "string" : "string" }, "vnfdId": "string", "vnfdVersion": "string", "vnfPkgId": "string", "vnfProductName": "string", "vnfProvider": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. arn Network function instance ARN. Type: String Pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-
|
tnb-api-008
|
tnb-api.pdf
| 8 |
Content-type: application/json { "arn": "string", "id": "string", "instantiatedVnfInfo": { "vnfcResourceInfo": [ { "metadata": { "cluster": "string", GetSolFunctionInstance API Version 2008-10-21 31 AWS Telco Network Builder API Reference "helmChart": "string", "nodeGroup": "string" } } ], "vnfState": "string" }, "instantiationState": "string", "metadata": { "createdAt": "string", "lastModified": "string" }, "nsInstanceId": "string", "tags": { "string" : "string" }, "vnfdId": "string", "vnfdVersion": "string", "vnfPkgId": "string", "vnfProductName": "string", "vnfProvider": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. arn Network function instance ARN. Type: String 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})$ id Network function instance ID. Type: String Response Elements API Version 2008-10-21 32 AWS Telco Network Builder API Reference Pattern: ^fi-[a-f0-9]{17}$ instantiatedVnfInfo Information about the network function. A network function instance is a function in a function package . Type: GetSolVnfInfo object instantiationState Network function instantiation state. Type: String Valid Values: INSTANTIATED | NOT_INSTANTIATED metadata The metadata of a network function instance. A network function instance is a function in a function package . Type: GetSolFunctionInstanceMetadata object nsInstanceId Network instance ID. Type: String Pattern: ^ni-[a-f0-9]{17}$ tags A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. Response Elements API Version 2008-10-21 33 AWS Telco Network Builder vnfdId Function package descriptor ID. Type: String API Reference Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ vnfdVersion Function package descriptor version. Type: String vnfPkgId Function package ID. Type: String Pattern: ^fp-[a-f0-9]{17}$ vnfProductName Network function product name. Type: String vnfProvider Network function provider. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. Errors API Version 2008-10-21 34 API Reference AWS Telco Network Builder HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 35 AWS Telco Network Builder API Reference GetSolFunctionPackage Gets the details of an individual function package, such as the operational state and whether the package is in use. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.. Request Syntax GET /sol/vnfpkgm/v1/vnf_packages/vnfPkgId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. vnfPkgId ID of the function package. Pattern: ^fp-[a-f0-9]{17}$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "arn": "string", "id": "string", "metadata": { "createdAt": "string", "lastModified": "string", GetSolFunctionPackage API Version 2008-10-21 36 API Reference AWS Telco Network Builder "vnfd": { "overrides": [ { "defaultValue": "string", "name": "string" } ] } }, "onboardingState": "string", "operationalState": "string", "tags": { "string" : "string" }, "usageState": "string", "vnfdId": "string", "vnfdVersion": "string", "vnfProductName": "string", "vnfProvider": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. arn Function package ARN. Type: String 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})$ id Function package ID. Type: String Pattern: ^fp-[a-f0-9]{17}$ Response Elements API Version 2008-10-21 37 AWS Telco Network Builder metadata Metadata related to the function package. API Reference 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. Type: GetSolFunctionPackageMetadata object onboardingState Function package onboarding state. Type: String Valid Values: CREATED | ONBOARDED | ERROR operationalState Function package operational state. Type: String Valid Values: ENABLED | DISABLED tags A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You
|
tnb-api-009
|
tnb-api.pdf
| 9 |
function package. API Reference 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. Type: GetSolFunctionPackageMetadata object onboardingState Function package onboarding state. Type: String Valid Values: CREATED | ONBOARDED | ERROR operationalState Function package operational state. Type: String Valid Values: ENABLED | DISABLED tags A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. usageState Function package usage state. Type: String Response Elements API Version 2008-10-21 38 AWS Telco Network Builder API Reference Valid Values: IN_USE | NOT_IN_USE vnfdId Function package descriptor ID. Type: String vnfdVersion Function package descriptor version. Type: String vnfProductName Network function product name. Type: String vnfProvider Network function provider. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 Errors API Version 2008-10-21 39 AWS Telco Network Builder ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException API Reference Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 40 AWS Telco Network Builder API Reference GetSolFunctionPackageContent Gets the contents of a function package. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. Request Syntax GET /sol/vnfpkgm/v1/vnf_packages/vnfPkgId/package_content HTTP/1.1 Accept: accept URI Request Parameters The request uses the following URI parameters. accept The format of the package that you want to download from the function packages. Valid Values: application/zip Required: Yes vnfPkgId ID of the function package. Pattern: ^fp-[a-f0-9]{17}$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 GetSolFunctionPackageContent API Version 2008-10-21 41 AWS Telco Network Builder Content-Type: contentType packageContent Response Elements If the action is successful, the service sends back an HTTP 200 response. API Reference The response returns the following HTTP headers. contentType Indicates the media type of the resource. Valid Values: application/zip The response returns the following as the HTTP body. packageContent Contents of the function package. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 Response Elements API Version 2008-10-21 42 AWS Telco Network Builder ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException API Reference Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 43 AWS Telco Network Builder API Reference GetSolFunctionPackageDescriptor Gets a function package descriptor in a function package. 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. 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
|
tnb-api-010
|
tnb-api.pdf
| 10 |
SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 43 AWS Telco Network Builder API Reference GetSolFunctionPackageDescriptor Gets a function package descriptor in a function package. 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. 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. Request Syntax GET /sol/vnfpkgm/v1/vnf_packages/vnfPkgId/vnfd HTTP/1.1 Accept: accept URI Request Parameters The request uses the following URI parameters. accept Indicates which content types, expressed as MIME types, the client is able to understand. Valid Values: text/plain Required: Yes vnfPkgId ID of the function package. Pattern: ^fp-[a-f0-9]{17}$ Required: Yes Request Body The request does not have a request body. GetSolFunctionPackageDescriptor API Version 2008-10-21 44 AWS Telco Network Builder Response Syntax HTTP/1.1 200 Content-Type: contentType vnfd Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. contentType Indicates the media type of the resource. Valid Values: text/plain The response returns the following as the HTTP body. vnfd Contents of the function package descriptor. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 Response Syntax API Version 2008-10-21 45 API Reference AWS Telco Network Builder ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 46 AWS Telco Network Builder API Reference GetSolNetworkInstance Gets the details of the network instance. A network instance is a single network created in AWS TNB that can be deployed and on which life- cycle operations (like terminate, update, and delete) can be performed. Request Syntax GET /sol/nslcm/v1/ns_instances/nsInstanceId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. nsInstanceId ID of the network instance. Pattern: ^ni-[a-f0-9]{17}$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "arn": "string", "id": "string", "lcmOpInfo": { "nsLcmOpOccId": "string" }, "metadata": { "createdAt": "string", GetSolNetworkInstance API Version 2008-10-21 47 AWS Telco Network Builder API Reference "lastModified": "string" }, "nsdId": "string", "nsdInfoId": "string", "nsInstanceDescription": "string", "nsInstanceName": "string", "nsState": "string", "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. arn Network instance ARN. Type: String 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})$ id Network instance ID. Type: String Pattern: ^ni-[a-f0-9]{17}$ lcmOpInfo Lifecycle management operation details on the network instance. Lifecycle management operations are deploy, update, or delete operations. Type: LcmOperationInfo object Response Elements API Version 2008-10-21 48 AWS Telco Network Builder metadata The metadata of a network instance. API Reference A network instance is a single network created in AWS TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Type: GetSolNetworkInstanceMetadata object nsdId Network service descriptor ID. Type: String Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ nsdInfoId Network service descriptor info ID. Type: String Pattern: ^np-[a-f0-9]{17}$ nsInstanceDescription Network instance description. Type: String nsInstanceName Network instance name. Type: String nsState Network instance state. Type: String Valid Values: INSTANTIATED | NOT_INSTANTIATED | UPDATED | IMPAIRED | UPDATE_FAILED | STOPPED | DELETED | INSTANTIATE_IN_PROGRESS | INTENT_TO_UPDATE_IN_PROGRESS | UPDATE_IN_PROGRESS | TERMINATE_IN_PROGRESS Response Elements API Version 2008-10-21 49 AWS Telco Network Builder tags API Reference A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors.
|
tnb-api-011
|
tnb-api.pdf
| 11 |
| UPDATE_IN_PROGRESS | TERMINATE_IN_PROGRESS Response Elements API Version 2008-10-21 49 AWS Telco Network Builder tags API Reference A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. Errors API Version 2008-10-21 50 AWS Telco Network Builder HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 51 AWS Telco Network Builder API Reference GetSolNetworkOperation Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks. A network operation is any operation that is done to your network, such as network instance instantiation or termination. Request Syntax GET /sol/nslcm/v1/ns_lcm_op_occs/nsLcmOpOccId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. nsLcmOpOccId The identifier of the network operation. Pattern: ^no-[a-f0-9]{17}$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "arn": "string", "error": { "detail": "string", "title": "string" }, "id": "string", GetSolNetworkOperation API Version 2008-10-21 52 AWS Telco Network Builder API Reference "lcmOperationType": "string", "metadata": { "createdAt": "string", "instantiateMetadata": { "additionalParamsForNs": JSON value, "nsdInfoId": "string" }, "lastModified": "string", "modifyVnfInfoMetadata": { "vnfConfigurableProperties": JSON value, "vnfInstanceId": "string" }, "updateNsMetadata": { "additionalParamsForNs": JSON value, "nsdInfoId": "string" } }, "nsInstanceId": "string", "operationState": "string", "tags": { "string" : "string" }, "tasks": [ { "taskContext": { "string" : "string" }, "taskEndTime": "string", "taskErrorDetails": { "cause": "string", "details": "string" }, "taskName": "string", "taskStartTime": "string", "taskStatus": "string" } ], "updateType": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Elements API Version 2008-10-21 53 AWS Telco Network Builder API Reference The following data is returned in JSON format by the service. arn Network operation ARN. Type: String 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})$ error Error related to this specific network operation occurrence. Type: ProblemDetails object id ID of this network operation occurrence. Type: String Pattern: ^no-[a-f0-9]{17}$ lcmOperationType Type of the operation represented by this occurrence. Type: String Valid Values: INSTANTIATE | UPDATE | TERMINATE metadata Metadata of this network operation occurrence. Type: GetSolNetworkOperationMetadata object nsInstanceId ID of the network operation instance. Type: String Pattern: ^ni-[a-f0-9]{17}$ Response Elements API Version 2008-10-21 54 AWS Telco Network Builder operationState The state of the network operation. Type: String API Reference Valid Values: PROCESSING | COMPLETED | FAILED | CANCELLING | CANCELLED tags A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. tasks All tasks associated with this operation occurrence. Type: Array of GetSolNetworkOperationTaskDetails objects updateType Type of the update. Only present if the network operation lcmOperationType is UPDATE. Type: String Valid Values: MODIFY_VNF_INFORMATION | UPDATE_NS Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 Errors API Version 2008-10-21 55 API Reference AWS Telco Network Builder InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for
|
tnb-api-012
|
tnb-api.pdf
| 12 |
permissions to make request. HTTP Status Code: 403 Errors API Version 2008-10-21 55 API Reference AWS Telco Network Builder InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 56 AWS Telco Network Builder API Reference See Also API Version 2008-10-21 57 AWS Telco Network Builder API Reference GetSolNetworkPackage Gets the details of a network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the AWS infrastructure you want to deploy them on. Request Syntax GET /sol/nsd/v1/ns_descriptors/nsdInfoId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. nsdInfoId ID of the network service descriptor in the network package. Pattern: ^np-[a-f0-9]{17}$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "arn": "string", "id": "string", "metadata": { "createdAt": "string", "lastModified": "string", "nsd": { GetSolNetworkPackage API Version 2008-10-21 58 AWS Telco Network Builder API Reference "overrides": [ { "defaultValue": "string", "name": "string" } ] } }, "nsdId": "string", "nsdName": "string", "nsdOnboardingState": "string", "nsdOperationalState": "string", "nsdUsageState": "string", "nsdVersion": "string", "tags": { "string" : "string" }, "vnfPkgIds": [ "string" ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. arn Network package ARN. Type: String 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})$ id Network package ID. Type: String Pattern: ^np-[a-f0-9]{17}$ Response Elements API Version 2008-10-21 59 AWS Telco Network Builder metadata Metadata associated with a network package. API Reference A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the AWS infrastructure you want to deploy them on. Type: GetSolNetworkPackageMetadata object nsdId Network service descriptor ID. Type: String Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ nsdName Network service descriptor name. Type: String nsdOnboardingState Network service descriptor onboarding state. Type: String Valid Values: CREATED | ONBOARDED | ERROR nsdOperationalState Network service descriptor operational state. Type: String Valid Values: ENABLED | DISABLED nsdUsageState Network service descriptor usage state. Type: String Valid Values: IN_USE | NOT_IN_USE Response Elements API Version 2008-10-21 60 AWS Telco Network Builder nsdVersion Network service descriptor version. Type: String tags API Reference A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. vnfPkgIds Identifies the function package for the function package descriptor referenced by the onboarded network package. Type: Array of strings Pattern: ^fp-[a-f0-9]{17}$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 Errors API Version 2008-10-21 61 API Reference AWS Telco Network Builder ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 62 AWS Telco Network Builder API Reference GetSolNetworkPackageContent Gets the contents of a network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the AWS infrastructure you want to deploy them on. Request Syntax GET /sol/nsd/v1/ns_descriptors/nsdInfoId/nsd_content HTTP/1.1 Accept: accept URI Request
|
tnb-api-013
|
tnb-api.pdf
| 13 |
• AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 62 AWS Telco Network Builder API Reference GetSolNetworkPackageContent Gets the contents of a network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the AWS infrastructure you want to deploy them on. Request Syntax GET /sol/nsd/v1/ns_descriptors/nsdInfoId/nsd_content HTTP/1.1 Accept: accept URI Request Parameters The request uses the following URI parameters. accept The format of the package you want to download from the network package. Valid Values: application/zip Required: Yes nsdInfoId ID of the network service descriptor in the network package. Pattern: ^np-[a-f0-9]{17}$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-Type: contentType GetSolNetworkPackageContent API Version 2008-10-21 63 AWS Telco Network Builder API Reference nsdContent Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. contentType Indicates the media type of the resource. Valid Values: application/zip The response returns the following as the HTTP body. nsdContent Content of the network service descriptor in the network package. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 Response Elements API Version 2008-10-21 64 AWS Telco Network Builder ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException API Reference Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 65 AWS Telco Network Builder API Reference GetSolNetworkPackageDescriptor Gets the content of the network service descriptor. 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 AWS infrastructure you want to deploy the network functions on. Request Syntax GET /sol/nsd/v1/ns_descriptors/nsdInfoId/nsd HTTP/1.1 URI Request Parameters The request uses the following URI parameters. nsdInfoId ID of the network service descriptor in the network package. Pattern: ^np-[a-f0-9]{17}$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-Type: contentType nsd Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. GetSolNetworkPackageDescriptor API Version 2008-10-21 66 AWS Telco Network Builder contentType Indicates the media type of the resource. Valid Values: text/plain API Reference The response returns the following as the HTTP body. nsd Contents of the network service descriptor in the network package. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. Errors API Version 2008-10-21 67 AWS Telco Network Builder HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 68 AWS Telco Network Builder API Reference InstantiateSolNetworkInstance Instantiates a network instance. A network instance is a single network created in AWS TNB that can be deployed and on which life- cycle operations (like terminate, update, and delete) can be performed. Before you can instantiate a network instance, you have to create a network instance. For more information, see CreateSolNetworkInstance. Request Syntax POST /sol/nslcm/v1/ns_instances/nsInstanceId/instantiate?dry_run=dryRun HTTP/1.1 Content-type: application/json { "additionalParamsForNs": JSON value, "tags": { "string" :
|
tnb-api-014
|
tnb-api.pdf
| 14 |
SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 68 AWS Telco Network Builder API Reference InstantiateSolNetworkInstance Instantiates a network instance. A network instance is a single network created in AWS TNB that can be deployed and on which life- cycle operations (like terminate, update, and delete) can be performed. Before you can instantiate a network instance, you have to create a network instance. For more information, see CreateSolNetworkInstance. Request Syntax POST /sol/nslcm/v1/ns_instances/nsInstanceId/instantiate?dry_run=dryRun HTTP/1.1 Content-type: application/json { "additionalParamsForNs": JSON value, "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. dryRun A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation. nsInstanceId ID of the network instance. Pattern: ^ni-[a-f0-9]{17}$ Required: Yes InstantiateSolNetworkInstance API Version 2008-10-21 69 API Reference AWS Telco Network Builder Request Body The request accepts the following data in JSON format. additionalParamsForNs Provides values for the configurable properties. Type: JSON value Required: No tags A tag is a label that you assign to an AWS 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 AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No Response Syntax HTTP/1.1 201 Content-type: application/json { "nsLcmOpOccId": "string", "tags": { "string" : "string" } } Request Body API Version 2008-10-21 70 AWS Telco Network Builder Response Elements API Reference If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. nsLcmOpOccId The identifier of the network operation. Type: String Pattern: ^no-[a-f0-9]{17}$ tags A tag is a label that you assign to an AWS 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 AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 Response Elements API Version 2008-10-21 71 AWS Telco Network Builder ResourceNotFoundException Request references a resource that doesn't exist. API Reference HTTP Status Code: 404 ServiceQuotaExceededException Service quotas have been exceeded. HTTP Status Code: 402 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 72 AWS Telco Network Builder API Reference See Also API Version 2008-10-21 73 AWS Telco Network Builder API Reference ListSolFunctionInstances Lists network function instances. A network function instance is a function in a function package . Request Syntax GET /sol/vnflcm/v1/vnf_instances? max_results=maxResults&nextpage_opaque_marker=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to include in the response. Valid Range: Minimum value of 1. Maximum value of 100. nextToken The token for the next page of results. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "functionInstances": [ { "arn": "string", "id": "string", "instantiatedVnfInfo": { "vnfState": "string" ListSolFunctionInstances API Version 2008-10-21 74 AWS Telco Network Builder API Reference }, "instantiationState": "string", "metadata": { "createdAt": "string", "lastModified": "string" }, "nsInstanceId": "string", "vnfPkgId": "string", "vnfPkgName": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. functionInstances Network function instances. Type:
|
tnb-api-015
|
tnb-api.pdf
| 15 |
nextToken The token for the next page of results. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "functionInstances": [ { "arn": "string", "id": "string", "instantiatedVnfInfo": { "vnfState": "string" ListSolFunctionInstances API Version 2008-10-21 74 AWS Telco Network Builder API Reference }, "instantiationState": "string", "metadata": { "createdAt": "string", "lastModified": "string" }, "nsInstanceId": "string", "vnfPkgId": "string", "vnfPkgName": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. functionInstances Network function instances. Type: Array of ListSolFunctionInstanceInfo objects nextToken The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 Response Elements API Version 2008-10-21 75 AWS Telco Network Builder InternalServerException Unexpected error occurred. Problem on the server. API Reference HTTP Status Code: 500 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 76 AWS Telco Network Builder API Reference ListSolFunctionPackages Lists information about 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. Request Syntax GET /sol/vnfpkgm/v1/vnf_packages? max_results=maxResults&nextpage_opaque_marker=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to include in the response. Valid Range: Minimum value of 1. Maximum value of 100. nextToken The token for the next page of results. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "functionPackages": [ { "arn": "string", ListSolFunctionPackages API Version 2008-10-21 77 AWS Telco Network Builder API Reference "id": "string", "metadata": { "createdAt": "string", "lastModified": "string" }, "onboardingState": "string", "operationalState": "string", "usageState": "string", "vnfdId": "string", "vnfdVersion": "string", "vnfProductName": "string", "vnfProvider": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. functionPackages 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. Type: Array of ListSolFunctionPackageInfo objects nextToken The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2008-10-21 78 API Reference AWS Telco Network Builder AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 79 AWS Telco Network Builder API Reference See Also API Version 2008-10-21 80 AWS Telco Network Builder API Reference ListSolNetworkInstances Lists your network instances. A network instance is a single network created in AWS TNB that can be deployed and on which life- cycle operations (like terminate, update, and delete) can be performed. Request Syntax GET /sol/nslcm/v1/ns_instances?max_results=maxResults&nextpage_opaque_marker=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to include in the response. Valid Range: Minimum value of 1. Maximum value of 100. nextToken
|
tnb-api-016
|
tnb-api.pdf
| 16 |
AWS SDK for Ruby V3 See Also API Version 2008-10-21 79 AWS Telco Network Builder API Reference See Also API Version 2008-10-21 80 AWS Telco Network Builder API Reference ListSolNetworkInstances Lists your network instances. A network instance is a single network created in AWS TNB that can be deployed and on which life- cycle operations (like terminate, update, and delete) can be performed. Request Syntax GET /sol/nslcm/v1/ns_instances?max_results=maxResults&nextpage_opaque_marker=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to include in the response. Valid Range: Minimum value of 1. Maximum value of 100. nextToken The token for the next page of results. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "networkInstances": [ { "arn": "string", "id": "string", ListSolNetworkInstances API Version 2008-10-21 81 AWS Telco Network Builder API Reference "metadata": { "createdAt": "string", "lastModified": "string" }, "nsdId": "string", "nsdInfoId": "string", "nsInstanceDescription": "string", "nsInstanceName": "string", "nsState": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. networkInstances Lists network instances. Type: Array of ListSolNetworkInstanceInfo objects nextToken The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 Response Elements API Version 2008-10-21 82 AWS Telco Network Builder InternalServerException Unexpected error occurred. Problem on the server. API Reference HTTP Status Code: 500 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 83 AWS Telco Network Builder API Reference ListSolNetworkOperations Lists details for a network operation, including when the operation started and the status of the operation. A network operation is any operation that is done to your network, such as network instance instantiation or termination. Request Syntax GET /sol/nslcm/v1/ns_lcm_op_occs? max_results=maxResults&nextpage_opaque_marker=nextToken&nsInstanceId=nsInstanceId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to include in the response. Valid Range: Minimum value of 1. Maximum value of 100. nextToken The token for the next page of results. nsInstanceId Network instance id filter, to retrieve network operations associated to a network instance. Pattern: ^ni-[a-f0-9]{17}$ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 ListSolNetworkOperations API Version 2008-10-21 84 AWS Telco Network Builder API Reference Content-type: application/json { "networkOperations": [ { "arn": "string", "error": { "detail": "string", "title": "string" }, "id": "string", "lcmOperationType": "string", "metadata": { "createdAt": "string", "lastModified": "string", "nsdInfoId": "string", "vnfInstanceId": "string" }, "nsInstanceId": "string", "operationState": "string", "updateType": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. networkOperations Lists network operation occurrences. Lifecycle management operations are deploy, update, or delete operations. Type: Array of ListSolNetworkOperationsInfo objects nextToken The token to use to retrieve the next page of results. This value is null when there are no more results to return. Response Elements API Version 2008-10-21 85 AWS Telco Network Builder Type: String Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 Errors API Version 2008-10-21 86 AWS Telco Network Builder • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2008-10-21 87 AWS Telco Network Builder API
|
tnb-api-017
|
tnb-api.pdf
| 17 |
HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 Errors API Version 2008-10-21 86 AWS Telco Network Builder • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2008-10-21 87 AWS Telco Network Builder API Reference ListSolNetworkPackages Lists 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 AWS infrastructure you want to deploy them on. Request Syntax GET /sol/nsd/v1/ns_descriptors?max_results=maxResults&nextpage_opaque_marker=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to include in the response. Valid Range: Minimum value of 1. Maximum value of 100. nextToken The token for the next page of results. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "networkPackages": [ { "arn": "string", "id": "string", ListSolNetworkPackages API Version 2008-10-21 88 AWS Telco Network Builder API Reference "metadata": { "createdAt": "string", "lastModified": "string" }, "nsdDesigner": "string", "nsdId": "string", "nsdInvariantId": "string", "nsdName": "string", "nsdOnboardingState": "string", "nsdOperationalState": "string", "nsdUsageState": "string", "nsdVersion": "string", "vnfPkgIds": [ "string" ] } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. networkPackages 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 AWS infrastructure you want to deploy them on. Type: Array of ListSolNetworkPackageInfo objects nextToken The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2008-10-21 89 API Reference AWS Telco Network Builder AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 90 AWS Telco Network Builder API Reference See Also API Version 2008-10-21 91 AWS Telco Network Builder API Reference ListTagsForResource Lists tags for AWS TNB resources. Request Syntax GET /tags/resourceArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn Resource ARN. Pattern: ^arn:aws:tnb:[a-z0-9-]+:[^:]*:.*$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ListTagsForResource API Version 2008-10-21 92 AWS Telco Network Builder tags API Reference A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. Errors API Version 2008-10-21 93 AWS Telco Network Builder HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK
|
tnb-api-018
|
tnb-api.pdf
| 18 |
Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. Errors API Version 2008-10-21 93 AWS Telco Network Builder HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 94 AWS Telco Network Builder API Reference PutSolFunctionPackageContent Uploads the contents of a function package. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. Request Syntax PUT /sol/vnfpkgm/v1/vnf_packages/vnfPkgId/package_content HTTP/1.1 Content-Type: contentType file URI Request Parameters The request uses the following URI parameters. contentType Function package content type. Valid Values: application/zip vnfPkgId Function package ID. Pattern: ^fp-[a-f0-9]{17}$ Required: Yes Request Body The request accepts the following binary data. file Function package file. PutSolFunctionPackageContent API Version 2008-10-21 95 API Reference AWS Telco Network Builder Required: Yes Response Syntax HTTP/1.1 202 Content-type: application/json { "id": "string", "metadata": { "vnfd": { "overrides": [ { "defaultValue": "string", "name": "string" } ] } }, "vnfdId": "string", "vnfdVersion": "string", "vnfProductName": "string", "vnfProvider": "string" } Response Elements If the action is successful, the service sends back an HTTP 202 response. The following data is returned in JSON format by the service. id Function package ID. Type: String Pattern: ^fp-[a-f0-9]{17}$ metadata Function package metadata. Response Syntax API Version 2008-10-21 96 AWS Telco Network Builder API Reference Type: PutSolFunctionPackageContentMetadata object vnfdId Function package descriptor ID. Type: String Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ vnfdVersion Function package descriptor version. Type: String vnfProductName Function product name. Type: String vnfProvider Function provider. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. Errors API Version 2008-10-21 97 AWS Telco Network Builder HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException API Reference Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 98 AWS Telco Network Builder API Reference PutSolNetworkPackageContent Uploads the contents of a network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the AWS infrastructure you want to deploy them on. Request Syntax PUT /sol/nsd/v1/ns_descriptors/nsdInfoId/nsd_content HTTP/1.1 Content-Type: contentType file URI Request Parameters The request uses the following URI parameters. contentType Network package content type. Valid Values: application/zip nsdInfoId Network service descriptor info ID. Pattern: ^np-[a-f0-9]{17}$ Required: Yes Request Body The request accepts the following binary data. file Network package file. Required: Yes PutSolNetworkPackageContent API Version 2008-10-21 99 API Reference AWS Telco Network Builder Response Syntax HTTP/1.1 200 Content-type: application/json { "arn": "string", "id": "string", "metadata": { "nsd": { "overrides": [ { "defaultValue": "string", "name": "string" } ] } }, "nsdId": "string", "nsdName": "string", "nsdVersion": "string", "vnfPkgIds": [ "string" ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. arn Network package ARN. Type: String 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})$ id Network package ID. Response Syntax API Version 2008-10-21 100 API Reference AWS Telco Network Builder Type: String Pattern: ^np-[a-f0-9]{17}$ metadata Network package metadata. Type: PutSolNetworkPackageContentMetadata object nsdId Network service descriptor ID. Type: String Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ nsdName Network service descriptor name. Type: String nsdVersion Network service descriptor version. Type: String vnfPkgIds Function package IDs. Type: Array of strings Pattern: ^fp-[a-f0-9]{17}$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions
|
tnb-api-019
|
tnb-api.pdf
| 19 |
response. The following data is returned in JSON format by the service. arn Network package ARN. Type: String 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})$ id Network package ID. Response Syntax API Version 2008-10-21 100 API Reference AWS Telco Network Builder Type: String Pattern: ^np-[a-f0-9]{17}$ metadata Network package metadata. Type: PutSolNetworkPackageContentMetadata object nsdId Network service descriptor ID. Type: String Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ nsdName Network service descriptor name. Type: String nsdVersion Network service descriptor version. Type: String vnfPkgIds Function package IDs. Type: Array of strings Pattern: ^fp-[a-f0-9]{17}$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. Errors API Version 2008-10-21 101 API Reference AWS Telco Network Builder HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python See Also API Version 2008-10-21 102 AWS Telco Network Builder • AWS SDK for Ruby V3 API Reference See Also API Version 2008-10-21 103 AWS Telco Network Builder TagResource Tags an AWS TNB resource. API Reference A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs. Request Syntax POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. resourceArn Resource ARN. Pattern: ^arn:aws:tnb:[a-z0-9-]+:[^:]*:.*$ Required: Yes Request Body The request accepts the following data in JSON format. tags A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs. Type: String to string map TagResource API Version 2008-10-21 104 AWS Telco Network Builder API Reference Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: Yes Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 Response Syntax API Version 2008-10-21 105 AWS Telco Network Builder ValidationException API Reference Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 106 AWS Telco Network Builder API Reference TerminateSolNetworkInstance Terminates a network instance. A network instance is a single network created in AWS TNB that can be deployed and on which life- cycle operations (like terminate, update, and delete) can be performed. You must terminate a network instance before you can delete it. Request Syntax POST /sol/nslcm/v1/ns_instances/nsInstanceId/terminate HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. nsInstanceId ID of the network instance. Pattern: ^ni-[a-f0-9]{17}$ Required: Yes Request Body The request accepts the following data in JSON format. tags A tag is a label that you assign to an AWS 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. TerminateSolNetworkInstance API Version 2008-10-21 107 AWS Telco Network Builder API Reference These tags are not applied to the network instance. Use tags to search and filter your resources or track your AWS
|
tnb-api-020
|
tnb-api.pdf
| 20 |
The request uses the following URI parameters. nsInstanceId ID of the network instance. Pattern: ^ni-[a-f0-9]{17}$ Required: Yes Request Body The request accepts the following data in JSON format. tags A tag is a label that you assign to an AWS 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. TerminateSolNetworkInstance API Version 2008-10-21 107 AWS Telco Network Builder API Reference These tags are not applied to the network instance. Use tags to search and filter your resources or track your AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No Response Syntax HTTP/1.1 201 Content-type: application/json { "nsLcmOpOccId": "string", "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. nsLcmOpOccId The identifier of the network operation. Type: String Pattern: ^no-[a-f0-9]{17}$ tags A tag is a label that you assign to an AWS 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. Response Syntax API Version 2008-10-21 108 AWS Telco Network Builder API Reference These tags are not applied to the network instance. Use tags to search and filter your resources or track your AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ServiceQuotaExceededException Service quotas have been exceeded. HTTP Status Code: 402 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 Errors API Version 2008-10-21 109 AWS Telco Network Builder ValidationException API Reference Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 110 AWS Telco Network Builder UntagResource Untags an AWS TNB resource. API Reference A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs. Request Syntax DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn Resource ARN. Pattern: ^arn:aws:tnb:[a-z0-9-]+:[^:]*:.*$ Required: Yes tagKeys Tag keys. Array Members: Minimum number of 0 items. Maximum number of 200 items. Pattern: ^(?!aws:).{1,128}$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 UntagResource API Version 2008-10-21 111 AWS Telco Network Builder Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Response Elements API Version 2008-10-21 112 API Reference AWS Telco Network Builder • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 113 AWS Telco Network Builder API Reference UpdateSolFunctionPackage Updates the operational state of function package. A function package is a .zip file in CSAR (Cloud
|
tnb-api-021
|
tnb-api.pdf
| 21 |
see the following: Response Elements API Version 2008-10-21 112 API Reference AWS Telco Network Builder • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 113 AWS Telco Network Builder API Reference UpdateSolFunctionPackage Updates the operational state of function package. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. Request Syntax PATCH /sol/vnfpkgm/v1/vnf_packages/vnfPkgId HTTP/1.1 Content-type: application/json { "operationalState": "string" } URI Request Parameters The request uses the following URI parameters. vnfPkgId ID of the function package. Pattern: ^fp-[a-f0-9]{17}$ Required: Yes Request Body The request accepts the following data in JSON format. operationalState Operational state of the function package. Type: String Valid Values: ENABLED | DISABLED UpdateSolFunctionPackage API Version 2008-10-21 114 API Reference AWS Telco Network Builder Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "operationalState": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operationalState Operational state of the function package. Type: String Valid Values: ENABLED | DISABLED Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 Response Syntax API Version 2008-10-21 115 API Reference AWS Telco Network Builder ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 116 AWS Telco Network Builder API Reference UpdateSolNetworkInstance Update a network instance. A network instance is a single network created in AWS TNB that can be deployed and on which life- cycle operations (like terminate, update, and delete) can be performed. Choose the updateType parameter to target the necessary update of the network instance. Request Syntax POST /sol/nslcm/v1/ns_instances/nsInstanceId/update HTTP/1.1 Content-type: application/json { "modifyVnfInfoData": { "vnfConfigurableProperties": JSON value, "vnfInstanceId": "string" }, "tags": { "string" : "string" }, "updateNs": { "additionalParamsForNs": JSON value, "nsdInfoId": "string" }, "updateType": "string" } URI Request Parameters The request uses the following URI parameters. nsInstanceId ID of the network instance. Pattern: ^ni-[a-f0-9]{17}$ Required: Yes UpdateSolNetworkInstance API Version 2008-10-21 117 AWS Telco Network Builder Request Body The request accepts the following data in JSON format. modifyVnfInfoData API Reference Identifies the network function information parameters and/or the configurable properties of the network function to be modified. Include this property only if the update type is MODIFY_VNF_INFORMATION. Type: UpdateSolNetworkModify object Required: No tags A tag is a label that you assign to an AWS 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 AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No updateNs Identifies the network service descriptor and the configurable properties of the descriptor, to be used for the update. Include this property only if the update type is UPDATE_NS. Type: UpdateSolNetworkServiceData object Required: No updateType The type of update. Request Body API Version 2008-10-21 118 AWS Telco Network Builder API Reference • Use the MODIFY_VNF_INFORMATION update type, to update a specific network function configuration, in the network instance. • Use the UPDATE_NS update type, to update the network instance to a new network service descriptor. Type: String Valid Values: MODIFY_VNF_INFORMATION | UPDATE_NS Required: Yes Response Syntax HTTP/1.1 201 Content-type: application/json { "nsLcmOpOccId": "string", "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an
|
tnb-api-022
|
tnb-api.pdf
| 22 |
only if the update type is UPDATE_NS. Type: UpdateSolNetworkServiceData object Required: No updateType The type of update. Request Body API Version 2008-10-21 118 AWS Telco Network Builder API Reference • Use the MODIFY_VNF_INFORMATION update type, to update a specific network function configuration, in the network instance. • Use the UPDATE_NS update type, to update the network instance to a new network service descriptor. Type: String Valid Values: MODIFY_VNF_INFORMATION | UPDATE_NS Required: Yes Response Syntax HTTP/1.1 201 Content-type: application/json { "nsLcmOpOccId": "string", "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. nsLcmOpOccId The identifier of the network operation. Type: String Pattern: ^no-[a-f0-9]{17}$ tags A tag is a label that you assign to an AWS 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. Response Syntax API Version 2008-10-21 119 AWS Telco Network Builder API Reference These tags are not applied to the network instance. Use tags to search and filter your resources or track your AWS costs. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 200 items. Key Pattern: ^(?!aws:).{1,128}$ Value Length Constraints: Minimum length of 0. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ServiceQuotaExceededException Service quotas have been exceeded. HTTP Status Code: 402 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 Errors API Version 2008-10-21 120 AWS Telco Network Builder ValidationException API Reference Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 121 AWS Telco Network Builder API Reference UpdateSolNetworkPackage Updates the operational state of a network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the AWS infrastructure you want to deploy them on. 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 AWS infrastructure you want to deploy the network functions on. Request Syntax PATCH /sol/nsd/v1/ns_descriptors/nsdInfoId HTTP/1.1 Content-type: application/json { "nsdOperationalState": "string" } URI Request Parameters The request uses the following URI parameters. nsdInfoId ID of the network service descriptor in the network package. Pattern: ^np-[a-f0-9]{17}$ Required: Yes Request Body The request accepts the following data in JSON format. nsdOperationalState Operational state of the network service descriptor in the network package. Type: String UpdateSolNetworkPackage API Version 2008-10-21 122 AWS Telco Network Builder API Reference Valid Values: ENABLED | DISABLED Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "nsdOperationalState": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nsdOperationalState Operational state of the network service descriptor in the network package. Type: String Valid Values: ENABLED | DISABLED Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 Response Syntax API Version 2008-10-21 123 API Reference AWS Telco Network Builder ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 124 AWS Telco Network
|
tnb-api-023
|
tnb-api.pdf
| 23 |
process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 124 AWS Telco Network Builder API Reference ValidateSolFunctionPackageContent Validates function package content. This can be used as a dry run before uploading function package content with PutSolFunctionPackageContent. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. Request Syntax PUT /sol/vnfpkgm/v1/vnf_packages/vnfPkgId/package_content/validate HTTP/1.1 Content-Type: contentType file URI Request Parameters The request uses the following URI parameters. contentType Function package content type. Valid Values: application/zip vnfPkgId Function package ID. Pattern: ^fp-[a-f0-9]{17}$ Required: Yes Request Body The request accepts the following binary data. file Function package file. ValidateSolFunctionPackageContent API Version 2008-10-21 125 API Reference AWS Telco Network Builder Required: Yes Response Syntax HTTP/1.1 202 Content-type: application/json { "id": "string", "metadata": { "vnfd": { "overrides": [ { "defaultValue": "string", "name": "string" } ] } }, "vnfdId": "string", "vnfdVersion": "string", "vnfProductName": "string", "vnfProvider": "string" } Response Elements If the action is successful, the service sends back an HTTP 202 response. The following data is returned in JSON format by the service. id Function package ID. Type: String Pattern: ^fp-[a-f0-9]{17}$ metadata Function package metadata. Response Syntax API Version 2008-10-21 126 AWS Telco Network Builder API Reference Type: ValidateSolFunctionPackageContentMetadata object vnfdId Function package descriptor ID. Type: String Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ vnfdVersion Function package descriptor version. Type: String vnfProductName Network function product name. Type: String vnfProvider Network function provider. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. Errors API Version 2008-10-21 127 AWS Telco Network Builder HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException API Reference Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2008-10-21 128 AWS Telco Network Builder API Reference ValidateSolNetworkPackageContent Validates network package content. This can be used as a dry run before uploading network package content with PutSolNetworkPackageContent. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the AWS infrastructure you want to deploy them on. Request Syntax PUT /sol/nsd/v1/ns_descriptors/nsdInfoId/nsd_content/validate HTTP/1.1 Content-Type: contentType file URI Request Parameters The request uses the following URI parameters. contentType Network package content type. Valid Values: application/zip nsdInfoId Network service descriptor file. Pattern: ^np-[a-f0-9]{17}$ Required: Yes Request Body The request accepts the following binary data. file Network package file. ValidateSolNetworkPackageContent API Version 2008-10-21 129 API Reference AWS Telco Network Builder Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "arn": "string", "id": "string", "metadata": { "nsd": { "overrides": [ { "defaultValue": "string", "name": "string" } ] } }, "nsdId": "string", "nsdName": "string", "nsdVersion": "string", "vnfPkgIds": [ "string" ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. arn Network package ARN. Type: String 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})$ Response Syntax API Version 2008-10-21 130 API Reference AWS Telco Network Builder id Network package ID. Type: String Pattern: ^np-[a-f0-9]{17}$ metadata Network package metadata. Type: ValidateSolNetworkPackageContentMetadata object nsdId Network service descriptor ID. Type: String Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ nsdName Network service descriptor name. Type: String nsdVersion Network service descriptor version. Type: String vnfPkgIds Function package IDs. Type: Array of strings Pattern: ^fp-[a-f0-9]{17}$ Errors For information about the errors that are common to all actions, see Common Errors. Errors API Version 2008-10-21 131 API Reference AWS Telco Network Builder AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error
|
tnb-api-024
|
tnb-api.pdf
| 24 |
(network-package/np-[a-f0-9]{17})$ Response Syntax API Version 2008-10-21 130 API Reference AWS Telco Network Builder id Network package ID. Type: String Pattern: ^np-[a-f0-9]{17}$ metadata Network package metadata. Type: ValidateSolNetworkPackageContentMetadata object nsdId Network service descriptor ID. Type: String Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ nsdName Network service descriptor name. Type: String nsdVersion Network service descriptor version. Type: String vnfPkgIds Function package IDs. Type: Array of strings Pattern: ^fp-[a-f0-9]{17}$ Errors For information about the errors that are common to all actions, see Common Errors. Errors API Version 2008-10-21 131 API Reference AWS Telco Network Builder AccessDeniedException Insufficient permissions to make request. HTTP Status Code: 403 InternalServerException Unexpected error occurred. Problem on the server. HTTP Status Code: 500 ResourceNotFoundException Request references a resource that doesn't exist. HTTP Status Code: 404 ThrottlingException Exception caused by throttling. HTTP Status Code: 429 ValidationException Unable to process the request because the client provided input failed to satisfy request constraints. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2008-10-21 132 AWS Telco Network Builder • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2008-10-21 133 AWS Telco Network Builder Data Types API Reference The AWS Telco Network Builder API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • ErrorInfo • FunctionArtifactMeta • GetSolFunctionInstanceMetadata • GetSolFunctionPackageMetadata • GetSolInstantiatedVnfInfo • GetSolNetworkInstanceMetadata • GetSolNetworkOperationMetadata • GetSolNetworkOperationTaskDetails • GetSolNetworkPackageMetadata • GetSolVnfcResourceInfo • GetSolVnfcResourceInfoMetadata • GetSolVnfInfo • InstantiateMetadata • LcmOperationInfo • ListSolFunctionInstanceInfo • ListSolFunctionInstanceMetadata • ListSolFunctionPackageInfo • ListSolFunctionPackageMetadata • ListSolNetworkInstanceInfo • ListSolNetworkInstanceMetadata API Version 2008-10-21 134 AWS Telco Network Builder API Reference • ListSolNetworkOperationsInfo • ListSolNetworkOperationsMetadata • ListSolNetworkPackageInfo • ListSolNetworkPackageMetadata • ModifyVnfInfoMetadata • NetworkArtifactMeta • ProblemDetails • PutSolFunctionPackageContentMetadata • PutSolNetworkPackageContentMetadata • ToscaOverride • UpdateNsMetadata • UpdateSolNetworkModify • UpdateSolNetworkServiceData • ValidateSolFunctionPackageContentMetadata • ValidateSolNetworkPackageContentMetadata API Version 2008-10-21 135 API Reference AWS Telco Network Builder ErrorInfo Provides error information. Contents cause Error cause. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Required: No details Error details. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ErrorInfo API Version 2008-10-21 136 AWS Telco Network Builder API Reference FunctionArtifactMeta Metadata for function package artifacts. Artifacts are the contents of the package descriptor file and the state of the package. Contents overrides Lists of function package overrides. Type: Array of ToscaOverride objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FunctionArtifactMeta API Version 2008-10-21 137 AWS Telco Network Builder API Reference GetSolFunctionInstanceMetadata The metadata of a network function instance. A network function instance is a function in a function package . Contents createdAt The date that the resource was created. Type: Timestamp Required: Yes lastModified The date that the resource was last modified. Type: Timestamp Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GetSolFunctionInstanceMetadata API Version 2008-10-21 138 AWS Telco Network Builder API Reference GetSolFunctionPackageMetadata Metadata related to the function package. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. Contents createdAt The date that the resource was created. Type: Timestamp Required: Yes lastModified The date that the resource was last modified. Type: Timestamp Required: Yes vnfd Metadata related to the function package descriptor of the function package. Type: FunctionArtifactMeta object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GetSolFunctionPackageMetadata API Version 2008-10-21 139 AWS Telco Network Builder API Reference See Also API Version 2008-10-21 140 AWS Telco Network Builder
|
tnb-api-025
|
tnb-api.pdf
| 25 |
Contents createdAt The date that the resource was created. Type: Timestamp Required: Yes lastModified The date that the resource was last modified. Type: Timestamp Required: Yes vnfd Metadata related to the function package descriptor of the function package. Type: FunctionArtifactMeta object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GetSolFunctionPackageMetadata API Version 2008-10-21 139 AWS Telco Network Builder API Reference See Also API Version 2008-10-21 140 AWS Telco Network Builder API Reference GetSolInstantiatedVnfInfo Information about a network function. A network instance is a single network created in AWS TNB that can be deployed and on which life- cycle operations (like terminate, update, and delete) can be performed. Contents vnfState State of the network function. Type: String Valid Values: STARTED | STOPPED Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GetSolInstantiatedVnfInfo API Version 2008-10-21 141 AWS Telco Network Builder API Reference GetSolNetworkInstanceMetadata The metadata of a network instance. A network instance is a single network created in AWS TNB that can be deployed and on which life- cycle operations (like terminate, update, and delete) can be performed. Contents createdAt The date that the resource was created. Type: Timestamp Required: Yes lastModified The date that the resource was last modified. Type: Timestamp Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GetSolNetworkInstanceMetadata API Version 2008-10-21 142 AWS Telco Network Builder API Reference GetSolNetworkOperationMetadata Metadata related to a network operation occurrence. A network operation is any operation that is done to your network, such as network instance instantiation or termination. Contents createdAt The date that the resource was created. Type: Timestamp Required: Yes lastModified The date that the resource was last modified. Type: Timestamp Required: Yes instantiateMetadata Metadata related to the network operation occurrence for network instantiation. This is populated only if the lcmOperationType is INSTANTIATE. Type: InstantiateMetadata object Required: No modifyVnfInfoMetadata Metadata related to the network operation occurrence for network function updates in a network instance. This is populated only if the lcmOperationType is UPDATE and the updateType is MODIFY_VNF_INFORMATION. Type: ModifyVnfInfoMetadata object Required: No GetSolNetworkOperationMetadata API Version 2008-10-21 143 AWS Telco Network Builder updateNsMetadata API Reference Metadata related to the network operation occurrence for network instance updates. This is populated only if the lcmOperationType is UPDATE and the updateType is UPDATE_NS. Type: UpdateNsMetadata object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2008-10-21 144 AWS Telco Network Builder API Reference GetSolNetworkOperationTaskDetails Gets the details of a network operation. A network operation is any operation that is done to your network, such as network instance instantiation or termination. Contents taskContext Context for the network operation task. Type: String to string map Required: No taskEndTime Task end time. Type: Timestamp Required: No taskErrorDetails Task error details. Type: ErrorInfo object Required: No taskName Task name. Type: String Required: No taskStartTime Task start time. Type: Timestamp GetSolNetworkOperationTaskDetails API Version 2008-10-21 145 AWS Telco Network Builder Required: No taskStatus Task status. Type: String API Reference Valid Values: SCHEDULED | STARTED | IN_PROGRESS | COMPLETED | ERROR | SKIPPED | CANCELLED Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2008-10-21 146 AWS Telco Network Builder API Reference GetSolNetworkPackageMetadata Metadata associated with a network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the AWS infrastructure you want to deploy them on. Contents createdAt The date that the resource was created. Type: Timestamp Required: Yes lastModified The date that the resource was last modified. Type: Timestamp Required: Yes nsd Metadata related to the onboarded network service descriptor in the network package. Type: NetworkArtifactMeta object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GetSolNetworkPackageMetadata API Version 2008-10-21 147 AWS Telco Network Builder API Reference See Also API Version
|
tnb-api-026
|
tnb-api.pdf
| 26 |
want to deploy them on. Contents createdAt The date that the resource was created. Type: Timestamp Required: Yes lastModified The date that the resource was last modified. Type: Timestamp Required: Yes nsd Metadata related to the onboarded network service descriptor in the network package. Type: NetworkArtifactMeta object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GetSolNetworkPackageMetadata API Version 2008-10-21 147 AWS Telco Network Builder API Reference See Also API Version 2008-10-21 148 AWS Telco Network Builder API Reference GetSolVnfcResourceInfo Details of resource associated with a network function. A network instance is a single network created in AWS TNB that can be deployed and on which life- cycle operations (like terminate, update, and delete) can be performed. Contents metadata The metadata of the network function compute. Type: GetSolVnfcResourceInfoMetadata object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GetSolVnfcResourceInfo API Version 2008-10-21 149 AWS Telco Network Builder API Reference GetSolVnfcResourceInfoMetadata The metadata of a network function. A network instance is a single network created in AWS TNB that can be deployed and on which life- cycle operations (like terminate, update, and delete) can be performed. Contents cluster Information about the cluster. Type: String Required: No helmChart Information about the helm chart. Type: String Required: No nodeGroup Information about the node group. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GetSolVnfcResourceInfoMetadata API Version 2008-10-21 150 AWS Telco Network Builder API Reference See Also API Version 2008-10-21 151 API Reference AWS Telco Network Builder GetSolVnfInfo Information about the network function. A network function instance is a function in a function package . Contents vnfcResourceInfo Compute info used by the network function instance. Type: Array of GetSolVnfcResourceInfo objects Required: No vnfState State of the network function instance. Type: String Valid Values: STARTED | STOPPED Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GetSolVnfInfo API Version 2008-10-21 152 AWS Telco Network Builder API Reference InstantiateMetadata Metadata related to the configuration properties used during instantiation of the network instance. Contents nsdInfoId The network service descriptor used for instantiating the network instance. Type: String Pattern: ^np-[a-f0-9]{17}$ Required: Yes additionalParamsForNs The configurable properties used during instantiation. Type: JSON value Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InstantiateMetadata API Version 2008-10-21 153 AWS Telco Network Builder LcmOperationInfo API Reference Lifecycle management operation details on the network instance. Lifecycle management operations are deploy, update, or delete operations. Contents nsLcmOpOccId The identifier of the network operation. Type: String Pattern: ^no-[a-f0-9]{17}$ Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LcmOperationInfo API Version 2008-10-21 154 AWS Telco Network Builder API Reference ListSolFunctionInstanceInfo Lists information about a network function instance. A network function instance is a function in a function package . Contents arn Network function instance ARN. Type: String 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})$ Required: Yes id Network function instance ID. Type: String Pattern: ^fi-[a-f0-9]{17}$ Required: Yes instantiationState Network function instance instantiation state. Type: String Valid Values: INSTANTIATED | NOT_INSTANTIATED Required: Yes metadata Network function instance metadata. Type: ListSolFunctionInstanceMetadata object ListSolFunctionInstanceInfo API Version 2008-10-21 155 API Reference AWS Telco Network Builder Required: Yes nsInstanceId Network instance ID. Type: String Pattern: ^ni-[a-f0-9]{17}$ Required: Yes vnfPkgId Function package ID. Type: String Pattern: ^fp-[a-f0-9]{17}$ Required: Yes instantiatedVnfInfo Information about a network function. A network instance is a single network created in AWS TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Type: GetSolInstantiatedVnfInfo object Required: No vnfPkgName Function package name. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2008-10-21 156 AWS Telco Network Builder • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version
|
tnb-api-027
|
tnb-api.pdf
| 27 |
Yes instantiatedVnfInfo Information about a network function. A network instance is a single network created in AWS TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Type: GetSolInstantiatedVnfInfo object Required: No vnfPkgName Function package name. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2008-10-21 156 AWS Telco Network Builder • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2008-10-21 157 AWS Telco Network Builder API Reference ListSolFunctionInstanceMetadata Lists network function instance metadata. A network function instance is a function in a function package . Contents createdAt When the network function instance was created. Type: Timestamp Required: Yes lastModified When the network function instance was last modified. Type: Timestamp Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ListSolFunctionInstanceMetadata API Version 2008-10-21 158 AWS Telco Network Builder API Reference ListSolFunctionPackageInfo Information about a function package. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. Contents arn Function package ARN. Type: String 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})$ Required: Yes id ID of the function package. Type: String Pattern: ^fp-[a-f0-9]{17}$ Required: Yes onboardingState Onboarding state of the function package. Type: String Valid Values: CREATED | ONBOARDED | ERROR Required: Yes operationalState Operational state of the function package. ListSolFunctionPackageInfo API Version 2008-10-21 159 API Reference AWS Telco Network Builder Type: String Valid Values: ENABLED | DISABLED Required: Yes usageState Usage state of the function package. Type: String Valid Values: IN_USE | NOT_IN_USE Required: Yes metadata The metadata of the function package. Type: ListSolFunctionPackageMetadata object Required: No vnfdId Identifies the function package and the function package descriptor. Type: String Required: No vnfdVersion Identifies the version of the function package descriptor. Type: String Required: No vnfProductName The product name for the network function. Type: String Required: No Contents API Version 2008-10-21 160 AWS Telco Network Builder vnfProvider API Reference Provider of the function package and the function package descriptor. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2008-10-21 161 AWS Telco Network Builder API Reference ListSolFunctionPackageMetadata Details for the function package metadata. 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. Contents createdAt The date that the resource was created. Type: Timestamp Required: Yes lastModified The date that the resource was last modified. Type: Timestamp Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ListSolFunctionPackageMetadata API Version 2008-10-21 162 AWS Telco Network Builder API Reference ListSolNetworkInstanceInfo Info about the specific network instance. A network instance is a single network created in AWS TNB that can be deployed and on which life- cycle operations (like terminate, update, and delete) can be performed. Contents arn Network instance ARN. Type: String 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})$ Required: Yes id ID of the network instance. Type: String Pattern: ^ni-[a-f0-9]{17}$ Required: Yes metadata The metadata of the network instance. Type: ListSolNetworkInstanceMetadata object Required: Yes nsdId ID of the network service descriptor in the network package. Type: String Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ ListSolNetworkInstanceInfo API Version 2008-10-21 163 AWS Telco Network Builder Required: Yes nsdInfoId ID of the network service descriptor in the network package. API Reference Type: String Pattern: ^np-[a-f0-9]{17}$ Required: Yes nsInstanceDescription Human-readable description of the network instance. Type: String Required: Yes nsInstanceName Human-readable name of the network instance. Type: String Required: Yes nsState The state of the network instance. Type: String Valid Values: INSTANTIATED | NOT_INSTANTIATED | UPDATED | IMPAIRED | UPDATE_FAILED | STOPPED | DELETED | INSTANTIATE_IN_PROGRESS | INTENT_TO_UPDATE_IN_PROGRESS | UPDATE_IN_PROGRESS | TERMINATE_IN_PROGRESS Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2008-10-21 164 AWS Telco Network Builder • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for
|
tnb-api-028
|
tnb-api.pdf
| 28 |
nsInstanceDescription Human-readable description of the network instance. Type: String Required: Yes nsInstanceName Human-readable name of the network instance. Type: String Required: Yes nsState The state of the network instance. Type: String Valid Values: INSTANTIATED | NOT_INSTANTIATED | UPDATED | IMPAIRED | UPDATE_FAILED | STOPPED | DELETED | INSTANTIATE_IN_PROGRESS | INTENT_TO_UPDATE_IN_PROGRESS | UPDATE_IN_PROGRESS | TERMINATE_IN_PROGRESS Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2008-10-21 164 AWS Telco Network Builder • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2008-10-21 165 AWS Telco Network Builder API Reference ListSolNetworkInstanceMetadata Metadata details for a network instance. A network instance is a single network created in AWS TNB that can be deployed and on which life- cycle operations (like terminate, update, and delete) can be performed. Contents createdAt The date that the resource was created. Type: Timestamp Required: Yes lastModified The date that the resource was last modified. Type: Timestamp Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ListSolNetworkInstanceMetadata API Version 2008-10-21 166 AWS Telco Network Builder API Reference ListSolNetworkOperationsInfo Information parameters for a network operation. Contents arn Network operation ARN. Type: String 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})$ Required: Yes id ID of this network operation. Type: String Pattern: ^no-[a-f0-9]{17}$ Required: Yes lcmOperationType Type of lifecycle management network operation. Type: String Valid Values: INSTANTIATE | UPDATE | TERMINATE Required: Yes nsInstanceId ID of the network instance related to this operation. Type: String Pattern: ^ni-[a-f0-9]{17}$ ListSolNetworkOperationsInfo API Version 2008-10-21 167 AWS Telco Network Builder Required: Yes operationState The state of the network operation. Type: String API Reference Valid Values: PROCESSING | COMPLETED | FAILED | CANCELLING | CANCELLED Required: Yes error Error related to this specific network operation. Type: ProblemDetails object Required: No metadata Metadata related to this network operation. Type: ListSolNetworkOperationsMetadata object Required: No updateType Type of the update. Only present if the network operation lcmOperationType is UPDATE. Type: String Valid Values: MODIFY_VNF_INFORMATION | UPDATE_NS Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 See Also API Version 2008-10-21 168 AWS Telco Network Builder • AWS SDK for Ruby V3 API Reference See Also API Version 2008-10-21 169 AWS Telco Network Builder API Reference ListSolNetworkOperationsMetadata Metadata related to a network operation. A network operation is any operation that is done to your network, such as network instance instantiation or termination. Contents createdAt The date that the resource was created. Type: Timestamp Required: Yes lastModified The date that the resource was last modified. Type: Timestamp Required: Yes nsdInfoId The network service descriptor id used for the operation. Only present if the updateType is UPDATE_NS. Type: String Pattern: ^np-[a-f0-9]{17}$ Required: No vnfInstanceId The network function id used for the operation. Only present if the updateType is MODIFY_VNF_INFO. Type: String ListSolNetworkOperationsMetadata API Version 2008-10-21 170 AWS Telco Network Builder API Reference Pattern: ^fi-[a-f0-9]{17}$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2008-10-21 171 AWS Telco Network Builder API Reference ListSolNetworkPackageInfo Details of a network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the AWS infrastructure you want to deploy them on. Contents arn Network package ARN. Type: String 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})$ Required: Yes id ID of the individual network package. Type: String Pattern: ^np-[a-f0-9]{17}$ Required: Yes metadata The metadata of the network package. Type: ListSolNetworkPackageMetadata object Required: Yes nsdOnboardingState Onboarding state of the network service descriptor in the network package. Type: String ListSolNetworkPackageInfo API Version 2008-10-21 172 AWS Telco Network Builder API Reference Valid Values: CREATED | ONBOARDED | ERROR Required: Yes nsdOperationalState Operational state of the network service descriptor in the network package. Type: String Valid Values: ENABLED | DISABLED Required: Yes nsdUsageState Usage state of the network service descriptor in the network package. Type: String Valid Values: IN_USE | NOT_IN_USE Required: Yes nsdDesigner Designer of the onboarded network service descriptor in the network package. Type: String Required: No nsdId ID of the network service descriptor on which the network package is based. Type: String Required: No nsdInvariantId Identifies a network service descriptor in a version independent manner. Type: String Required: No Contents API Version 2008-10-21 173 AWS Telco Network Builder nsdName API Reference
|
tnb-api-029
|
tnb-api.pdf
| 29 |
of the network service descriptor in the network package. Type: String Valid Values: ENABLED | DISABLED Required: Yes nsdUsageState Usage state of the network service descriptor in the network package. Type: String Valid Values: IN_USE | NOT_IN_USE Required: Yes nsdDesigner Designer of the onboarded network service descriptor in the network package. Type: String Required: No nsdId ID of the network service descriptor on which the network package is based. Type: String Required: No nsdInvariantId Identifies a network service descriptor in a version independent manner. Type: String Required: No Contents API Version 2008-10-21 173 AWS Telco Network Builder nsdName API Reference Name of the onboarded network service descriptor in the network package. Type: String Required: No nsdVersion Version of the onboarded network service descriptor in the network package. Type: String Required: No vnfPkgIds Identifies the function package for the function package descriptor referenced by the onboarded network package. Type: Array of strings Pattern: ^fp-[a-f0-9]{17}$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2008-10-21 174 AWS Telco Network Builder API Reference ListSolNetworkPackageMetadata Metadata related to a network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the AWS infrastructure you want to deploy them on. Contents createdAt The date that the resource was created. Type: Timestamp Required: Yes lastModified The date that the resource was last modified. Type: Timestamp Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ListSolNetworkPackageMetadata API Version 2008-10-21 175 AWS Telco Network Builder API Reference ModifyVnfInfoMetadata Metadata related to the configuration properties used during update of a specific network function in a network instance. Contents vnfConfigurableProperties The configurable properties used during update of the network function instance. Type: JSON value Required: Yes vnfInstanceId The network function instance that was updated in the network instance. Type: String Pattern: ^fi-[a-f0-9]{17}$ Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ModifyVnfInfoMetadata API Version 2008-10-21 176 AWS Telco Network Builder API Reference NetworkArtifactMeta Metadata for network package artifacts. Artifacts are the contents of the package descriptor file and the state of the package. Contents overrides Lists network package overrides. Type: Array of ToscaOverride objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 NetworkArtifactMeta API Version 2008-10-21 177 AWS Telco Network Builder ProblemDetails Details related to problems with AWS TNB resources. Contents detail A human-readable explanation specific to this occurrence of the problem. API Reference Type: String Required: Yes title A human-readable title of the problem type. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ProblemDetails API Version 2008-10-21 178 AWS Telco Network Builder API Reference PutSolFunctionPackageContentMetadata Update metadata in a function package. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. Contents vnfd Metadata for function package artifacts. Artifacts are the contents of the package descriptor file and the state of the package. Type: FunctionArtifactMeta object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PutSolFunctionPackageContentMetadata API Version 2008-10-21 179 AWS Telco Network Builder API Reference PutSolNetworkPackageContentMetadata Update metadata in a network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the AWS infrastructure you want to deploy them on. Contents nsd Metadata for network package artifacts. Artifacts are the contents of the package descriptor file and the state of the package. Type: NetworkArtifactMeta object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2
|
tnb-api-030
|
tnb-api.pdf
| 30 |
Telco Network Builder API Reference PutSolNetworkPackageContentMetadata Update metadata in a network package. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the AWS infrastructure you want to deploy them on. Contents nsd Metadata for network package artifacts. Artifacts are the contents of the package descriptor file and the state of the package. Type: NetworkArtifactMeta object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PutSolNetworkPackageContentMetadata API Version 2008-10-21 180 API Reference AWS Telco Network Builder ToscaOverride Overrides of the TOSCA node. Contents defaultValue Default value for the override. Type: String Required: No name Name of the TOSCA override. Type: String Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ToscaOverride API Version 2008-10-21 181 AWS Telco Network Builder UpdateNsMetadata API Reference Metadata related to the configuration properties used during update of a network instance. Contents nsdInfoId The network service descriptor used for updating the network instance. Type: String Pattern: ^np-[a-f0-9]{17}$ Required: Yes additionalParamsForNs The configurable properties used during update. Type: JSON value Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 UpdateNsMetadata API Version 2008-10-21 182 AWS Telco Network Builder API Reference UpdateSolNetworkModify Information parameters and/or the configurable properties for a network function. A network function instance is a function in a function package . Contents vnfConfigurableProperties Provides values for the configurable properties declared in the function package descriptor. Type: JSON value Required: Yes vnfInstanceId ID of the network function instance. A network function instance is a function in a function package . Type: String Pattern: ^fi-[a-f0-9]{17}$ Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 UpdateSolNetworkModify API Version 2008-10-21 183 AWS Telco Network Builder API Reference UpdateSolNetworkServiceData Information parameters and/or the configurable properties for a network descriptor used for update. Contents nsdInfoId ID of the network service descriptor. Type: String Pattern: ^np-[a-f0-9]{17}$ Required: Yes additionalParamsForNs Values for the configurable properties declared in the network service descriptor. Type: JSON value Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 UpdateSolNetworkServiceData API Version 2008-10-21 184 AWS Telco Network Builder API Reference ValidateSolFunctionPackageContentMetadata Validates function package content metadata. 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. Contents vnfd Metadata for function package artifacts. Artifacts are the contents of the package descriptor file and the state of the package. Type: FunctionArtifactMeta object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ValidateSolFunctionPackageContentMetadata API Version 2008-10-21 185 AWS Telco Network Builder API Reference ValidateSolNetworkPackageContentMetadata Validates network package content metadata. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the AWS infrastructure you want to deploy them on. Contents nsd Metadata for network package artifacts. Artifacts are the contents of the package descriptor file and the state of the package. Type: NetworkArtifactMeta object Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ValidateSolNetworkPackageContentMetadata API Version 2008-10-21 186 AWS Telco Network Builder API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required:
|
tnb-api-031
|
tnb-api.pdf
| 31 |
AWS SDK for Java V2 • AWS SDK for Ruby V3 ValidateSolNetworkPackageContentMetadata API Version 2008-10-21 186 AWS Telco Network Builder API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2008-10-21 187 AWS Telco Network Builder API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. API Version 2008-10-21 188 AWS Telco Network Builder Type: string Required: Conditional X-Amz-SignedHeaders API Reference Specifies all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional API Version 2008-10-21 189 AWS Telco Network Builder API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors specific to an API action for this service, see the topic for that API action. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 ExpiredTokenException The security token included in the request is expired HTTP Status Code: 403 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 403 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 MalformedHttpRequestException Problems with the request at the HTTP level, e.g. we can't decompress the body according to the decompression algorithm specified by the content-encoding. HTTP Status Code: 400 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 401 OptInRequired The AWS access key ID needs a subscription for the service. API Version 2008-10-21 190 AWS Telco Network Builder HTTP Status Code: 403 RequestAbortedException API Reference Convenient exception that can be used when a request is aborted before a reply is sent back (e.g. client closed connection). HTTP Status Code: 400 RequestEntityTooLargeException Problems with the request at the HTTP level. The request entity is too large. HTTP Status Code: 413 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 RequestTimeoutException Problems with the request at the HTTP level. Reading the Request timed out. HTTP Status Code: 408 ServiceUnavailable The request has failed due to a temporary failure of the
|
tnb-api-032
|
tnb-api.pdf
| 32 |
RequestEntityTooLargeException Problems with the request at the HTTP level. The request entity is too large. HTTP Status Code: 413 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 RequestTimeoutException Problems with the request at the HTTP level. Reading the Request timed out. HTTP Status Code: 408 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 UnrecognizedClientException The X.509 certificate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 API Version 2008-10-21 191 AWS Telco Network Builder UnknownOperationException API Reference The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 404 ValidationError The input fails to satisfy the constraints specified by an AWS service. HTTP Status Code: 400 API Version 2008-10-21 192
|
tnb-guide-001
|
tnb-guide.pdf
| 1 |
User Guide AWS Telco Network Builder Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS Telco Network Builder User Guide AWS Telco Network Builder: User Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS Telco Network Builder Table of Contents User Guide What is AWS TNB? ........................................................................................................................... 1 New to AWS? ................................................................................................................................................. 2 Who is AWS TNB for? .................................................................................................................................. 2 AWS TNB features ........................................................................................................................................ 2 Accessing AWS TNB ...................................................................................................................................... 3 Pricing for AWS TNB .................................................................................................................................... 4 What's next .................................................................................................................................................... 4 How AWS TNB works ...................................................................................................................... 5 Architecture .................................................................................................................................................... 5 Integration ...................................................................................................................................................... 6 Quotas ............................................................................................................................................................. 7 AWS TNB concepts .......................................................................................................................... 8 Lifecycle of a network function ................................................................................................................ 8 Use standardized interfaces ....................................................................................................................... 9 Network function packages ..................................................................................................................... 10 AWS TNB network service descriptors ................................................................................................... 11 Management and operations ................................................................................................................... 12 Network service descriptors ..................................................................................................................... 13 Setting up AWS TNB ..................................................................................................................... 15 Sign up for an AWS account ................................................................................................................... 15 Create a user with administrative access .............................................................................................. 16 Choose an AWS Region ............................................................................................................................. 17 Note the service endpoint ........................................................................................................................ 17 (Optional) Install the AWS CLI ................................................................................................................ 18 Set up AWS TNB roles .............................................................................................................................. 18 Getting started with AWS TNB ..................................................................................................... 20 Prerequisites ................................................................................................................................................ 20 Create a function package ....................................................................................................................... 21 Create a network package ....................................................................................................................... 21 Create and instantiate a network instance ........................................................................................... 22 Clean up ....................................................................................................................................................... 22 Function packages ......................................................................................................................... 24 Create ............................................................................................................................................................ 21 View ............................................................................................................................................................... 25 iii AWS Telco Network Builder User Guide Download a package ................................................................................................................................. 26 Delete a package ........................................................................................................................................ 26 AWS TNB network packages ......................................................................................................... 28 Create ............................................................................................................................................................ 21 View ............................................................................................................................................................... 29 Download ..................................................................................................................................................... 30 Delete ............................................................................................................................................................ 30 Network .......................................................................................................................................... 32 Life cycle operations .................................................................................................................................. 32 Create ............................................................................................................................................................ 22 Instantiate .................................................................................................................................................... 34 Update a function instance ...................................................................................................................... 35 Update a network instance ...................................................................................................................... 36 Considerations ....................................................................................................................................... 36 Parameters that you can update ....................................................................................................... 36 Updating a network instance ............................................................................................................. 54 View ............................................................................................................................................................... 55 Terminate and delete ................................................................................................................................ 55 Network operations ....................................................................................................................... 57 View ............................................................................................................................................................... 57 Cancel ............................................................................................................................................................ 58 TOSCA reference ............................................................................................................................ 59 VNFD template ........................................................................................................................................... 59 Syntax ...................................................................................................................................................... 59 Topology template ............................................................................................................................... 59 AWS.VNF .................................................................................................................................................. 60 AWS.Artifacts.Helm .............................................................................................................................. 61 NSD template .............................................................................................................................................. 62 Syntax ...................................................................................................................................................... 62 Using defined parameters ................................................................................................................... 63 VNFD import .......................................................................................................................................... 63 Topology template ............................................................................................................................... 64 AWS.NS .................................................................................................................................................... 65 AWS.Compute.EKS ................................................................................................................................ 66 AWS.Compute.EKS.AuthRole .............................................................................................................. 70 AWS.Compute.EKSManagedNode ...................................................................................................... 71 iv AWS Telco Network Builder User Guide AWS.Compute.EKSSelfManagedNode ............................................................................................... 79 AWS.Compute.PlacementGroup ......................................................................................................... 85 AWS.Compute.UserData ....................................................................................................................... 87 AWS.Networking.SecurityGroup ......................................................................................................... 89 AWS.Networking.SecurityGroupEgressRule ..................................................................................... 90 AWS.Networking.SecurityGroupIngressRule .................................................................................... 93 AWS.Resource.Import ........................................................................................................................... 96 AWS.Networking.ENI ............................................................................................................................ 97 AWS.HookExecution .............................................................................................................................. 99 AWS.Networking.InternetGateway .................................................................................................. 101 AWS.Networking.RouteTable ............................................................................................................ 103 AWS.Networking.Subnet ................................................................................................................... 104 AWS.Deployment.VNFDeployment .................................................................................................. 107 AWS.Networking.VPC ......................................................................................................................... 109 AWS.Networking.NATGateway ......................................................................................................... 111 AWS.Networking.Route ...................................................................................................................... 112 AWS.Store.SSMParameters ............................................................................................................... 114 Common nodes ........................................................................................................................................ 115 AWS.HookDefinition.Bash ................................................................................................................. 115 Security ........................................................................................................................................ 118 Data protection ........................................................................................................................................ 118 Data handling ...................................................................................................................................... 119 Encryption at rest ............................................................................................................................... 120 Encryption in transit .......................................................................................................................... 120 Inter-network traffic privacy ............................................................................................................ 120 Identity and access management ......................................................................................................... 120 Audience ............................................................................................................................................... 120 Authenticating with identities ......................................................................................................... 121 Managing access using policies ....................................................................................................... 124 How AWS TNB works with IAM ....................................................................................................... 127 Identity-based policy examples ....................................................................................................... 133 Troubleshooting .................................................................................................................................. 147 Compliance validation ............................................................................................................................ 149 Resilience ................................................................................................................................................... 150 Infrastructure security ............................................................................................................................. 151 Network connectivity security model ............................................................................................. 152 v AWS Telco Network Builder User Guide IMDS version ............................................................................................................................................. 152 Monitoring ................................................................................................................................... 153 CloudTrail logs .......................................................................................................................................... 153 AWS TNB event examples ................................................................................................................ 155 Deployment tasks .................................................................................................................................... 156 Quotas .......................................................................................................................................... 159 Document history ........................................................................................................................ 160 vi AWS Telco Network Builder User Guide What is AWS Telco Network Builder? AWS Telco Network Builder (AWS TNB) is an AWS service that provides communication service providers (CSPs) with an efficient way to deploy, manage, and scale 5G networks on AWS infrastructure. With AWS TNB, you deploy scalable and secure 5G networks in the AWS Cloud using an image of your network in an automated manner. You don't need to learn new technologies, decide which compute service to use, or know how to provision and configure AWS resources. Instead, you describe your network's infrastructure and provide the software images of network functions from your independent software vendor (ISV) partners. AWS TNB integrates with third- party service orchestrators and AWS services to automatically provision the necessary AWS infrastructure, deploy containerized network functions, and configure networking and access management to create a fully operational network service. The following diagram illustrates the logical integrations between AWS TNB and service orchestrators to deploy network functions by using European Telecommunications Standards Institute
|
tnb-guide-002
|
tnb-guide.pdf
| 2 |
don't need to learn new technologies, decide which compute service to use, or know how to provision and configure AWS resources. Instead, you describe your network's infrastructure and provide the software images of network functions from your independent software vendor (ISV) partners. AWS TNB integrates with third- party service orchestrators and AWS services to automatically provision the necessary AWS infrastructure, deploy containerized network functions, and configure networking and access management to create a fully operational network service. The following diagram illustrates the logical integrations between AWS TNB and service orchestrators to deploy network functions by using European Telecommunications Standards Institute (ETSI)-based standard interfaces. 1 User Guide AWS Telco Network Builder Topics • New to AWS? • Who is AWS TNB for? • AWS TNB features • Accessing AWS TNB • Pricing for AWS TNB • What's next New to AWS? If you are new to AWS products and services, begin learning more with the following resources: • Introduction to AWS • Getting started with AWS Who is AWS TNB for? AWS TNB is for CSPs looking to take advantage of the cost-efficiencies, agility, and elasticity the AWS Cloud offers without writing and maintaining custom scripts and configurations to design, deploy, and manage network services. AWS TNB automatically provisions the necessary AWS infrastructure, deploys containerized network functions, and configures networking and access management to create fully operational network services based on the CSP-defined network service descriptors, and the network functions that the CSP wants to deploy. AWS TNB features The following are some of the reasons that a CSP would want to use AWS TNB: Helps simplify tasks Provide more efficiency to your network operations, such as deploying new services, updating and upgrading network functions, and changing network infrastructure topologies. Integrates with orchestrators AWS TNB integrates with popular third-party service orchestrators that are ETSI-compliant. New to AWS? 2 AWS Telco Network Builder Scales User Guide You can configure AWS TNB to scale underlying AWS resources to meet traffic demand, more efficiently perform network function updates, roll out network infrastructure topology changes, and reduce deployment time of new 5G services from days to hours. Inspects and monitors AWS resources AWS TNB lets you Inspect and monitor the AWS resources that support your network on a single dashboard, such as Amazon VPC, Amazon EC2, and Amazon EKS. Supports service templates AWS TNB allows you to create service templates for all telecom workloads (RAN, Core, IMS). You can create a new service definition, reuse an existing template, or integrate with a continuous integration and continuous delivery (CI/CD) pipeline to publish a new definition. Tracks changes to network deployments When you change the underlying configuration of a network function deployment, for example, changing the instance type of an Amazon EC2 instance type, you can track the changes in a repeatable and scalable manner. Doing so manually would require managing the state of the network, creating and deleting resources, and paying attention to the order of the changes needed. When you use AWS TNB to manage the lifecycle of your network function, you only make the changes to your network service descriptors describing the network function. AWS TNB will then automatically make the required changes in the correct order. Simplifies the network function lifecycle You can manage the first and all subsequent versions of a network function and specify when to upgrade. You can also manage your RAN, Core, IMS, and network applications in the same way. Accessing AWS TNB You can create, access, and manage your AWS TNB resources using any of the following interfaces: • AWS TNB console — Provides a web interface for managing your network. • AWS TNB API — Provides a RESTful API for performing AWS TNB actions. For more information see AWS TNB API Reference Accessing AWS TNB 3 AWS Telco Network Builder User Guide • AWS Command Line Interface (AWS CLI) — Provides commands for a broad set of AWS services, including AWS TNB. It's supported on Windows, macOS, and Linux. For more information, see the AWS Command Line Interface User Guide. • AWS SDKs – Provides language-specific APIs and completes many of the connection details. These include calculating signatures, handling request retries, and error handling. For more information, see AWS SDKs. Pricing for AWS TNB AWS TNB helps CSPs automate the deployment and management of their telecom networks on AWS. You pay for the following two dimensions when you use AWS TNB: • By managed network function item (MNFI) hours. • By number of API requests. You also incur additional charges as you use other AWS services in conjunction with AWS TNB. For more information, see AWS TNB Pricing. To view your bill, go to the Billing and Cost Management Dashboard in the AWS Billing and Cost Management console. Your bill contains links to usage reports that provide
|
tnb-guide-003
|
tnb-guide.pdf
| 3 |
see AWS SDKs. Pricing for AWS TNB AWS TNB helps CSPs automate the deployment and management of their telecom networks on AWS. You pay for the following two dimensions when you use AWS TNB: • By managed network function item (MNFI) hours. • By number of API requests. You also incur additional charges as you use other AWS services in conjunction with AWS TNB. For more information, see AWS TNB Pricing. To view your bill, go to the Billing and Cost Management Dashboard in the AWS Billing and Cost Management console. Your bill contains links to usage reports that provide additional details about your bill. For more information about AWS account billing, see AWS Account Billing. If you have questions concerning AWS billing, accounts, and events, contact AWS Support. AWS Trusted Advisor is a service that you can use to help optimize the costs, security, and performance of your AWS environment. For more information, see AWS Trusted Advisor. What's next For more information about how to get started with AWS TNB, see the following topics: • Setting up AWS TNB – Complete the prerequisite steps. • Getting started with AWS TNB – Deploy your first network function, such as Centralized Unit (CU), Access and Mobility Management Function (AMF), User Plane Function (UPF), or a complete 5G Core. Pricing for AWS TNB 4 AWS Telco Network Builder User Guide How AWS TNB works AWS TNB integrates with standardized end-to-end orchestrators and AWS resources to operate full 5G networks. AWS TNB allows you to ingest network function packages and network service descriptors (NSDs) and provides you with the automation engine to operate your networks. You can use your end- to-end orchestrator and integrate with AWS TNB APIs, or use AWS TNB SDKs to build your own automation flow. For more information, see AWS TNB architecture . Topics • AWS TNB architecture • Integration with AWS services • AWS TNB resource quotas AWS TNB architecture AWS TNB provides you with the ability to perform lifecycle management operations through the AWS Management Console, AWS CLI, AWS TNB REST API, and SDKs. This allows the different CSP personas, such as members of the Engineering, Operations, and Programmatic System teams, to take advantage of AWS TNB. You create and upload a network function package as a Cloud Service Archive (CSAR) file. The CSAR file contains Helm charts, software images, and a Network Function Descriptor (NFD). You can use templates to repeatedly deploy multiple configurations of that package. You create network service templates defining the infrastructure and the network functions that you want to deploy. You can use parameter overrides to deploy different configurations in different locations. You can then instantiate a network, using the templates and deploy your network functions on AWS infrastructure. AWS TNB provides you with the visibility of your deployments. Architecture 5 AWS Telco Network Builder User Guide Integration with AWS services A 5G network is made up of a set of interconnected containerized network functions deployed across thousands of Kubernetes clusters. AWS TNB integrates with the following AWS services as telecom-specific APIs to create a fully operational network service: • Amazon Elastic Container Registry (Amazon ECR) to store Independent Software Vendors (ISVs) network functions artifacts. • Amazon Elastic Kubernetes Service (Amazon EKS) to set up clusters. • Amazon VPC for networking constructs. • Security groups using AWS CloudFormation. • AWS CodePipeline for deployment targets across AWS Regions, AWS Local Zones, and AWS Outposts. • IAM to define roles. • AWS Organizations to control access to AWS TNB APIs. • AWS Health Dashboard and AWS CloudTrail to monitor health and post metrics. Integration 6 AWS Telco Network Builder User Guide AWS TNB resource quotas Your AWS account has default quotas, formerly referred to as limits, for each AWS service. Unless otherwise noted, each quota is specific to an AWS Region. You can request increases for some quotas, but not for all quotas. To view the quotas for AWS TNB, open the Service Quotas console. In the navigation pane, choose AWS services, and select AWS TNB. To request a quota increase, see Requesting a quota increase in the Service Quotas User Guide. Your AWS account has the following quotas related to AWS TNB. Resource quota Description Default value Adjustable? Network service instances The maximum number of network service instances in one Region. 800 Concurren t ongoing The maximum number of concurren t ongoing network service operation 40 network service s in one Region. operations Network packages Function packages The maximum number of network packages in one Region. The maximum number of function packages in one Region. 40 200 Yes Yes Yes Yes Quotas 7 AWS Telco Network Builder User Guide AWS TNB concepts This topic describes essential concepts to help you start using AWS TNB. Contents • Lifecycle of a network function • Use
|
tnb-guide-004
|
tnb-guide.pdf
| 4 |
quota Description Default value Adjustable? Network service instances The maximum number of network service instances in one Region. 800 Concurren t ongoing The maximum number of concurren t ongoing network service operation 40 network service s in one Region. operations Network packages Function packages The maximum number of network packages in one Region. The maximum number of function packages in one Region. 40 200 Yes Yes Yes Yes Quotas 7 AWS Telco Network Builder User Guide AWS TNB concepts This topic describes essential concepts to help you start using AWS TNB. Contents • Lifecycle of a network function • Use standardized interfaces • Network function packages for AWS TNB • Network service descriptors for AWS TNB • Management and operations for AWS TNB • Network service descriptors for AWS TNB Lifecycle of a network function AWS TNB helps you throughout the lifecycle of your network functions. The network function lifecycle includes the following stages and activities: Planning 1. Plan your network by identifying the network functions to deploy. 2. Put the network function software images in a container image repository. 3. Create the CSAR packages to deploy or upgrade. 4. Use AWS TNB to upload the CSAR package that defines your network function (for example, CU AMF, and UPF), and integrate with a continuous integration and continuous delivery (CI/ CD) pipeline that can help you create new versions of your CSAR package as new network function software images, or customer scripts, are available. Configuration 1. Identify the information required for the deployment, such as compute type, network function version, IP information, and names of resources. 2. Use the information to create your network service descriptor (NSD). 3. Ingest NSDs that define your network functions and the resources required for the network function to instantiate. Instantiation 1. Create the infrastructure required by the network functions. Lifecycle of a network function 8 AWS Telco Network Builder User Guide 2. Instantiate (or provision) the network function as defined in its NSD and start carrying traffic. 3. Validate the assets. Production During the lifecycle of the network function, you'll complete production operations, such as: • Update the network function configuration, for example, update a value in the deployed network function. • Update the network instance with a new network package and parameter values. For example, update the Amazon EKS version parameter in the network package. Use standardized interfaces AWS TNB integrates with European Telecommunications Standards Institute (ETSI) compliant service orchestrators allowing you to simplify the deployment of your network services. Service orchestrators can use AWS TNB SDKs, the CLI, or the APIs to initiate operations, such as instantiating or upgrading an network function to a new version. AWS TNB supports the following specifications. Specification Release Description ETSI SOL001 v3.6.1 Defines standards for allowing TOSCA-based network function descriptors. ETSI SOL002 v3.6.1 ETSI SOL003 v3.6.1 ETSI SOL004 v3.6.1 ETSI SOL005 v3.6.1 ETSI SOL007 v3.5.1 Defines models around network function management. Defines standards for network function lifecycle management. Defines CSAR standards for network function packages. Defines standards for network service package and network service lifecycle management. Defines standards for allowing TOSCA-based network service descriptors. Use standardized interfaces 9 AWS Telco Network Builder User Guide Network function packages for AWS TNB With AWS TNB, you can store network function packages that comply with ETSI SOL001/SOL004 into a functions catalog. Then, you can upload Cloud Service Archive (CSAR) packages that contain artifacts describing your network function. • Network function descriptor – Defines metadata for package onboarding and network function management • Software Images – References network function Container Images. Amazon Elastic Container Registry (Amazon ECR) can act as your network function images repository. • Additional Files – Use to manage the network function; for example, scripts and Helm charts. The CSAR is a package defined by the OASIS TOSCA standard and includes a network/service descriptor that complies with the OASIS TOSCA YAML specification. For information about the required YAML specification, see TOSCA reference for AWS TNB. The following is an example network function descriptor. tosca_definitions_version: tnb_simple_yaml_1_0 topology_template: node_templates: SampleNF: type: tosca.nodes.AWS.VNF properties: descriptor_id: "SampleNF-descriptor-id" descriptor_version: "2.0.0" descriptor_name: "NF 1.0.0" provider: "SampleNF" requirements: helm: HelmChart HelmChart: type: tosca.nodes.AWS.Artifacts.Helm properties: implementation: "./SampleNF" Network function packages 10 AWS Telco Network Builder User Guide Network service descriptors for AWS TNB AWS TNB stores network service descriptors (NSDs) about the network functions that you want to deploy and how you want to deploy them into the catalog. You can upload your YAML NSD file (vnfd.yaml), as described by ETSI SOL007 to include the following information: • Network function that you want to deploy • Networking instructions • Compute instructions • Lifecycle hooks (custom scripts) AWS TNB supports ETSI standards for the modeling of resources, such as network, service, and function, in the TOSCA language. AWS TNB makes it more efficient for you to use
|
tnb-guide-005
|
tnb-guide.pdf
| 5 |
Guide Network service descriptors for AWS TNB AWS TNB stores network service descriptors (NSDs) about the network functions that you want to deploy and how you want to deploy them into the catalog. You can upload your YAML NSD file (vnfd.yaml), as described by ETSI SOL007 to include the following information: • Network function that you want to deploy • Networking instructions • Compute instructions • Lifecycle hooks (custom scripts) AWS TNB supports ETSI standards for the modeling of resources, such as network, service, and function, in the TOSCA language. AWS TNB makes it more efficient for you to use AWS services by modeling them in a way that your ETSI-compliant service orchestrator can understand. The following is a snippet of an NSD showing how to model AWS services. The network function will be deployed on an Amazon EKS cluster with Kubernetes version 1.27. The subnets for the applications are Subnet01 and Subnet02. You can then define the NodeGroups for your applications with an Amazon Machine Image (AMI), instance type, and autoscaling configuration. tosca_definitions_version: tnb_simple_yaml_1_0 SampleNFEKS: type: tosca.nodes.AWS.Compute.EKS properties: version: "1.27" access: "ALL" cluster_role: "arn:aws:iam::${AWS::TNB::AccountId}:role/SampleClusterRole" capabilities: multus: properties: enabled: true requirements: subnets: - Subnet01 - Subnet02 SampleNFEKSNode01: type: tosca.nodes.AWS.Compute.EKSManagedNode AWS TNB network service descriptors 11 AWS Telco Network Builder properties: node_role: "arn:aws:iam::${AWS::TNB::AccountId}:role/SampleNodeRole" capabilities: User Guide compute: properties: ami_type: "AL2_x86_64" instance_types: - "t3.xlarge" key_pair: "SampleKeyPair" scaling: properties: desired_size: 3 min_size: 2 max_size: 6 requirements: cluster: SampleNFEKS subnets: - Subnet01 network_interfaces: - ENI01 - ENI02 Management and operations for AWS TNB With AWS TNB, you can manage your network using standardized management operations in accordance with ETSI SOL003 and SOL005. You can use the AWS TNB APIs to perform lifecycle operations such as: • Instantiating your network functions. • Terminating your network functions. • Updating your network functions to override Helm deployments. • Updating an instantiated or updated network instance with a new network package and parameter values. • Managing versions of your network functions packages. • Managing versions of your NSDs. • Retrieving information about your deployed network functions. Management and operations 12 AWS Telco Network Builder User Guide Network service descriptors for AWS TNB A network service descriptor (NSD) is a .yaml file in a network package that uses the TOSCA standard to describe the network functions that you want to deploy, and the AWS infrastructure that you want to deploy the network functions on. To define your NSD and configure your underlying resources and network lifecycle operations, you must understand the NSD TOSCA Schema supported by AWS TNB. Your NSD file is divided into the following parts: 1. TOSCA definition version – This is the first line of your NSD YAML file and contains the version information, shown in the following example. tosca_definitions_version: tnb_simple_yaml_1_0 2. VNFD – The NSD contains the definition of the network function on which to perform lifecycle operations. Each network function must be identified by the following values: • A unique ID for descriptor_id. The ID must match the ID in the network function CSAR package. • A unique name for namespace. The name must be associated with a unique ID to more easily reference throughout your NSD YAML file, shown in the following example. vnfds: - descriptor_id: "61465757-cb8f-44d8-92c2-b69ca0de025b" namespace: "amf" 3. Topology template – Defines the resources to be deployed, the network function deployment, and any customized scripts, such as lifecycle hooks. This is shown in the following example. topology_template: node_templates: SampleNS: type: tosca.nodes.AWS.NS properties: descriptor_id: "<Sample Identifier>" descriptor_version: "<Sample nversion>" descriptor_name: "<Sample name>" Network service descriptors 13 AWS Telco Network Builder User Guide 4. Additional nodes – Each modeled resource has sections for properties and requirements. The properties describe optional or mandatory attributes for a resource, such as the version. The requirements describe dependencies that must be provided as arguments. For example, to create an Amazon EKS Node Group Resource, it must be created within an Amazon EKS Cluster. This is shown in the following example. SampleEKSNode: type: tosca.nodes.AWS.Compute.EKSManagedNode properties: node_role: "arn:aws:iam::${AWS::TNB::AccountId}:role/SampleRole" capabilities: compute: properties: ami_type: "AL2_x86_64" instance_types: - "t3.xlarge" key_pair: "SampleKeyPair" scaling: properties: desired_size: 1 min_size: 1 max_size: 1 requirements: cluster: SampleEKS subnets: - SampleSubnet network_interfaces: - SampleENI01 - SampleENI02 Network service descriptors 14 AWS Telco Network Builder User Guide Setting up AWS TNB Set up AWS TNB by completing the tasks described in this topic. Tasks • Sign up for an AWS account • Create a user with administrative access • Choose an AWS Region • Note the service endpoint • (Optional) Install the AWS CLI • Set up AWS TNB roles Sign up for an AWS account If you do not have an AWS account, complete the following steps to create one. To sign up for an AWS account 1. Open https://portal.aws.amazon.com/billing/signup. 2. Follow the online instructions. Part of the sign-up procedure involves receiving a phone call and entering a
|
tnb-guide-006
|
tnb-guide.pdf
| 6 |
AWS TNB Set up AWS TNB by completing the tasks described in this topic. Tasks • Sign up for an AWS account • Create a user with administrative access • Choose an AWS Region • Note the service endpoint • (Optional) Install the AWS CLI • Set up AWS TNB roles Sign up for an AWS account If you do not have an AWS account, complete the following steps to create one. To sign up for an AWS account 1. Open https://portal.aws.amazon.com/billing/signup. 2. Follow the online instructions. Part of the sign-up procedure involves receiving a phone call and entering a verification code on the phone keypad. When you sign up for an AWS account, an AWS account root user is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to a user, and use only the root user to perform tasks that require root user access. AWS sends you a confirmation email after the sign-up process is complete. At any time, you can view your current account activity and manage your account by going to https://aws.amazon.com/ and choosing My Account. Sign up for an AWS account 15 AWS Telco Network Builder User Guide Create a user with administrative access After you sign up for an AWS account, secure your AWS account root user, enable AWS IAM Identity Center, and create an administrative user so that you don't use the root user for everyday tasks. Secure your AWS account root user 1. Sign in to the AWS Management Console as the account owner by choosing Root user and entering your AWS account email address. On the next page, enter your password. For help signing in by using root user, see Signing in as the root user in the AWS Sign-In User Guide. 2. Turn on multi-factor authentication (MFA) for your root user. For instructions, see Enable a virtual MFA device for your AWS account root user (console) in the IAM User Guide. Create a user with administrative access 1. Enable IAM Identity Center. For instructions, see Enabling AWS IAM Identity Center in the AWS IAM Identity Center User Guide. 2. In IAM Identity Center, grant administrative access to a user. For a tutorial about using the IAM Identity Center directory as your identity source, see Configure user access with the default IAM Identity Center directory in the AWS IAM Identity Center User Guide. Sign in as the user with administrative access • To sign in with your IAM Identity Center user, use the sign-in URL that was sent to your email address when you created the IAM Identity Center user. For help signing in using an IAM Identity Center user, see Signing in to the AWS access portal in the AWS Sign-In User Guide. Create a user with administrative access 16 AWS Telco Network Builder Assign access to additional users User Guide 1. In IAM Identity Center, create a permission set that follows the best practice of applying least- privilege permissions. For instructions, see Create a permission set in the AWS IAM Identity Center User Guide. 2. Assign users to a group, and then assign single sign-on access to the group. For instructions, see Add groups in the AWS IAM Identity Center User Guide. Choose an AWS Region To view the list of available Regions for AWS TNB, see the AWS Regional Services List. To view the list of endpoints for programmatic access, see AWS TNB endpoints in the AWS General Reference. Note the service endpoint To connect programmatically to an AWS service, you use an endpoint. In addition to the standard AWS endpoints, some AWS services offer FIPS endpoints in selected Regions. For more information, see AWS service endpoints. Region Endpoint Protocol us-east-1 tnb.us-east-1.amazonaws.com HTTPS Region Name US East (N. Virginia) US West (Oregon) us- west-2 Asia Pacific (Seoul) Asia Pacific ap- northe ast-2 ap- southe (Sydney) ast-2 tnb.us-west-2.amazonaws.com HTTPS tnb.ap-northeast-2.amazonaws.com HTTPS tnb.ap-southeast-2.amazonaws.com HTTPS Choose an AWS Region 17 AWS Telco Network Builder User Guide Region Name Region Endpoint Protocol Canada (Central) ca-centra l-1 Europe (Frankfur eu- central-1 t) Europe (Paris) Europe (Spain) eu- west-3 eu- south-2 Europe (Stockhol eu- north-1 tnb.ca-central-1.amazonaws.com HTTPS tnb.eu-central-1.amazonaws.com HTTPS tnb.eu-west-3.amazonaws.com HTTPS tnb.eu-south-2.amazonaws.com HTTPS tnb.eu-north-1.amazonaws.com HTTPS sa-east-1 tnb.sa-east-1.amazonaws.com HTTPS m) South America (São Paulo) (Optional) Install the AWS CLI The AWS Command Line Interface (AWS CLI) provides commands for a broad set of AWS products, and is supported on Windows, macOS, and Linux. You can access AWS TNB using the AWS CLI. To get started, see the AWS Command Line Interface User Guide. For more information about the commands for AWS TNB, see tnb in the AWS CLI Command Reference. Set up AWS TNB roles You must create a IAM service role to manage different parts of your AWS TNB solution.
|
tnb-guide-007
|
tnb-guide.pdf
| 7 |
HTTPS tnb.eu-south-2.amazonaws.com HTTPS tnb.eu-north-1.amazonaws.com HTTPS sa-east-1 tnb.sa-east-1.amazonaws.com HTTPS m) South America (São Paulo) (Optional) Install the AWS CLI The AWS Command Line Interface (AWS CLI) provides commands for a broad set of AWS products, and is supported on Windows, macOS, and Linux. You can access AWS TNB using the AWS CLI. To get started, see the AWS Command Line Interface User Guide. For more information about the commands for AWS TNB, see tnb in the AWS CLI Command Reference. Set up AWS TNB roles You must create a IAM service role to manage different parts of your AWS TNB solution. AWS TNB service roles can make API calls to other AWS services, such as AWS CloudFormation, AWS (Optional) Install the AWS CLI 18 AWS Telco Network Builder User Guide CodeBuild, and various compute and storage services, on your behalf, to instantiate and manage resources for your deployment. For more information about the AWS TNB service role, see Identity and access management for AWS TNB. Set up AWS TNB roles 19 AWS Telco Network Builder User Guide Getting started with AWS TNB This tutorial demonstrates how you use AWS TNB to deploy a network function, for example, the Centralized Unit (CU), Access and Mobility Management Function (AMF), or 5G User Plane Function (UPF). The following diagram illustrates the deployment process: Tasks • Prerequisites • Create a function package • Create a network package • Create and instantiate a network instance • Clean up Prerequisites Before you can perform a successful deployment, you must have the following: • An AWS Business Support plan. • Permissions through IAM roles. • A Network Function (NF) package that complies with ETSI SOL001/SOL004. • Network Service Descriptor (NSD) templates that comply with ETSI SOL007. Prerequisites 20 AWS Telco Network Builder User Guide You can use a sample function package or network package from the Sample packages for AWS TNB GitHub site. Create a function package A network function package is a Cloud Service Archive (CSAR) file. The CSAR file contains Helm charts, software images, and a Network Function Descriptor (NFD). To create a function package 1. Open the AWS TNB console at https://console.aws.amazon.com/tnb/. 2. In the navigation pane, choose Function packages. 3. Choose Create function package. 4. Under Upload function package, choose Choose files, and upload each CSAR package as a .zip file. You can upload a maximum of 10 files. 5. (Optional) Under Tags, choose Add new tag and enter a key and value. You can use tags to search and filter your resources or track your AWS costs. 6. Choose Next. 7. Review the package details, and then choose Create function package. Create a network package A network package specifies the network functions that you want to deploy and how you want to deploy them into the catalog. To create a network package 1. In the navigation pane, choose Network packages. 2. Choose Create network package. 3. Under Upload network package, choose Choose files, and upload each NSD as a .zip file. You can upload a maximum of 10 files. 4. (Optional) Under Tags, choose Add new tag and enter a key and value. You can use tags to search and filter your resources or track your AWS costs. 5. Choose Next. 6. Choose Create network package. Create a function package 21 AWS Telco Network Builder User Guide Create and instantiate a network instance A network instance is a single network created in AWS TNB that can be deployed. You must create a network instance and instantiate it. When you instantiate a network instance, AWS TNB provisions the necessary AWS infrastructure, deploys containerized network functions, and configures networking and access management to create a fully operational network service. To create and instantiate a network instance 1. In the navigation pane, choose Networks. 2. Choose Create network instance. 3. Enter a name and description for the network, and then choose Next. 4. Choose a network package. Verify the details and choose Next. 5. Choose Create network instance. The initial state is Created. The Networks page appears showing the new network instance in the Not instantiated state. 6. Select the network instance, choose Actions and Instantiate. The Network instantiate page appears. 7. Review details and update parameter values. Updates to the parameter values apply only to this network instance. The parameters in the NSD and VNFD packages do not change. 8. Choose Instantiate network. The Deployment status page appears. 9. Use the Refresh icon to track the deployment status of your network instance. You can also enable Auto refresh in the Deployment tasks section to track the progress of each task. Clean up You can now delete the resources that you created for this tutorial. To clean up your resources 1. In the navigation pane, choose Networks. 2. Chose the ID of the network, and then
|
tnb-guide-008
|
tnb-guide.pdf
| 8 |
parameter values. Updates to the parameter values apply only to this network instance. The parameters in the NSD and VNFD packages do not change. 8. Choose Instantiate network. The Deployment status page appears. 9. Use the Refresh icon to track the deployment status of your network instance. You can also enable Auto refresh in the Deployment tasks section to track the progress of each task. Clean up You can now delete the resources that you created for this tutorial. To clean up your resources 1. In the navigation pane, choose Networks. 2. Chose the ID of the network, and then choose Terminate. Create and instantiate a network instance 22 AWS Telco Network Builder User Guide 3. When prompted for confirmation, enter the network ID, and then choose Terminate. 4. Use the Refresh icon to track the status of your network instance. 5. (Optional) Select the network, and choose Delete. Clean up 23 AWS Telco Network Builder User Guide Function packages for AWS TNB 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. Tasks • Create a function package in AWS TNB • View a function package in AWS TNB • Download a function package from AWS TNB • Delete a function package from AWS TNB Create a function package in AWS TNB Learn how to create a function package in the AWS TNB network functions catalog. Creating a function package is the first step for creating a network in AWS TNB. After you've uploaded a function package, you can create a network package. Console To create a function package using the console 1. Open the AWS TNB console at https://console.aws.amazon.com/tnb/. 2. In the navigation pane, choose Function packages. 3. Choose Create function package. 4. Choose Choose files and upload each CSAR package as a .zip file. You can upload a maximum of 10 files. 5. Choose Next. 6. Review the package details. 7. Choose Create function package. Create 24 AWS Telco Network Builder AWS CLI User Guide To create a function package using the AWS CLI 1. Use the create-sol-function-package command to create a new function package: aws tnb create-sol-function-package 2. Use the put-sol-function-package-content command to upload the function package content. For example: aws tnb put-sol-function-package-content \ --vnf-pkg-id ^fp-[a-f0-9]{17}$ \ --content-type application/zip \ --file "fileb://valid-free5gc-udr.zip" \ --endpoint-url "https://tnb.us-west-2.amazonaws.com" \ --region us-west-2 View a function package in AWS TNB Learn how to view the content of a function package. Console To view a function package using the console 1. Open the AWS TNB console at https://console.aws.amazon.com/tnb/. 2. In the navigation pane, choose Function packages. 3. Use search box to find the function package AWS CLI To view a function package using the AWS CLI 1. Use the list-sol-function-packages command to list your function packages. aws tnb list-sol-function-packages 2. Use the get-sol-function-package command to view details about a function package. View 25 AWS Telco Network Builder User Guide aws tnb get-sol-function-package \ --vnf-pkg-id ^fp-[a-f0-9]{17}$ \ --endpoint-url "https://tnb.us-west-2.amazonaws.com" \ --region us-west-2 Download a function package from AWS TNB Learn how to download a function package from the AWS TNB network functions catalog. Console To download a function package using the console 1. Open the AWS TNB console at https://console.aws.amazon.com/tnb/. 2. In the navigation pane on the left side of the console, choose Function packages. 3. Use search box to find the function package 4. Choose the function package 5. Choose Actions, Download. AWS CLI To download a function package using the AWS CLI Use the get-sol-function-package-content command to download a function package. aws tnb get-sol-function-package-content \ --vnf-pkg-id ^fp-[a-f0-9]{17}$ \ --accept "application/zip" \ --endpoint-url "https://tnb.us-west-2.amazonaws.com" \ --region us-west-2 Delete a function package from AWS TNB Learn how to delete a function package from the AWS TNB network functions catalog. To delete a function package, the package must be in a disabled state. Download a package 26 AWS Telco Network Builder Console User Guide To delete a function package using the console 1. Open the AWS TNB console at https://console.aws.amazon.com/tnb/. 2. In the navigation pane, choose Function packages. 3. Use the search box to find the function package. 4. Choose a function package. 5. Choose Actions, Disable. 6. Choose Actions, Delete. AWS CLI To delete a function package using the AWS CLI 1. Use the update-sol-function-package command to disable a function package. aws tnb update-sol-function-package --vnf-pkg-id ^fp-[a-f0-9]{17}$ --- operational-state DISABLED 2. Use the delete-sol-function-package command to delete a function package. aws tnb delete-sol-function-package \ --vnf-pkg-id ^fp-[a-f0-9]{17}$ \ --endpoint-url "https://tnb.us-west-2.amazonaws.com" \ --region us-west-2 Delete a package 27 AWS Telco Network Builder User Guide Network packages for AWS TNB A network package is a .zip file in CSAR (Cloud Service Archive) format defines
|
tnb-guide-009
|
tnb-guide.pdf
| 9 |
search box to find the function package. 4. Choose a function package. 5. Choose Actions, Disable. 6. Choose Actions, Delete. AWS CLI To delete a function package using the AWS CLI 1. Use the update-sol-function-package command to disable a function package. aws tnb update-sol-function-package --vnf-pkg-id ^fp-[a-f0-9]{17}$ --- operational-state DISABLED 2. Use the delete-sol-function-package command to delete a function package. aws tnb delete-sol-function-package \ --vnf-pkg-id ^fp-[a-f0-9]{17}$ \ --endpoint-url "https://tnb.us-west-2.amazonaws.com" \ --region us-west-2 Delete a package 27 AWS Telco Network Builder User Guide Network packages for AWS TNB A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the AWS infrastructure you want to deploy them on. Tasks • Create a network package in AWS TNB • View a network package in AWS TNB • Download a network package from AWS TNB • Delete a network package from AWS TNB Create a network package in AWS TNB 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 Amazon EKS clusters. Create a network package after creating function packages. Once you've created a network package, you need to create a network instance. Console To create a network package using the console 1. Open the AWS TNB console at https://console.aws.amazon.com/tnb/. 2. In the navigation pane, choose Network packages. 3. Choose Create network package. 4. Choose Choose files and upload each NSD as a .zip file. You can upload a maximum of 10 files. 5. Choose Next. 6. Review the package details. 7. Choose Create network package. Create 28 AWS Telco Network Builder AWS CLI User Guide To create a network package using the AWS CLI 1. Use the create-sol-network-package command to create a network package. aws tnb create-sol-network-package 2. Use the put-sol-network-package-content command to upload network package content. For example: aws tnb put-sol-network-package-content \ --nsd-info-id ^np-[a-f0-9]{17}$ \ --content-type application/zip \ --file "fileb://free5gc-core-1.0.9.zip" \ --endpoint-url "https://tnb.us-west-2.amazonaws.com" \ --region us-west-2 View a network package in AWS TNB Learn how to view the content of a network package. Console To view a network package using the console 1. Open the AWS TNB console at https://console.aws.amazon.com/tnb/. 2. In the navigation pane, choose Network packages. 3. Use the search box to find the network package. AWS CLI To view a network package using the AWS CLI 1. Use the list-sol-network-packages command to list your network packages. aws tnb list-sol-network-packages 2. Use the get-sol-network-package command to view details about a network package. View 29 AWS Telco Network Builder User Guide aws tnb get-sol-network-package \ --nsd-info-id ^np-[a-f0-9]{17}$ \ --endpoint-url "https://tnb.us-west-2.amazonaws.com" \ --region us-west-2 Download a network package from AWS TNB Learn how to download a network package from the AWS TNB network service catalog. Console To download a network package using the console 1. Open the AWS TNB console at https://console.aws.amazon.com/tnb/. 2. In the navigation pane, choose Network packages. 3. Use the search box to find the network package 4. Choose the network package. 5. Choose Actions, Download. AWS CLI To download a network package using the AWS CLI • Use the get-sol-network-package-content command to download a network package. aws tnb get-sol-network-package-content \ --nsd-info-id ^np-[a-f0-9]{17}$ \ --accept "application/zip" \ --endpoint-url "https://tnb.us-west-2.amazonaws.com" \ --region us-west-2 Delete a network package from AWS TNB Learn how to delete a network package from the AWS TNB network service catalog. To delete a network package, the package must be in a disable state. Download 30 AWS Telco Network Builder Console User Guide To delete a network package using the console 1. Open the AWS TNB console at https://console.aws.amazon.com/tnb/. 2. In the navigation pane, choose Network packages. 3. Use the search box to find the network package 4. Choose network package 5. Choose Actions, Disable. 6. Choose Actions, Delete. AWS CLI To delete a network package using the AWS CLI 1. Use the update-sol-network-package command to disable a network package. aws tnb update-sol-network-package --nsd-info-id ^np-[a-f0-9]{17}$ --nsd- operational-state DISABLED 2. Use the delete-sol-network-package command to delete a network package. aws tnb delete-sol-network-package \ --nsd-info-id ^np-[a-f0-9]{17}$ \ --endpoint-url "https://tnb.us-west-2.amazonaws.com" \ --region us-west-2 Delete 31 AWS Telco Network Builder User Guide Network instances for AWS TNB A network instance is a single network created in AWS TNB that can be deployed. Tasks • Life cycle operations of a network instance • Create a network instance using AWS TNB • Instantiate a network instance using AWS TNB • Update a function instance in AWS TNB • Update a network instance in AWS TNB • View a network instance in AWS TNB • Terminate and delete a network instance from AWS TNB Life cycle operations of a
|
tnb-guide-010
|
tnb-guide.pdf
| 10 |
--nsd-info-id ^np-[a-f0-9]{17}$ \ --endpoint-url "https://tnb.us-west-2.amazonaws.com" \ --region us-west-2 Delete 31 AWS Telco Network Builder User Guide Network instances for AWS TNB A network instance is a single network created in AWS TNB that can be deployed. Tasks • Life cycle operations of a network instance • Create a network instance using AWS TNB • Instantiate a network instance using AWS TNB • Update a function instance in AWS TNB • Update a network instance in AWS TNB • View a network instance in AWS TNB • Terminate and delete a network instance from AWS TNB Life cycle operations of a network instance AWS TNB allows you to easily manage your network using standardized management operations inline with ETSI SOL003 and SOL005. You can perform the following life-cycle operations: • Create the network • Instantiate the network • Update the network function • Update the network instance • View network details and status • Terminate the network The following image shows the network management operations: Life cycle operations 32 AWS Telco Network Builder User Guide Create a network instance using AWS TNB You create a network instance after creating a network package. After you create a network instance, instantiate it. Console To create a network instance using the console 1. Open the AWS TNB console at https://console.aws.amazon.com/tnb/. 2. In the navigation pane, choose Networks. 3. Choose Create network instance. 4. 5. Enter a name and description for the instance and then choose Next. Select the network package, verify the details, and choose Next. 6. Choose Create network instance. The new network instance appears on the Networks page. Next, instantiate this network instance. AWS CLI To create a network instance using the AWS CLI • Use the create-sol-network-instance command to create a network instance. Create 33 AWS Telco Network Builder User Guide aws tnb create-sol-network-instance --nsd-info-id ^np-[a-f0-9]{17}$ --ns-name "SampleNs" --ns-description "Sample" Next, instantiate this network instance. Instantiate a network instance using AWS TNB After you create a network instance, you must instantiate it. When you instantiate a network instance, AWS TNB provisions the necessary AWS infrastructure, deploys containerized network functions, and configures networking and access management to create a fully operational network service. Console To instantiate a network instance using the console 1. Open the AWS TNB console at https://console.aws.amazon.com/tnb/. 2. 3. In the navigation pane, choose Networks. Select the network instance that you want to instantiate. 4. Choose Actions and then Instantiate. 5. On the Instantiate network page, review details and optionally, update parameter values. Updates to the parameter values apply only to this network instance. The parameters in the NSD and VNFD packages do not change. 6. Choose Instantiate network. The Deployment status page appears. 7. Use the Refresh icon to track the deployment status of your network instance. You can also enable Auto refresh in the Deployment tasks section to track the progress of each task. When the deployment status changes to Completed, the network instance is instantiated. Instantiate 34 AWS Telco Network Builder AWS CLI User Guide To instantiate a network instance using the AWS CLI 1. Use the instantiate-sol-network-instance command to instantiate the network instance. aws tnb instantiate-sol-network-instance --ns-instance-id ^ni-[a-f0-9]{17}$ -- additional-params-for-ns "{\"param1\": \"value1\", \"param2\": \"value2\"}" 2. Next, view the network operation status. Update a function instance in AWS TNB After a network instance is instantiated, you can update a function package in the network instance. Console To update a function instance using the console 1. Open the AWS TNB console at https://console.aws.amazon.com/tnb/. 2. 3. In the navigation pane, choose Networks. Select the network instance. You can update a network instance only if its state is Instantiated. The network instance page appears. 4. From the Functions tab, select the function instance to update. 5. Choose Update. 6. Enter your update overrides. 7. Choose Update. AWS CLI Use the CLI to update a function instance Use the update-sol-network-instance command with the MODIFY_VNF_INFORMATION update type to update a function instance in a network instance. Update a function instance 35 AWS Telco Network Builder User Guide aws tnb update-sol-network-instance --ns-instance-id ^ni-[a-f0-9]{17}$ --update-type MODIFY_VNF_INFORMATION --modify-vnf-info ... Update a network instance in AWS TNB After a network instance is instantiated, you might need to update the infrastructure or application. To do so, you update the network package and parameter values for the network instance and deploy the update operation to apply the changes. Considerations • You can update a network instance that is in the Instantiated or Updated state. • When you update a network instance, the UpdateSolNetworkService API uses the new network package and parameter values to update the topology of the network instance. • AWS TNB verifies that the number of NSD and VNFD parameters in the network instance does not exceed 200. This limit is enforced to protect from bad actors passing erroneous or huge payloads that affect the
|
tnb-guide-011
|
tnb-guide.pdf
| 11 |
you update the network package and parameter values for the network instance and deploy the update operation to apply the changes. Considerations • You can update a network instance that is in the Instantiated or Updated state. • When you update a network instance, the UpdateSolNetworkService API uses the new network package and parameter values to update the topology of the network instance. • AWS TNB verifies that the number of NSD and VNFD parameters in the network instance does not exceed 200. This limit is enforced to protect from bad actors passing erroneous or huge payloads that affect the service. Parameters that you can update You can update the following parameters when you update an instantiated network instance: Parameter Description Example: Before Amazon EKS cluster version You can update the value for the Amazon EKS cluster control plane version parameter to the next minor version. You cannot downgrade the version. EKSCluster: type: tosca.nod es.AWS.Compute.EKS properties: version: "1.28" Update a network instance 36 Example: After EKSCluste r: type: tosca.nod es.AWS.Co mpute.EKS AWS Telco Network Builder User Guide Parameter Description Example: Before Example: After propertie s: version: "1.29" Parameters that you can update 37 AWS Telco Network Builder User Guide Parameter Description Example: Before Amazon EKS worker nodes You can update the value for the EKSManagedNode kubernetes_version parameter to upgrade your node group to a newer Amazon EKS version, or you can update the ami_id parameter to upgrade your EKSManagedNodeGroup01: ... properties: kubernete s_version: " 1.28" EKSSelfManagedNode 01: compute: compute: Example: After EKSManage dNodeGrou p01: ... node group to the latest EKS- properties: optimzed AMI. ami_id: propertie "ami-123123OLD" s: You can update the AMI ID for EKSSelfManagedNode . The Amazon EKS version of the AMI must be the same as or up to 2 versions lower than the Amazon EKS cluster version. For example if the Amazon EKS cluster version is 1.31, then the Amazon EKS AMI version must be 1.31, 1.30, or 1.29. kubernete s_version : "1.29" EKSSelfMa nagedNode 01: compute: Parameters that you can update 38 AWS Telco Network Builder User Guide Parameter Description Example: Before Example: After compute: propertie s: ami_id: "ami-1231 23NEW" Parameters that you can update 39 AWS Telco Network Builder User Guide Parameter Description Example: Before Scaling properties You can update the scaling properties of the EKSManage dNode and EKSSelfMa nagedNode TOSCA nodes. EKSNodeGroup01: ... scaling: properties: desired_s Example: After EKSNodeGr oup01: ize: 1 ... min_size: 1 max_size: 1 scaling: propertie s: desired_s ize: 2 Parameters that you can update 40 AWS Telco Network Builder User Guide Parameter Description Example: Before Example: After min_size: 0 max_size: 2 Parameters that you can update 41 AWS Telco Network Builder User Guide Parameter Description Example: Before Amazon EBS CSI plugin properties You can enable or disable the Amazon EBS CSI plugin on EKSCluster: capabilities: your Amazon EKS clusters. ... You can also change the plugin version. ebs_csi: properties: enabled: false Example: After EKSCluste r: capabilit ies: ... ebs_csi: propertie s: enabled: true version: "v1.30.0- e ksbuild.1 " Parameters that you can update 42 AWS Telco Network Builder User Guide Parameter Description Example: Before Example: After Root volume size You can add, remove, or update the root volume size Free5GCEKSNode01: ... Free5GCEK SNode01: property of the EKSManage capabilities: dNode and EKSSelfMa nagedNode TOSCA nodes. compute: properties: root_volu me_size: 50 ... capabilit ies: compute: propertie s: Parameters that you can update 43 AWS Telco Network Builder User Guide Parameter Description Example: Before Example: After root_volu me_size: 100 Parameters that you can update 44 AWS Telco Network Builder User Guide Parameter Description Example: Before VNF You can reference the VNFs in the NSD and deploy them vnfds: - descriptor_id: Example: After vnfds: to the cluster created in "43c012fa-2616-41a8- - NSD using VNFDeployment TOSCA node. As part of the update, you will be able to add, update, and delete VNFs to the network. a833-0dfd4c5a049e " descripto namespace: " vnf1" r_id: - descriptor_id: "64222f98-ecd6-4871- "59f77222- 79e9-4dc1 bf94-7354b53f3ee5 " - namespace: "vnf2" // Deleted VNF ... SampleVNF1HelmDeploy: type: tosca.nod es.AWS.Deployment. be53-571 2ad06e31b " VNFDeployment namespace requirements: : cluster: EKSCluster vnfs: - vnf1.Samp leVNF1 "vnf1" // Updated VNF - - vnf2.Samp descripto leVNF2 r_id: "b7e072dc- 839d-4fac -916c-561 a166da1fc " namespace : "vnf3" // Added VNFn .... Sa mpleVNF1H Parameters that you can update 45 AWS Telco Network Builder User Guide Parameter Description Example: Before Example: After elmDeploy : type: tosca.nod es.AWS.De ployment. VNFDeploy ment requireme nts: cluster: EKSCluste r vnfs: Parameters that you can update 46 AWS Telco Network Builder User Guide Parameter Description Example: Before Example: After - vnf1.Samp leVNF1 - vnf3.Samp leVNF3 Parameters that you can update 47 AWS Telco Network Builder User Guide Parameter Description Example: Before Hooks To run life cycle operations before and after you create vnfds: - descriptor_id: Example: After vnfds: a network function, add "43c012fa-2616-41a8- - the pre_create
|
tnb-guide-012
|
tnb-guide.pdf
| 12 |
.... Sa mpleVNF1H Parameters that you can update 45 AWS Telco Network Builder User Guide Parameter Description Example: Before Example: After elmDeploy : type: tosca.nod es.AWS.De ployment. VNFDeploy ment requireme nts: cluster: EKSCluste r vnfs: Parameters that you can update 46 AWS Telco Network Builder User Guide Parameter Description Example: Before Example: After - vnf1.Samp leVNF1 - vnf3.Samp leVNF3 Parameters that you can update 47 AWS Telco Network Builder User Guide Parameter Description Example: Before Hooks To run life cycle operations before and after you create vnfds: - descriptor_id: Example: After vnfds: a network function, add "43c012fa-2616-41a8- - the pre_create and post_create hooks to the VNFDeployment node. In this example, the PreCreateHook hook will run before vnf3.Samp leVNF3 is instantiated and the PostCreateHook hook will run after vnf3.Samp leVNF3 is instantiated. a833-0dfd4c5a049e " descripto namespace: " vnf1" r_id: - descriptor_id: "64222f98-ecd6-4871- "43c012fa- 2616-41a8 bf94-7354b53f3ee5 " - namespace: " vnf2" ... a833-0df d4c5a049e SampleVNF1HelmDeploy: " type: tosca.nod es.AWS.Deployment. VNFDeployment requirements: namespace cluster: EKSCluster : vnfs: "vnf1" - vnf1.SampleVNF1 - vnf2.Samp leVNF2 // Removed during update - descripto r_id: "b7e072dc- 839d-4fac -916c-561 a166da1fc " namespace : "vnf3" .... S ampleVNF1 HelmDeplo y: type: tosca.nod Parameters that you can update 48 AWS Telco Network Builder User Guide Parameter Description Example: Before Example: After es.AWS.De ployment. VNFDeploy ment requireme nts: cluster: EKSCluste r vnfs: - vnf1.Samp leVNF1 // No change to this function, as the namespace and uuid remain the same Parameters that you can update 49 AWS Telco Network Builder User Guide Parameter Description Example: Before Example: After - vnf3.Samp leVNF3 // New VNF as the namespace , vnf3, was not previousl y present interface s: Hook: post_crea te: PostCreat eHook pre_creat e: PreCreate Hook Parameters that you can update 50 AWS Telco Network Builder User Guide Parameter Description Example: Before Hooks To run life cycle operations before and after you update vnfds: - descriptor_id: Example: After vnfds: a network function, you can "43c012fa-2616-41a8- - add the pre_update hook and the post_update hook to the VNFDeployment node. a833-0dfd4c5a049e " descripto namespace: " vnf1" r_id: - descriptor_id: "64222f98-ecd6-4871- "0ebe4e95- bd87-44bd bf94-7354b53f3ee5 " - In this example, PreUpdate Hook will run before vnf1.SampleVNF1 is updated and PostUpdat eHook will run after vnf1.SampleVNF1 is updated to the vnf package indicated by the updated uuid for the namespace vnf1. namespace: " vnf2" ... SampleVNF1HelmDeploy: type: tosca.nod es.AWS.Deployment. VNFDeployment requirements: b8a1-918 466606a14 " namespace : cluster: EKSCluster "vnf1" vnfs: - vnf1.SampleVNF1 - - vnf2.Samp leVNF2 descripto r_id: "64222f98- ecd6-4871 - bf94-735 4b53f3ee5 " namespace : "vnf2" ... S ampleVNF1 HelmDeplo y: type: Parameters that you can update 51 AWS Telco Network Builder User Guide Parameter Description Example: Before Example: After tosca.nod es.AWS.De ployment. VNFDeploy ment requireme nts: cluster: EKSCluste r vnfs: - vnf1.Samp leVNF1 // A VNF update as the uuid changed for namespace "vnf1" - vnf2.Samp Parameters that you can update 52 AWS Telco Network Builder User Guide Parameter Description Example: Before Example: After leVNF2 // No change to this function as namespace and uuid remain the same interface s: Hook: pre_updat e: PreUpdate Hook post_upda te: PostUpdat eHook Parameters that you can update 53 AWS Telco Network Builder User Guide Updating a network instance Console To update a network instance using the console 1. Open the AWS TNB console at https://console.aws.amazon.com/tnb/. 2. 3. In the navigation pane, choose Networks. Select the network instance. You can update a network instance only if its state is Instantiated or Updated. 4. Choose Actions and Update. The Update instance page appears with the network details and a list of parameters in the current infrastructure. 5. Choose a new network package. The parameters in the new network package appear in the Updated parameters section. 6. Optionally, update parameter values in the Updated parameters section. For the list of parameter values you can update, see Parameters that you can update. 7. Choose Update network. AWS TNB validates the request and starts the deployment. The Deployment status page appears. 8. Use the Refresh icon to track the deployment status of your network instance. You can also enable Auto refresh in the Deployment tasks section to track the progress of each task. When the deployment status changes to Completed, the network instance is updated. 9. • If validation fails, the network instance remains in the same state as it was before you requested the update - either Instantiated or Updated. • If the update fails, the network instance state shows Update failed. Choose the link for each failed task to determine the reason. • If the update succeeds, the network instance state shows Updated. AWS CLI Use the CLI to update a network instance Updating a network instance 54 AWS Telco Network Builder User Guide Use the update-sol-network-instance command with the UPDATE_NS update type to update a network instance. aws tnb update-sol-network-instance --ns-instance-id ^ni-[a-f0-9]{17}$
|
tnb-guide-013
|
tnb-guide.pdf
| 13 |
9. • If validation fails, the network instance remains in the same state as it was before you requested the update - either Instantiated or Updated. • If the update fails, the network instance state shows Update failed. Choose the link for each failed task to determine the reason. • If the update succeeds, the network instance state shows Updated. AWS CLI Use the CLI to update a network instance Updating a network instance 54 AWS Telco Network Builder User Guide Use the update-sol-network-instance command with the UPDATE_NS update type to update a network instance. aws tnb update-sol-network-instance --ns-instance-id ^ni-[a-f0-9]{17}$ -- update-type UPDATE_NS --update-ns "{\"nsdInfoId\":\"^np-[a-f0-9]{17}$\", \"additionalParamsForNs\": {\"param1\": \"value1\"}}" View a network instance in AWS TNB Learn how to view a network instance. Console To view a network instance using the console 1. Open the AWS TNB console at https://console.aws.amazon.com/tnb/. 2. In the navigation pane, choose Network instances. 3. Use the search box to find the network instance. AWS CLI To view a network instance using the AWS CLI 1. Use the list-sol-network-instances command to list your network instances. aws tnb list-sol-network-instances 2. Use the get-sol-network-instance command to view details about a specific network instance. aws tnb get-sol-network-instance --ns-instance-id ^ni-[a-f0-9]{17}$ Terminate and delete a network instance from AWS TNB To delete a network instance, the instance must be in a terminated state. View 55 AWS Telco Network Builder Console User Guide To terminate and delete a network instance using the console 1. Open the AWS TNB console at https://console.aws.amazon.com/tnb/. 2. 3. In the navigation pane, choose Networks. Select the ID of the network instance. 4. Choose Terminate. 5. When prompted for confirmation, enter the ID and choose Terminate. 6. Refresh to track the status of your network instance. 7. (Optional) Select the network instance and choose Delete. AWS CLI To terminate and delete a network instance using the AWS CLI 1. Use the terminate-sol-network-instance command to terminate a network instance. aws tnb terminate-sol-network-instance --ns-instance-id ^ni-[a-f0-9]{17}$ 2. (Optional) Use the delete-sol-network-instance command to delete a network instance. aws tnb delete-sol-network-instance --ns-instance-id ^ni-[a-f0-9]{17}$ Terminate and delete 56 AWS Telco Network Builder User Guide Network operations for AWS TNB A network operation is any operation that is done to your network, such as network instance instantiation or termination. Tasks • View a AWS TNB network operation • Cancel a AWS TNB network operation View a AWS TNB network operation View the details of a network operation, including the tasks involved in the network operation and the status of the tasks. Console To view a network operation using the console 1. Open the AWS TNB console at https://console.aws.amazon.com/tnb/. 2. In the navigation pane, choose Network instances. 3. Use the search box to find the network instance. 4. On the Deployments tab, choose the network operation. AWS CLI To view a network operation using the AWS CLI 1. Use the list-sol-network-operations command to list all network operations. aws tnb list-sol-network-operations 2. Use the get-sol-network-operation command to view details about a network operation. aws tnb get-sol-network-operation --ns-lcm-op-occ-id ^no-[a-f0-9]{17}$ View 57 AWS Telco Network Builder User Guide Cancel a AWS TNB network operation Learn how to cancel a network operation. Console To cancel a network operation using the console 1. Open the AWS TNB console at https://console.aws.amazon.com/tnb/. 2. 3. In the navigation pane, choose Networks. Select the ID of the network to open its details page. 4. On the Deployments tab, choose the Network Operation. 5. Choose Cancel operation. AWS CLI To cancel a network operation using the AWS CLI Use the cancel-sol-network-operation command to cancel a network operation. aws tnb cancel-sol-network-operation --ns-lcm-op-occ-id ^no-[a-f0-9]{17}$ Cancel 58 AWS Telco Network Builder User Guide TOSCA reference for AWS TNB Topology and Orchestration Specification for Cloud Applications (TOSCA) is a declarative syntax that CSPs use to describe a topology of cloud based web services, their components, relationships, and the processes that manage them. CSPs describe the connection points, the logical links between the connection points, and the policies such as affinity and security in a TOSCA template. CSPs then upload the template to AWS TNB which synthesizes the resources needed to establish a functioning 5G network across AWS Availability Zones. Contents • VNFD template • Network service descriptor template • Common nodes VNFD template Defines a virtual network function descriptor (VNFD) template. Syntax tosca_definitions_version: tnb_simple_yaml_1_0 topology_template: inputs: SampleInputParameter: type: String description: "Sample parameter description" default: "DefaultSampleValue" node_templates: SampleNode1: tosca.nodes.AWS.VNF Topology template node_templates The TOSCA AWS Nodes. The possible nodes are: VNFD template 59 AWS Telco Network Builder • AWS.VNF • AWS.Artifacts.Helm AWS.VNF Defines an AWS virtual network function (VNF) node. User Guide Syntax tosca.nodes.AWS.VNF: properties: descriptor_id: String descriptor_version: String descriptor_name: String provider: String requirements: helm: String Properties descriptor_id The UUID of the descriptor. Required: Yes Type: String Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} descriptor_version The version of the VNFD. Required: Yes Type: String Pattern: ^[0-9]{1,5}\\.[0-9]{1,5}\\.[0-9]{1,5}.*
|
tnb-guide-014
|
tnb-guide.pdf
| 14 |
nodes VNFD template Defines a virtual network function descriptor (VNFD) template. Syntax tosca_definitions_version: tnb_simple_yaml_1_0 topology_template: inputs: SampleInputParameter: type: String description: "Sample parameter description" default: "DefaultSampleValue" node_templates: SampleNode1: tosca.nodes.AWS.VNF Topology template node_templates The TOSCA AWS Nodes. The possible nodes are: VNFD template 59 AWS Telco Network Builder • AWS.VNF • AWS.Artifacts.Helm AWS.VNF Defines an AWS virtual network function (VNF) node. User Guide Syntax tosca.nodes.AWS.VNF: properties: descriptor_id: String descriptor_version: String descriptor_name: String provider: String requirements: helm: String Properties descriptor_id The UUID of the descriptor. Required: Yes Type: String Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} descriptor_version The version of the VNFD. Required: Yes Type: String Pattern: ^[0-9]{1,5}\\.[0-9]{1,5}\\.[0-9]{1,5}.* descriptor_name The name of the descriptor. AWS.VNF 60 User Guide AWS Telco Network Builder Required: Yes Type: String provider The author of the VNFD. Required: Yes Type: String Requirements helm The Helm directory defining container artifacts. This is a reference to AWS.Artifacts.Helm. Required: Yes Type: String Example SampleVNF: type: tosca.nodes.AWS.VNF properties: descriptor_id: "6a792e0c-be2a-45fa-989e-5f89d94ca898" descriptor_version: "1.0.0" descriptor_name: "Test VNF Template" provider: "Operator" requirements: helm: SampleHelm AWS.Artifacts.Helm Defines an AWS Helm Node. Syntax tosca.nodes.AWS.Artifacts.Helm: AWS.Artifacts.Helm 61 AWS Telco Network Builder properties: implementation: String Properties implementation The local directory that contains the Helm chart within the CSAR package. User Guide Required: Yes Type: String Example SampleHelm: type: tosca.nodes.AWS.Artifacts.Helm properties: implementation: "./vnf-helm" Network service descriptor template Defines a network service descriptor (NSD) template. Syntax tosca_definitions_version: tnb_simple_yaml_1_0 vnfds: - descriptor_id: String namespace: String topology_template: inputs: SampleInputParameter: type: String description: "Sample parameter description" default: "DefaultSampleValue" NSD template 62 AWS Telco Network Builder User Guide node_templates: SampleNode1: tosca.nodes.AWS.NS Using defined parameters When you want to dynamically pass a parameter, such as the CIDR block for the VPC node, you can use the { get_input: input-parameter-name } syntax and define the parameters in the NSD template. Then reuse the parameter across the same NSD template. The following example shows how to define and use parameters: tosca_definitions_version: tnb_simple_yaml_1_0 topology_template: inputs: cidr_block: type: String description: "CIDR Block for VPC" default: "10.0.0.0/24" node_templates: ExampleSingleClusterNS: type: tosca.nodes.AWS.NS properties: descriptor_id: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" ..... ExampleVPC: type: tosca.nodes.AWS.Networking.VPC properties: cidr_block: { get_input: cidr_block } VNFD import descriptor_id The UUID of the descriptor. Required: Yes Using defined parameters 63 AWS Telco Network Builder Type: String User Guide Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} namespace The unique name. Required: Yes Type: String Topology template node_templates The possible TOSCA AWS nodes are: • AWS.NS • AWS.Compute.EKS • AWS.Compute.EKS.AuthRole • AWS.Compute.EKSManagedNode • AWS.Compute.EKSSelfManagedNode • AWS.Compute.PlacementGroup • AWS.Compute.UserData • AWS.Networking.SecurityGroup • AWS.Networking.SecurityGroupEgressRule • AWS.Networking.SecurityGroupIngressRule • AWS.Resource.Import • AWS.Networking.ENI • AWS.HookExecution • AWS.Networking.InternetGateway • AWS.Networking.RouteTable • AWS.Networking.Subnet • AWS.Deployment.VNFDeployment Topology template 64 AWS Telco Network Builder User Guide • AWS.Networking.VPC • AWS.Networking.NATGateway • AWS.Networking.Route AWS.NS Defines an AWS network service (NS) node. Syntax tosca.nodes.AWS.NS: properties: descriptor_id: String descriptor_version: String descriptor_name: String Properties descriptor_id The UUID of the descriptor. Required: Yes Type: String Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} descriptor_version The version of the NSD. Required: Yes Type: String Pattern: ^[0-9]{1,5}\\.[0-9]{1,5}\\.[0-9]{1,5}.* descriptor_name The name of the descriptor. AWS.NS 65 AWS Telco Network Builder Required: Yes Type: String Example User Guide SampleNS: type: tosca.nodes.AWS.NS properties: descriptor_id: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" descriptor_version: "1.0.0" descriptor_name: "Test NS Template" AWS.Compute.EKS Provide the name of the cluster, the desired Kubernetes version, and a role that allows the Kubernetes control plane to manage the AWS resources required for your NFs. Multus container network interface (CNI) plugins are enabled. You can attach multiple network interfaces and apply advanced network configuration to the Kubernetes-based network functions. You also specify the cluster endpoint access and the subnets for your cluster. Syntax tosca.nodes.AWS.Compute.EKS: capabilities: multus: properties: enabled: Boolean multus_role: String ebs_csi: properties: enabled: Boolean version: String properties: version: String access: String cluster_role: String tags: List ip_family: String requirements: AWS.Compute.EKS 66 User Guide AWS Telco Network Builder subnets: List Capabilities multus Optional. Properties that define the Multus container network interface (CNI) usage. If you include multus, specify the enabled and multus_role properties. enabled Indicates whether the default Multus capability is enabled. Required: Yes Type: Boolean multus_role The role for Multus network interface management. Required: Yes Type: String ebs_csi Properties that define the Amazon EBS Container Storage Interface (CSI) driver installed in the Amazon EKS cluster. Enable this plugin to use Amazon EKS self-managed nodes on AWS Outposts, AWS Local Zones, or AWS Regions. For more information, see Amazon Elastic Block Store CSI driver in the Amazon EKS User Guide. enabled Indicates whether the default Amazon EBS CSI driver is installed. Required: No Type: Boolean AWS.Compute.EKS 67 AWS Telco Network Builder version User Guide The version of the Amazon EBS CSI driver add-on. The version must match one of the versions returned by the DescribeAddonVersions action. For more information, see DescribeAddonVersions in the Amazon EKS API Reference Required: No Type: String Properties version The Kubernetes version for the cluster. AWS Telco Network Builder supports Kubernetes versions 1.25 through 1.32. Required: Yes Type: String Possible values: 1.25 | 1.26 | 1.27 | 1.28 | 1.29 | 1.30
|
tnb-guide-015
|
tnb-guide.pdf
| 15 |
Amazon EKS User Guide. enabled Indicates whether the default Amazon EBS CSI driver is installed. Required: No Type: Boolean AWS.Compute.EKS 67 AWS Telco Network Builder version User Guide The version of the Amazon EBS CSI driver add-on. The version must match one of the versions returned by the DescribeAddonVersions action. For more information, see DescribeAddonVersions in the Amazon EKS API Reference Required: No Type: String Properties version The Kubernetes version for the cluster. AWS Telco Network Builder supports Kubernetes versions 1.25 through 1.32. Required: Yes Type: String Possible values: 1.25 | 1.26 | 1.27 | 1.28 | 1.29 | 1.30 | 1.31 | 1.32 access The cluster endpoint access. Required: Yes Type: String Possible values: PRIVATE | PUBLIC | ALL cluster_role The role for cluster management. Required: Yes Type: String tags Tags to be attached to the resource. AWS.Compute.EKS 68 AWS Telco Network Builder Required: No Type: List ip_family Indicates the IP family for service and pod addresses in the cluster. User Guide Allowed value: IPv4, IPv6 Default value: IPv4 Required: No Type: String Requirements subnets An AWS.Networking.Subnet node. Required: Yes Type: List Example SampleEKS: type: tosca.nodes.AWS.Compute.EKS properties: version: "1.26" access: "ALL" cluster_role: "arn:aws:iam::${AWS::TNB::AccountId}:role/SampleRole" ip_family: "IPv6" tags: - "Name=SampleVPC" - "Environment=Testing" capabilities: multus: properties: enabled: true multus_role: "arn:aws:iam::${AWS::TNB::AccountId}:role/MultusRole" AWS.Compute.EKS 69 User Guide AWS Telco Network Builder ebs_csi: properties: enabled: true version: "v1.16.0-eksbuild.1" requirements: subnets: - SampleSubnet01 - SampleSubnet02 AWS.Compute.EKS.AuthRole An AuthRole allows you to add IAM roles to the Amazon EKS cluster aws-auth ConfigMap so that users can access the Amazon EKS cluster using an IAM role. Syntax tosca.nodes.AWS.Compute.EKS.AuthRole: properties: role_mappings: List arn: String groups: List requirements: clusters: List Properties role_mappings List of mappings that define IAM roles that need to be added to the Amazon EKS cluster aws- auth ConfigMap. arn The ARN of the IAM role. Required: Yes Type: String groups Kubernetes groups to assign to the role defined in arn. Required: No AWS.Compute.EKS.AuthRole 70 User Guide AWS Telco Network Builder Type: List Requirements clusters An AWS.Compute.EKS node. Required: Yes Type: List Example EKSAuthMapRoles: type: tosca.nodes.AWS.Compute.EKS.AuthRole properties: role_mappings: - arn: arn:aws:iam::${AWS::TNB::AccountId}:role/TNBHookRole1 groups: - system:nodes - system:bootstrappers - arn: arn:aws:iam::${AWS::TNB::AccountId}:role/TNBHookRole2 groups: - system:nodes - system:bootstrappers requirements: clusters: - Free5GCEKS1 - Free5GCEKS2 AWS.Compute.EKSManagedNode AWS TNB supports EKS Managed Node groups to automate the provisioning and lifecycle management of nodes (Amazon EC2 instances) for Amazon EKS Kubernetes clusters. To create an EKS Node group, do the following: • Choose the Amazon Machine Images (AMI) for your cluster workers nodes by providing either the ID of the AMI or the AMI type. • Provide an Amazon EC2 key pair for SSH access and the scaling properties for your node group. AWS.Compute.EKSManagedNode 71 AWS Telco Network Builder User Guide • Ensure that your node group is associated with an Amazon EKS cluster. • Provide the subnets for the worker nodes. • Optionally, attach security groups, node labels, and a placement group to your node group. Syntax tosca.nodes.AWS.Compute.EKSManagedNode: capabilities: compute: properties: ami_type: String ami_id: String instance_types: List key_pair: String root_volume_encryption: Boolean root_volume_encryption_key_arn: String root_volume_size: Integer scaling: properties: desired_size: Integer min_size: Integer max_size: Integer properties: node_role: String tags: List kubernetes_version: String requirements: cluster: String subnets: List network_interfaces: List security_groups: List placement_group: String user_data: String labels: List Capabilities compute Properties that define the computing parameters for the Amazon EKS managed node group, such as, Amazon EC2 instance types and Amazon EC2 instance AMIs. AWS.Compute.EKSManagedNode 72 AWS Telco Network Builder ami_type The Amazon EKS-supported AMI type. Required: Yes Type: String User Guide Possible values: AL2_x86_64 | AL2_x86_64_GPU | AL2_ARM_64 | AL2023_x86_64 | AL2023_ARM_64 | AL2023_x86_64_NVIDIA | AL2023_x86_64_NEURON | CUSTOM | BOTTLEROCKET_ARM_64 | BOTTLEROCKET_x86_64 | BOTTLEROCKET_ARM_64_NVIDIA | BOTTLEROCKET_x86_64_NVIDIA ami_id The ID of the AMI. Required: No Type: String Note If both ami_type and ami_id are specified in the template, AWS TNB will use only the ami_id value to create EKSManagedNode. instance_types The instance size. Required: Yes Type: List key_pair The EC2 Key pair to enable SSH access. Required: Yes Type: String AWS.Compute.EKSManagedNode 73 AWS Telco Network Builder root_volume_encryption User Guide Enables Amazon EBS encryption for the Amazon EBS root volume. If this property is not provided, AWS TNB encrypts Amazon EBS root volumes by default. Required: No Default: true Type: Boolean root_volume_encryption_key_arn The ARN of the AWS KMS key. AWS TNB supports regular key ARN, multi-region key ARN and alias ARN. Required: No Type: String Note • If root_volume_encryption is false, do not include root_volume_encryption_key_arn. • AWS TNB supports root volume encryption of Amazon EBS-backed AMI’s. • If the AMI's root volume is already encrypted, you must include the root_volume_encryption_key_arn for AWS TNB to re-encrypt the root volume. • If the AMI's root volume is not encrypted, AWS TNB uses the root_volume_encryption_key_arn to encrypt the root volume. If you do not include root_volume_encryption_key_arn, AWS TNB uses the default key provided by AWS Key Management Service to encrypt the
|
tnb-guide-016
|
tnb-guide.pdf
| 16 |
key. AWS TNB supports regular key ARN, multi-region key ARN and alias ARN. Required: No Type: String Note • If root_volume_encryption is false, do not include root_volume_encryption_key_arn. • AWS TNB supports root volume encryption of Amazon EBS-backed AMI’s. • If the AMI's root volume is already encrypted, you must include the root_volume_encryption_key_arn for AWS TNB to re-encrypt the root volume. • If the AMI's root volume is not encrypted, AWS TNB uses the root_volume_encryption_key_arn to encrypt the root volume. If you do not include root_volume_encryption_key_arn, AWS TNB uses the default key provided by AWS Key Management Service to encrypt the root volume. • AWS TNB does not decrypt an encrypted AMI. root_volume_size The size of the Amazon Elastic Block Store root volume in GiBs. Required: No AWS.Compute.EKSManagedNode 74 AWS Telco Network Builder Default: 20 Type: Integer Possible values: 1 to 16,384 scaling User Guide Properties that define the scaling parameters for the Amazon EKS managed node group, such as, the desired number of Amazon EC2 instances, and minimum and maximum number of Amazon EC2 instances in the node group. desired_size The number of instances in this NodeGroup. Required: Yes Type: Integer min_size The minimum number of instances in this NodeGroup. Required: Yes Type: Integer max_size The maximum number of instances in this NodeGroup. Required: Yes Type: Integer Properties node_role The ARN of the IAM role that is attached to the Amazon EC2 instance. Required: Yes AWS.Compute.EKSManagedNode 75 AWS Telco Network Builder Type: String tags The tags to be attached to the resource. Required: No Type: List kubernetes_version User Guide The Kubernetes version for the Managed Node group. AWS TNB supports Kubernetes versions 1.25 through 1.32. Consider the following: • Specify either the kubernetes_version or ami_id. Do not specify both. • The kubernetes_version must be less than or equal to the AWS.Compute.EKSManagedNode version. • There can be a difference of 3 versions between the AWS.Compute.EKSManagedNode version and kubernetes_version. • If neither the kubernetes_version or ami_id are specified, AWS TNB will use the latest AMI of the AWS.Compute.EKSManagedNode version to create EKSManagedNode Required: No Type: String Possible values: 1.25 | 1.26 | 1.27 | 1.28 | 1.29 | 1.30 | 1.31 | 1.32 Requirements cluster An AWS.Compute.EKS node. Required: Yes Type: String subnets An AWS.Networking.Subnet node. Required: Yes AWS.Compute.EKSManagedNode 76 AWS Telco Network Builder Type: List network_interfaces User Guide An AWS.Networking.ENI node. Ensure that the network interfaces and subnets are set to the same Availability Zone or instantiation will fail. When you set network_interfaces, AWS TNB obtains the permission related to ENIs from the multus_role property if you included the multus property in the AWS.Compute.EKS node. Otherwise, AWS TNB obtains the permission related to ENIs from the node_role property. Required: No Type: List security_groups An AWS.Networking.SecurityGroup node. Required: No Type: List placement_group A tosca.nodes.AWS.Compute.PlacementGroup node. Required: No Type: String user_data A tosca.nodes.AWS.Compute.UserData node reference. A user data script is passed to the Amazon EC2 instances launched by the managed node group. Add the permissions required to run custom user data to the node_role passed to the node group. Required: No Type: String labels A list of node labels. A node label must have a name and a value. Create a label using the following criteria: • The name and value must be separated by =. AWS.Compute.EKSManagedNode 77 AWS Telco Network Builder User Guide • The name and value can each be up to 63 characters in length. • The label can include letters (A-Z, a-z,), numbers (0-9) and the following characters: [-, _, ., *, ?] • The name and value must start and end with an alphanumeric, ?, or * character. For example, myLabelName1=*NodeLabelValue1 Required: No Type: List Example SampleEKSManagedNode: type: tosca.nodes.AWS.Compute.EKSManagedNode capabilities: compute: properties: ami_type: "AL2_x86_64" instance_types: - "t3.xlarge" key_pair: "SampleKeyPair" root_volume_encryption: true root_volume_encryption_key_arn: "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" root_volume_size: 1500 scaling: properties: desired_size: 1 min_size: 1 max_size: 1 properties: node_role: "arn:aws:iam::${AWS::TNB::AccountId}:role/SampleRole" tags: - "Name=SampleVPC" - "Environment=Testing" kubernetes_version: - "1.30" requirements: cluster: SampleEKS subnets: - SampleSubnet AWS.Compute.EKSManagedNode 78 User Guide AWS Telco Network Builder network_interfaces: - SampleENI01 - SampleENI02 security_groups: - SampleSecurityGroup01 - SampleSecurityGroup02 placement_group: SamplePlacementGroup user_data: CustomUserData labels: - "sampleLabelName001=sampleLabelValue001" - "sampleLabelName002=sampleLabelValue002" AWS.Compute.EKSSelfManagedNode AWS TNB supports Amazon EKS self-managed nodes to automate the provisioning and lifecycle management of nodes (Amazon EC2 instances) for Amazon EKS Kubernetes clusters. To create an Amazon EKS node group, do the following: • Choose the Amazon Machine Images (AMI) for your cluster workers nodes by providing either the ID of the AMI. • Provide an Amazon EC2 key pair for SSH access. • Ensure that your node group is associated with an Amazon EKS cluster. • Provide the instance type and desired, minimum, and maximum sizes. • Provide the subnets for the worker nodes. • Optionally, attach security groups, node labels, and a placement group to your node group. Syntax tosca.nodes.AWS.Compute.EKSSelfManagedNode: capabilities: compute: properties: ami_id: String instance_type:
|
tnb-guide-017
|
tnb-guide.pdf
| 17 |
for Amazon EKS Kubernetes clusters. To create an Amazon EKS node group, do the following: • Choose the Amazon Machine Images (AMI) for your cluster workers nodes by providing either the ID of the AMI. • Provide an Amazon EC2 key pair for SSH access. • Ensure that your node group is associated with an Amazon EKS cluster. • Provide the instance type and desired, minimum, and maximum sizes. • Provide the subnets for the worker nodes. • Optionally, attach security groups, node labels, and a placement group to your node group. Syntax tosca.nodes.AWS.Compute.EKSSelfManagedNode: capabilities: compute: properties: ami_id: String instance_type: String key_pair: String root_volume_encryption: Boolean root_volume_encryption_key_arn: String root_volume_size: Integer scaling: AWS.Compute.EKSSelfManagedNode 79 AWS Telco Network Builder User Guide properties: desired_size: Integer min_size: Integer max_size: Integer properties: node_role: String tags: List requirements: cluster: String subnets: List network_interfaces: List security_groups: List placement_group: String user_data: String labels: List Capabilities compute Properties that define the computing parameters for the Amazon EKS self-managed nodes, such as, Amazon EC2 instance types and Amazon EC2 instance AMIs. ami_id The AMI ID used to launch the instance. AWS TNB supports instances that leverage IMDSv2. For more information, see IMDS version. Note You can update the AMI ID for EKSSelfManagedNode. The Amazon EKS version of the AMI must be the same as or up to 2 versions lower than the Amazon EKS cluster version. For example if the Amazon EKS cluster version is 1.31, then the Amazon EKS AMI version must be 1.31, 1.30, or 1.29. Required: Yes Type: String instance_type The instance size. AWS.Compute.EKSSelfManagedNode 80 User Guide AWS Telco Network Builder Required: Yes Type: String key_pair The Amazon EC2 key pair to enable SSH access. Required: Yes Type: String root_volume_encryption Enables Amazon EBS encryption for the Amazon EBS root volume. If this property is not provided, AWS TNB encrypts Amazon EBS root volumes by default. Required: No Default: true Type: Boolean root_volume_encryption_key_arn The ARN of the AWS KMS key. AWS TNB supports regular key ARN, multi-region key ARN and alias ARN. Required: No Type: String Note • If root_volume_encryption is false, do not include root_volume_encryption_key_arn. • AWS TNB supports root volume encryption of Amazon EBS-backed AMI’s. • If the AMI's root volume is already encrypted, you must include the root_volume_encryption_key_arn for AWS TNB to re-encrypt the root volume. • If the AMI's root volume is not encrypted, AWS TNB uses the root_volume_encryption_key_arn to encrypt the root volume. If you do not include root_volume_encryption_key_arn, AWS TNB uses AWS Managed Services to encrypt the root volume. AWS.Compute.EKSSelfManagedNode 81 AWS Telco Network Builder User Guide • AWS TNB does not decrypt an encrypted AMI. root_volume_size The size of the Amazon Elastic Block Store root volume in GiBs. Required: No Default: 20 Type: Integer Possible values: 1 to 16,384 scaling Properties that define the scaling parameters for the Amazon EKS self-managed nodes, such as, the desired number of Amazon EC2 instances, and minimum and maximum number of Amazon EC2 instances in the node group. desired_size The number of instances in this NodeGroup. Required: Yes Type: Integer min_size The minimum number of instances in this NodeGroup. Required: Yes Type: Integer max_size The maximum number of instances in this NodeGroup. Required: Yes Type: Integer AWS.Compute.EKSSelfManagedNode 82 AWS Telco Network Builder Properties node_role User Guide The ARN of the IAM role that is attached to the Amazon EC2 instance. Required: Yes Type: String tags The tags to be attached to the resource. Tags will be propagated to the instances created by the resource. Required: No Type: List Requirements cluster An AWS.Compute.EKS node. Required: Yes Type: String subnets An AWS.Networking.Subnet node. Required: Yes Type: List network_interfaces An AWS.Networking.ENI node. Ensure that the network interfaces and subnets are set to the same Availability Zone or instantiation will fail. When you set network_interfaces, AWS TNB obtains the permission related to ENIs from the multus_role property if you included the multus property in the AWS.Compute.EKS node. Otherwise, AWS TNB obtains the permission related to ENIs from the node_role property. AWS.Compute.EKSSelfManagedNode 83 User Guide AWS Telco Network Builder Required: No Type: List security_groups An AWS.Networking.SecurityGroup node. Required: No Type: List placement_group A tosca.nodes.AWS.Compute.PlacementGroup node. Required: No Type: String user_data A tosca.nodes.AWS.Compute.UserData node reference. A user data script is passed to the Amazon EC2 instances launched by the self-managed node group. Add the permissions required for executing custom user data to the node_role passed to the node group. Required: No Type: String labels A list of node labels. A node label must have a name and a value. Create a label using the following criteria: • The name and value must be separated by =. • The name and value can each be up to 63 characters in length. • The label can include letters (A-Z, a-z,), numbers (0-9), and the following characters: [-, _, ., *, ?] • The name
|
tnb-guide-018
|
tnb-guide.pdf
| 18 |
the Amazon EC2 instances launched by the self-managed node group. Add the permissions required for executing custom user data to the node_role passed to the node group. Required: No Type: String labels A list of node labels. A node label must have a name and a value. Create a label using the following criteria: • The name and value must be separated by =. • The name and value can each be up to 63 characters in length. • The label can include letters (A-Z, a-z,), numbers (0-9), and the following characters: [-, _, ., *, ?] • The name and value must start and end with an alphanumeric, ?, or * character. For example, myLabelName1=*NodeLabelValue1 Required: No Type: List AWS.Compute.EKSSelfManagedNode 84 AWS Telco Network Builder Example User Guide SampleEKSSelfManagedNode: type: tosca.nodes.AWS.Compute.EKSSelfManagedNode capabilities: compute: properties: ami_id: "ami-123123EXAMPLE" instance_type: "c5.large" key_pair: "SampleKeyPair" root_volume_encryption: true root_volume_encryption_key_arn: "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" root_volume_size: 1500 scaling: properties: desired_size: 1 min_size: 1 max_size: 1 properties: node_role: "arn:aws:iam::${AWS::TNB::AccountId}:role/SampleNodeRole" tags: - "Name=SampleVPC" - "Environment=Testing" requirements: cluster: SampleEKSCluster subnets: - SampleSubnet network_interfaces: - SampleNetworkInterface01 - SampleNetworkInterface02 security_groups: - SampleSecurityGroup01 - SampleSecurityGroup02 placement_group: SamplePlacementGroup user_data: CustomUserData labels: - "sampleLabelName001=sampleLabelValue001" - "sampleLabelName002=sampleLabelValue002" AWS.Compute.PlacementGroup A PlacementGroup node supports different strategies to place Amazon EC2 instances. AWS.Compute.PlacementGroup 85 AWS Telco Network Builder User Guide When you launch a new Amazon EC2instance, the Amazon EC2 service attempts to place the instance in such a way that all of your instances are spread out across underlying hardware to minimize correlated failures. You can use placement groups to influence the placement of a group of interdependent instances to meet the needs of your workload. Syntax tosca.nodes.AWS.Compute.PlacementGroup properties: strategy: String partition_count: Integer tags: List Properties strategy The strategy to use to place Amazon EC2 instances. Required: Yes Type: String Possible values: CLUSTER | PARTITION | SPREAD_HOST | SPREAD_RACK • CLUSTER – packs instances close together inside an Availability Zone. This strategy enables workloads to achieve the low-latency network performance necessary for tightly-coupled node-to-node communication that is typical of high-performance computing (HPC) applications. • PARTITION – spreads your instances across logical partitions such that groups of instances in one partition do not share the underlying hardware with groups of instances in different partitions. This strategy is typically used by large distributed and replicated workloads, such as Hadoop, Cassandra, and Kafka. • SPREAD_RACK – places a small group of instances across distinct underlying hardware to reduce correlated failures. • SPREAD_HOST – used only with Outpost placement groups. Places a small group of instances across distinct underlying hardware to reduce correlated failures. partition_count The number of partitions. AWS.Compute.PlacementGroup 86 AWS Telco Network Builder User Guide Required: Required only when strategy is set to PARTITION. Type: Integer Possible values: 1 | 2 |3 | 4 | 5 | 6 | 7 tags The tags that you can attach to the placement group resource. Required: No Type: List Example ExamplePlacementGroup: type: tosca.nodes.AWS.Compute.PlacementGroup properties: strategy: "PARTITION" partition_count: 5 tags: - tag_key=tag_value AWS.Compute.UserData AWS TNB supports launching Amazon EC2 instances with custom user data, through the UserData node in Network Service Descriptor (NSD). For more information about custom user data, see User data and shell scripts in the Amazon EC2 User Guide. During network instantiation, AWS TNB provides the Amazon EC2 instance registration to the cluster through a user-data script. When custom user data is also provided, AWS TNB merges both scripts and passes them on as a multimime script to Amazon EC2. The custom user-data script is run prior to the Amazon EKS registration script. To use custom variables in the user-data script, add an exclamation mark ! after the open curly brace {. For example, to use MyVariable in the script, enter: {!MyVariable} Note • AWS TNB supports user-data scripts up to 7 KB in size. AWS.Compute.UserData 87 AWS Telco Network Builder User Guide • Because AWS TNB uses AWS CloudFormation to process and render the multimime user- data script, ensure that the script adheres to all AWS CloudFormation rules. Syntax tosca.nodes.AWS.Compute.UserData: properties: implementation: String content_type: String Properties implementation The relative path to the user data script definition. The format must be: ./scripts/ script_name.sh Required: Yes Type: String content_type Content type of the user data script. Required: Yes Type: String Possible values: x-shellscript Example ExampleUserData: type: tosca.nodes.AWS.Compute.UserData properties: content_type: "text/x-shellscript" implementation: "./scripts/customUserData.sh" AWS.Compute.UserData 88 AWS Telco Network Builder User Guide AWS.Networking.SecurityGroup AWS TNB supports security groups to automate the provisioning of Amazon EC2 Security Groups which you can attach to Amazon EKS Kubernetes cluster node groups. Syntax tosca.nodes.AWS.Networking.SecurityGroup properties: description: String name: String tags: List requirements: vpc: String Properties description The description of the security group. You can use up to 255 characters to describe the group. You can include only letters (A-Z and a-z), numbers (0-9), spaces, and the following special characters: ._-:/()#,@[]+=&;{}!$* Required: Yes Type: String name A name for the security
|
tnb-guide-019
|
tnb-guide.pdf
| 19 |
ExampleUserData: type: tosca.nodes.AWS.Compute.UserData properties: content_type: "text/x-shellscript" implementation: "./scripts/customUserData.sh" AWS.Compute.UserData 88 AWS Telco Network Builder User Guide AWS.Networking.SecurityGroup AWS TNB supports security groups to automate the provisioning of Amazon EC2 Security Groups which you can attach to Amazon EKS Kubernetes cluster node groups. Syntax tosca.nodes.AWS.Networking.SecurityGroup properties: description: String name: String tags: List requirements: vpc: String Properties description The description of the security group. You can use up to 255 characters to describe the group. You can include only letters (A-Z and a-z), numbers (0-9), spaces, and the following special characters: ._-:/()#,@[]+=&;{}!$* Required: Yes Type: String name A name for the security group. You can use up to 255 characters for the name. You can include only letters (A-Z and a-z), numbers (0-9), spaces, and the following special characters: ._-:/ ()#,@[]+=&;{}!$* Required: Yes Type: String tags The tags that you can attach to the security group resource. Required: No AWS.Networking.SecurityGroup 89 User Guide AWS Telco Network Builder Type: List Requirements vpc An AWS.Networking.VPC node. Required: Yes Type: String Example SampleSecurityGroup001: type: tosca.nodes.AWS.Networking.SecurityGroup properties: description: "Sample Security Group for Testing" name: "SampleSecurityGroup" tags: - "Name=SecurityGroup" - "Environment=Testing" requirements: vpc: SampleVPC AWS.Networking.SecurityGroupEgressRule AWS TNB supports security group egress rules to automate the provisioning of Amazon EC2 Security Group Egress Rules which can be attached to AWS.Networking.SecurityGroup. Note that you must provide a cidr_ip/destination_security_group/destination_prefix_list as the destination for egress traffic. Syntax AWS.Networking.SecurityGroupEgressRule properties: ip_protocol: String from_port: Integer to_port: Integer description: String AWS.Networking.SecurityGroupEgressRule 90 AWS Telco Network Builder User Guide destination_prefix_list: String cidr_ip: String cidr_ipv6: String requirements: security_group: String destination_security_group: String Properties cidr_ip The IPv4 address range in CIDR format. You must specify a CIDR range that allows egress traffic. Required: No Type: String cidr_ipv6 The IPv6 address range in CIDR format, for egress traffic. You must specify a destination security group (destination_security_group or destination_prefix_list) or a CIDR range (cidr_ip or cidr_ipv6). Required: No Type: String description The description of an egress (outbound) security group rule. You can use up to 255 characters to describe the rule. Required: No Type: String destination_prefix_list The prefix list ID of an existing Amazon VPC managed prefix list. This is the destination from node group instances associated with the security group. For more information on managed prefix lists, see Managed prefix lists in the Amazon VPC User Guide. Required: No AWS.Networking.SecurityGroupEgressRule 91 AWS Telco Network Builder Type: String from_port User Guide If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes. Required: No Type: Integer ip_protocol The IP protocol name (tcp, udp, icmp, icmpv6) or protocol number. Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed. Required: Yes Type: String to_port If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes. Required: No Type: Integer Requirements security_group The ID of the security group to which this rule is to be added. Required: Yes Type: String AWS.Networking.SecurityGroupEgressRule 92 AWS Telco Network Builder User Guide destination_security_group The ID or TOSCA reference of the destination security group to which egress traffic is allowed. Required: No Type: String Example SampleSecurityGroupEgressRule: type: tosca.nodes.AWS.Networking.SecurityGroupEgressRule properties: ip_protocol: "tcp" from_port: 8000 to_port: 9000 description: "Egress Rule for sample security group" cidr_ipv6: "2600:1f14:3758:ca00::/64" requirements: security_group: SampleSecurityGroup001 destination_security_group: SampleSecurityGroup002 AWS.Networking.SecurityGroupIngressRule AWS TNB supports security group ingress rules to automate the provisioning of Amazon EC2 Security Group Ingress Rules which can be attached to AWS.Networking.SecurityGroup. Note that you must provide a cidr_ip/source_security_group/source_prefix_list as the source for ingress traffic. Syntax AWS.Networking.SecurityGroupIngressRule properties: ip_protocol: String from_port: Integer to_port: Integer description: String source_prefix_list: String cidr_ip: String cidr_ipv6: String requirements: AWS.Networking.SecurityGroupIngressRule 93 AWS Telco Network Builder User Guide security_group: String source_security_group: String Properties cidr_ip The IPv4 address range in CIDR format. You must specify a CIDR range that allows ingress traffic. Required: No Type: String cidr_ipv6 The IPv6 address range in CIDR format, for ingress traffic. You must specify a source security group (source_security_group or source_prefix_list) or a CIDR range (cidr_ip or cidr_ipv6). Required: No Type: String description The description of an ingress (inbound) security group rule. You can use up to 255 characters to describe the rule. Required: No Type: String source_prefix_list
|
tnb-guide-020
|
tnb-guide.pdf
| 20 |
source_prefix_list: String cidr_ip: String cidr_ipv6: String requirements: AWS.Networking.SecurityGroupIngressRule 93 AWS Telco Network Builder User Guide security_group: String source_security_group: String Properties cidr_ip The IPv4 address range in CIDR format. You must specify a CIDR range that allows ingress traffic. Required: No Type: String cidr_ipv6 The IPv6 address range in CIDR format, for ingress traffic. You must specify a source security group (source_security_group or source_prefix_list) or a CIDR range (cidr_ip or cidr_ipv6). Required: No Type: String description The description of an ingress (inbound) security group rule. You can use up to 255 characters to describe the rule. Required: No Type: String source_prefix_list The prefix list ID of an existing Amazon VPC managed prefix list. This is the source from which node group instances associated with the security group will be allowed to receive traffic from. For more information on managed prefix lists, see Managed prefix lists in the Amazon VPC User Guide. Required: No Type: String AWS.Networking.SecurityGroupIngressRule 94 AWS Telco Network Builder from_port User Guide If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes. Required: No Type: Integer ip_protocol The IP protocol name (tcp, udp, icmp, icmpv6) or protocol number. Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed. Required: Yes Type: String to_port If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes. Required: No Type: Integer Requirements security_group The ID of the security group to which this rule is to be added. Required: Yes Type: String AWS.Networking.SecurityGroupIngressRule 95 AWS Telco Network Builder source_security_group User Guide The ID or TOSCA reference of the source security group from which ingress traffic is to be allowed. Required: No Type: String Example SampleSecurityGroupIngressRule: type: tosca.nodes.AWS.Networking.SecurityGroupIngressRule properties: ip_protocol: "tcp" from_port: 8000 to_port: 9000 description: "Ingress Rule for free5GC cluster on IPv6" cidr_ipv6: "2600:1f14:3758:ca00::/64" requirements: security_group: SampleSecurityGroup1 source_security_group: SampleSecurityGroup2 AWS.Resource.Import You can import the following AWS resources into AWS TNB: • VPC • Subnet • Route Table • Internet Gateway • Security Group Syntax tosca.nodes.AWS.Resource.Import properties: resource_type: String AWS.Resource.Import 96 User Guide AWS Telco Network Builder resource_id: String Properties resource_type The resource type that is imported to AWS TNB. Required: No Type: List resource_id The resource ID that is imported to AWS TNB. Required: No Type: List Example SampleImportedVPC: type: tosca.nodes.AWS.Resource.Import properties: resource_type: "tosca.nodes.AWS.Networking.VPC" resource_id: "vpc-123456" AWS.Networking.ENI A network interface is a logical networking component in a VPC that represents a virtual network card. A network interface is assigned an IP address either automatically or manually based on its subnet. After you deploy an Amazon EC2 instance in a subnet, you can attach a network interface to it, or detach a network interface from that Amazon EC2 instance and reattach to another Amazon EC2 instance in that subnet. The device index identifies the position in the attachment order. Syntax tosca.nodes.AWS.Networking.ENI: properties: AWS.Networking.ENI 97 AWS Telco Network Builder User Guide device_index: Integer source_dest_check: Boolean tags: List requirements: subnet: String security_groups: List Properties device_index The device index must be greater than zero. Required: Yes Type: Integer source_dest_check Indicates whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. Allowed value: true, false Default: true Required: No Type: Boolean tags The tags to be attached to the resource. Required: No Type: List Requirements subnet An AWS.Networking.Subnet node. AWS.Networking.ENI 98 User Guide AWS Telco Network Builder Required: Yes Type: String security_groups An AWS.Networking.SecurityGroup node. Required: No Type: String Example SampleENI: type: tosca.nodes.AWS.Networking.ENI properties: device_index: 5 source_dest_check: true tags: - "Name=SampleVPC" - "Environment=Testing" requirements: subnet: SampleSubnet security_groups: - SampleSecurityGroup01 - SampleSecurityGroup02 AWS.HookExecution A lifecycle hook provides you with the ability to run your own scripts as part of your infrastructure and network instantiation. Syntax tosca.nodes.AWS.HookExecution: capabilities: execution: properties: type: String requirements: definition: String AWS.HookExecution 99 AWS Telco Network Builder vpc: String Capabilities execution Properties for the hook execution engine that runs the hook scripts. User Guide type The hook execution engine type. Required: No Type: String Possible values: CODE_BUILD Requirements definition An AWS.HookDefinition.Bash node. Required: Yes Type: String vpc An AWS.Networking.VPC node. Required: Yes Type:
|
tnb-guide-021
|
tnb-guide.pdf
| 21 |
5 source_dest_check: true tags: - "Name=SampleVPC" - "Environment=Testing" requirements: subnet: SampleSubnet security_groups: - SampleSecurityGroup01 - SampleSecurityGroup02 AWS.HookExecution A lifecycle hook provides you with the ability to run your own scripts as part of your infrastructure and network instantiation. Syntax tosca.nodes.AWS.HookExecution: capabilities: execution: properties: type: String requirements: definition: String AWS.HookExecution 99 AWS Telco Network Builder vpc: String Capabilities execution Properties for the hook execution engine that runs the hook scripts. User Guide type The hook execution engine type. Required: No Type: String Possible values: CODE_BUILD Requirements definition An AWS.HookDefinition.Bash node. Required: Yes Type: String vpc An AWS.Networking.VPC node. Required: Yes Type: String Example SampleHookExecution: type: tosca.nodes.AWS.HookExecution requirements: definition: SampleHookScript AWS.HookExecution 100 User Guide AWS Telco Network Builder vpc: SampleVPC AWS.Networking.InternetGateway Defines an AWS Internet Gateway Node. Syntax tosca.nodes.AWS.Networking.InternetGateway: capabilities: routing: properties: dest_cidr: String ipv6_dest_cidr: String properties: tags: List egress_only: Boolean requirements: vpc: String route_table: String Capabilities routing Properties that define the routing connection within the VPC. You must include either the dest_cidr or ipv6_dest_cidr property. dest_cidr The IPv4 CIDR block used for the destination match. This property is used to create a route in RouteTable and its value is used as the DestinationCidrBlock. Required: No if you included the ipv6_dest_cidr property. Type: String ipv6_dest_cidr The IPv6 CIDR block used for the destination match. Required: No if you included the dest_cidr property. AWS.Networking.InternetGateway 101 User Guide AWS Telco Network Builder Type: String Properties tags The tags to be attached to the resource. Required: No Type: List egress_only An IPv6-specific property. Indicates if the internet gateway is only for egress communication or not. When egress_only is true, you must define the ipv6_dest_cidr property. Required: No Type: Boolean Requirements vpc An AWS.Networking.VPC node. Required: Yes Type: String route_table An AWS.Networking.RouteTable node. Required: Yes Type: String Example Free5GCIGW: type: tosca.nodes.AWS.Networking.InternetGateway AWS.Networking.InternetGateway 102 User Guide AWS Telco Network Builder properties: egress_only: false capabilities: routing: properties: dest_cidr: "0.0.0.0/0" ipv6_dest_cidr: "::/0" requirements: route_table: Free5GCRouteTable vpc: Free5GCVPC Free5GCEGW: type: tosca.nodes.AWS.Networking.InternetGateway properties: egress_only: true capabilities: routing: properties: ipv6_dest_cidr: "::/0" requirements: route_table: Free5GCPrivateRouteTable vpc: Free5GCVPC AWS.Networking.RouteTable A route table contains a set of rules, called routes, that determine where network traffic from subnets within your VPC or gateway is directed. You must associate a route table with a VPC. Syntax tosca.nodes.AWS.Networking.RouteTable: properties: tags: List requirements: vpc: String Properties tags Tags to be attached to the resource. Required: No AWS.Networking.RouteTable 103 User Guide AWS Telco Network Builder Type: List Requirements vpc An AWS.Networking.VPC node. Required: Yes Type: String Example SampleRouteTable: type: tosca.nodes.AWS.Networking.RouteTable properties: tags: - "Name=SampleVPC" - "Environment=Testing" requirements: vpc: SampleVPC AWS.Networking.Subnet A subnet is a range of IP addresses in your VPC, and it must reside entirely within one Availability Zone. You must specify a VPC, a CIDR block, Availability Zone, and a route table for your subnet. You must also define whether your subnet is private or public. Syntax tosca.nodes.AWS.Networking.Subnet: properties: type: String availability_zone: String cidr_block: String ipv6_cidr_block: String ipv6_cidr_block_suffix: String outpost_arn: String tags: List requirements: AWS.Networking.Subnet 104 AWS Telco Network Builder vpc: String route_table: String Properties type User Guide Indicates whether instances launched in this subnet receive a public IPv4 address. Required: Yes Type: String Possible values: PUBLIC | PRIVATE availability_zone The Availability Zone for the subnet. This field supports AWS Availability Zones within a AWS Region, for example us-west-2 (US West (Oregon)). It also supports AWS Local Zones within the Availability Zone, for example us-west-2-lax-1a. Required: Yes Type: String cidr_block The CIDR block for the subnet. Required: No Type: String ipv6_cidr_block The CIDR block used to create the IPv6 subnet. If you include this property, do not include ipv6_cidr_block_suffix. Required: No Type: String ipv6_cidr_block_suffix The 2-digit hexadecimal suffix of the IPv6 CIDR block for the subnet created over Amazon VPC. Use the following format: 2-digit hexadecimal::/subnetMask AWS.Networking.Subnet 105 AWS Telco Network Builder User Guide If you include this property, do not include ipv6_cidr_block. Required: No Type: String outpost_arn The ARN of AWS Outposts that the subnet will be created in. Add this property to the NSD template if you want to launch Amazon EKS self-managed nodes on AWS Outposts. For more information, see Amazon EKS on AWS Outposts in the Amazon EKS User Guide. If you add this property to the NSD template, you must set the value for the availability_zone property to the Availability Zone of the AWS Outposts. Required: No Type: String tags The tags to be attached to the resource. Required: No Type: List Requirements vpc An AWS.Networking.VPC node. Required: Yes Type: String route_table An AWS.Networking.RouteTable node. Required: Yes Type: String AWS.Networking.Subnet 106 AWS Telco Network Builder Example SampleSubnet01: type: tosca.nodes.AWS.Networking.Subnet properties: type: "PUBLIC" availability_zone: "us-east-1a" cidr_block: "10.100.50.0/24" ipv6_cidr_block_suffix: "aa::/64" outpost_arn: "arn:aws:outposts:region:accountId:outpost/op-11223344EXAMPLE" User Guide tags: - "Name=SampleVPC" - "Environment=Testing" requirements: vpc: SampleVPC route_table: SampleRouteTable SampleSubnet02: type: tosca.nodes.AWS.Networking.Subnet properties: type: "PUBLIC" availability_zone: "us-west-2b" cidr_block: "10.100.50.0/24" ipv6_cidr_block: "2600:1f14:3758:ca00::/64" requirements: route_table: SampleRouteTable vpc: SampleVPC AWS.Deployment.VNFDeployment NF deployments are
|
tnb-guide-022
|
tnb-guide.pdf
| 22 |
for the availability_zone property to the Availability Zone of the AWS Outposts. Required: No Type: String tags The tags to be attached to the resource. Required: No Type: List Requirements vpc An AWS.Networking.VPC node. Required: Yes Type: String route_table An AWS.Networking.RouteTable node. Required: Yes Type: String AWS.Networking.Subnet 106 AWS Telco Network Builder Example SampleSubnet01: type: tosca.nodes.AWS.Networking.Subnet properties: type: "PUBLIC" availability_zone: "us-east-1a" cidr_block: "10.100.50.0/24" ipv6_cidr_block_suffix: "aa::/64" outpost_arn: "arn:aws:outposts:region:accountId:outpost/op-11223344EXAMPLE" User Guide tags: - "Name=SampleVPC" - "Environment=Testing" requirements: vpc: SampleVPC route_table: SampleRouteTable SampleSubnet02: type: tosca.nodes.AWS.Networking.Subnet properties: type: "PUBLIC" availability_zone: "us-west-2b" cidr_block: "10.100.50.0/24" ipv6_cidr_block: "2600:1f14:3758:ca00::/64" requirements: route_table: SampleRouteTable vpc: SampleVPC AWS.Deployment.VNFDeployment NF deployments are modeled by providing the infrastructure and the application associated to it. The cluster attribute specifies the EKS cluster to host your NFs. The vnfs attribute specifies the network functions for your deployment. You can also provide optional lifecycle hooks operations of type pre_create and post_create to run instructions specific to your deployment, such as calling an Inventory Management system API. Syntax tosca.nodes.AWS.Deployment.VNFDeployment: requirements: deployment: String cluster: String AWS.Deployment.VNFDeployment 107 User Guide AWS Telco Network Builder vnfs: List interfaces: Hook: pre_create: String post_create: String Requirements deployment An AWS.Deployment.VNFDeployment node. Required: No Type: String cluster An AWS.Compute.EKS node. Required: Yes Type: String vnfs An AWS.VNF node. Required: Yes Type: String Interfaces Hooks Defines the stage when lifecycle hooks are run. pre_create An AWS.HookExecution node. This hook is run before the VNFDeployment node deploys. Required: No AWS.Deployment.VNFDeployment 108 AWS Telco Network Builder Type: String post_create User Guide An AWS.HookExecution node. This hook is run after the VNFDeployment node deploys. Required: No Type: String Example SampleHelmDeploy: type: tosca.nodes.AWS.Deployment.VNFDeployment requirements: deployment: SampleHelmDeploy2 cluster: SampleEKS vnfs: - vnf.SampleVNF interfaces: Hook: pre_create: SampleHook AWS.Networking.VPC You must specify a CIDR block for your virtual private cloud (VPC). Syntax tosca.nodes.AWS.Networking.VPC: properties: cidr_block: String ipv6_cidr_block: String dns_support: String tags: List Properties cidr_block The IPv4 network range for the VPC, in CIDR notation. AWS.Networking.VPC 109 User Guide AWS Telco Network Builder Required: Yes Type: String ipv6_cidr_block The IPv6 CIDR block used to create the VPC. Allowed value: AMAZON_PROVIDED Required: No Type: String dns_support Indicates whether the instances launched in the VPC get DNS hostnames. Required: No Type: Boolean Default: false tags Tags to be attached to the resource. Required: No Type: List Example SampleVPC: type: tosca.nodes.AWS.Networking.VPC properties: cidr_block: "10.100.0.0/16" ipv6_cidr_block: "AMAZON_PROVIDED" dns_support: true tags: - "Name=SampleVPC" - "Environment=Testing" AWS.Networking.VPC 110 AWS Telco Network Builder User Guide AWS.Networking.NATGateway You can define a public or private NAT Gateway node over a subnet. For a public gateway, if you do not provide an Elastic IP allocation id, AWS TNB will allocate an Elastic IP for your account and associate that to the gateway. Syntax tosca.nodes.AWS.Networking.NATGateway: requirements: subnet: String internet_gateway: String properties: type: String eip_allocation_id: String tags: List Properties subnet The AWS.Networking.Subnet node reference. Required: Yes Type: String internet_gateway The AWS.Networking.InternetGateway node reference. Required: Yes Type: String Properties type Indicates if the gateway is public or private. Allowed value: PUBLIC, PRIVATE AWS.Networking.NATGateway 111 AWS Telco Network Builder Required: Yes Type: String eip_allocation_id The ID that represents the allocation of the Elastic IP address. User Guide Required: No Type: String tags Tags to be attached to the resource. Required: No Type: List Example Free5GCNatGateway01: type: tosca.nodes.AWS.Networking.NATGateway requirements: subnet: Free5GCSubnet01 internet_gateway: Free5GCIGW properties: type: PUBLIC eip_allocation_id: eipalloc-12345 AWS.Networking.Route You can define a route node that associates the destination route to the NAT Gateway as the target resource, and adds the route to the associated route table. Syntax tosca.nodes.AWS.Networking.Route: properties: dest_cidr_blocks: List requirements: AWS.Networking.Route 112 User Guide AWS Telco Network Builder nat_gateway: String route_table: String Properties dest_cidr_blocks The list of destination IPv4 routes to the target resource. Required: Yes Type: List Member type: String Requirements nat_gateway The AWS.Networking.NATGateway node reference. Required: Yes Type: String route_table The AWS.Networking.RouteTable node reference. Required: Yes Type: String Example Free5GCRoute: type: tosca.nodes.AWS.Networking.Route properties: dest_cidr_blocks: - 0.0.0.0/0 - 10.0.0.0/28 requirements: AWS.Networking.Route 113 AWS Telco Network Builder User Guide nat_gateway: Free5GCNatGateway01 route_table: Free5GCRouteTable AWS.Store.SSMParameters You can create SSM parameters through AWS TNB. The SSM parameters that you create are created in SSM and prefixed by the AWS TNB network instance ID. This prevents parameter values from an override when multiple instances are instantiated and upgraded using the same NSD template. Syntax tosca.nodes.AWS.Store.SSMParameters properties: parameters: name: String value: String tags: List Properties Parameters name The name of the ssm property. Use the following format: ^[a-zA-Z0-9]+[a-zA-Z0-9\- \_]*[a-zA-Z0-9]+$ Each parameter's name must be less than 256 characters. Required: Yes Type: String value The value of the ssm property. Use one of the following formats: • For values without references: ^[a-zA-Z0-9]+[a-zA-Z0-9\-\_]*[a-zA-Z0-9]+$ • For static references: ^\$\{[a-zA-Z0-9]+\.(properties|capabilities| requirements)(\.([a-zA-Z0-9\-_]+))+\}$ • For dynamic references: ^\$\{[a-zA-Z0-9]+\.(name|id|arn)\}$ AWS.Store.SSMParameters 114 AWS Telco Network Builder User Guide Each parameter’s value must be less than 4 KB. Required: Yes Type: String tags The tags that you can attach to an SSM property. Required: No Type: List Example
|
tnb-guide-023
|
tnb-guide.pdf
| 23 |
String value: String tags: List Properties Parameters name The name of the ssm property. Use the following format: ^[a-zA-Z0-9]+[a-zA-Z0-9\- \_]*[a-zA-Z0-9]+$ Each parameter's name must be less than 256 characters. Required: Yes Type: String value The value of the ssm property. Use one of the following formats: • For values without references: ^[a-zA-Z0-9]+[a-zA-Z0-9\-\_]*[a-zA-Z0-9]+$ • For static references: ^\$\{[a-zA-Z0-9]+\.(properties|capabilities| requirements)(\.([a-zA-Z0-9\-_]+))+\}$ • For dynamic references: ^\$\{[a-zA-Z0-9]+\.(name|id|arn)\}$ AWS.Store.SSMParameters 114 AWS Telco Network Builder User Guide Each parameter’s value must be less than 4 KB. Required: Yes Type: String tags The tags that you can attach to an SSM property. Required: No Type: List Example SampleSSM type: tosca.nodes.AWS.Store.SSMParameters properties: parameters: - name: "Name1" value: "Value1" - name: "EKS_VERSION" value: "${SampleEKS.properties.version}" - name: "VPC_ID" value: "${SampleVPC.id} - name: "REGION" value: "${AWS::Region} tags: - "tagKey=tagValue" Common nodes Define nodes for the NSD and VNFD. • AWS.HookDefinition.Bash AWS.HookDefinition.Bash Defines an AWS HookDefinition in bash. Common nodes 115 User Guide AWS Telco Network Builder Syntax tosca.nodes.AWS.HookDefinition.Bash: properties: implementation: String environment_variables: List execution_role: String Properties implementation The relative path to the hook definition. The format must be: ./hooks/script_name.sh Required: Yes Type: String environment_variables The environment variables for the hook bash script. Use the following format: envName=envValue with the following regex patterns: • For values without references: ^[a-zA-Z0-9]+[a-zA-Z0-9\-\_]*[a-zA-Z0-9]+=[a- zA-Z0-9]+[a-zA-Z0-9\-\_]*[a-zA-Z0-9]+$ • For static references: ^[a-zA-Z0-9]+[a-zA-Z0-9\-\_]*[a-zA-Z0-9]+=\$\{[a-zA- Z0-9]+\.(properties|capabilities|requirements)(\.([a-zA-Z0-9\-_]+))+ \}$ • For dynamic references: ^[a-zA-Z0-9]+[a-zA-Z0-9\-\_]*[a-zA-Z0-9]+=\$\{[a-zA- Z0-9]+\.(name|id|arn)\}$ Ensure that the envName=envValue value meets the following criteria: • Do not use spaces. • Start envName with a letter (A-Z or a-z) or number (0-9). • Do not start the environment variable name with the following AWS TNB reserved keywords (case insensitive): • CODEBUILD • TNB • HOME AWS.HookDefinition.Bash 116 AWS Telco Network Builder • AWS User Guide • You can use any number of letters (A-Z or a-z), numbers (0-9), and special characters - and _ for envName and envValue. • Each environment variable (each envName=envValue) must be less than 128 characters. Example: A123-45xYz=Example_789 Required: No Type: List execution_role The role for hook execution. Required: Yes Type: String Example SampleHookScript: type: tosca.nodes.AWS.HookDefinition.Bash properties: implementation: "./hooks/myhook.sh" environment_variables: - "variable01=value01" - "variable02=value02" execution_role: "arn:aws:iam::${AWS::TNB::AccountId}:role/SampleHookPermission" AWS.HookDefinition.Bash 117 AWS Telco Network Builder User Guide Security in AWS TNB Cloud security at AWS is the highest priority. As an AWS customer, you benefit from data centers and network architectures that are built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud. AWS also provides you with services that you can use securely. Third-party auditors regularly test and verify the effectiveness of our security as part of the AWS Compliance Programs. To learn about the compliance programs that apply to AWS Telco Network Builder, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors including the sensitivity of your data, your company’s requirements, and applicable laws and regulations. This documentation helps you understand how to apply the shared responsibility model when using AWS TNB. The following topics show you how to configure AWS TNB to meet your security and compliance objectives. You also learn how to use other AWS services that help you to monitor and secure your AWS TNB resources. Contents • Data protection in AWS TNB • Identity and access management for AWS TNB • Compliance validation for AWS TNB • Resilience in AWS TNB • Infrastructure security in AWS TNB • IMDS version Data protection in AWS TNB The AWS shared responsibility model applies to data protection in AWS Telco Network Builder. As described in this model, AWS is responsible for protecting the global infrastructure that runs all Data protection 118 AWS Telco Network Builder User Guide of the AWS Cloud. You are responsible for maintaining control over your content that is hosted on this infrastructure. You are also responsible for the security configuration and management tasks for the AWS services that you use. For more information about data privacy, see the Data Privacy FAQ. For information about data protection in Europe, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulfill their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. We require TLS
|
tnb-guide-024
|
tnb-guide.pdf
| 24 |
Data Privacy FAQ. For information about data protection in Europe, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulfill their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. We require TLS 1.2 and recommend TLS 1.3. • Set up API and user activity logging with AWS CloudTrail. For information about using CloudTrail trails to capture AWS activities, see Working with CloudTrail trails in the AWS CloudTrail User Guide. • Use AWS encryption solutions, along with all default security controls within AWS services. • Use advanced managed security services such as Amazon Macie, which assists in discovering and securing sensitive data that is stored in Amazon S3. • If you require FIPS 140-3 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-3. We strongly recommend that you never put confidential or sensitive information, such as your customers' email addresses, into tags or free-form text fields such as a Name field. This includes when you work with AWS TNB or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text fields used for names may be used for billing or diagnostic logs. If you provide a URL to an external server, we strongly recommend that you do not include credentials information in the URL to validate your request to that server. Data handling When you close your AWS account, AWS TNB marks your data for deletion and removes it from any use. If you reactivate your AWS account within 90 days, AWS TNB restores your data. After 120 days, AWS TNB permanently deletes your data. AWS TNB also terminates your networks and deletes your function packages and your network packages. Data handling 119 AWS Telco Network Builder Encryption at rest User Guide AWS TNB always encrypts all data stored in the service at rest without requiring any additional configuration. This encryption is automatic through AWS Key Management Service. Encryption in transit AWS TNB secures all data in transit using Transport Layer Security (TLS) 1.2. It is your responsibility to encrypt data between your simulation agents and their clients. Inter-network traffic privacy AWS TNB compute resources reside in a virtual private cloud (VPC) shared by all customers. All internal AWS TNB traffic stayed within the AWS network and doesn't traverse the internet. Connections between your simulation agents and their clients are routed over the internet. Identity and access management for AWS TNB AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use AWS TNB resources. IAM is an AWS service that you can use with no additional charge. Contents • Audience • Authenticating with identities • Managing access using policies • How AWS TNB works with IAM • Identity-based policy examples for AWS Telco Network Builder • Troubleshooting AWS Telco Network Builder identity and access Audience How you use AWS Identity and Access Management (IAM) differs, depending on the work that you do in AWS TNB. Encryption at rest 120 AWS Telco Network Builder User Guide Service user – If you use the AWS TNB service to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more AWS TNB features to do your work, you might need additional permissions. Understanding how access is managed can help you request the right permissions from your administrator. If you cannot access a feature in AWS TNB, see Troubleshooting AWS Telco Network Builder identity and access. Service administrator – If you're in charge of AWS TNB resources at your company, you probably have full access to AWS TNB. It's your job to determine which AWS TNB features and resources your service users should access. You must then submit requests to your IAM administrator to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with AWS TNB, see How AWS TNB works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access
|
tnb-guide-025
|
tnb-guide.pdf
| 25 |
at your company, you probably have full access to AWS TNB. It's your job to determine which AWS TNB features and resources your service users should access. You must then submit requests to your IAM administrator to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with AWS TNB, see How AWS TNB works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to AWS TNB. To view example AWS TNB identity-based policies that you can use in IAM, see Identity-based policy examples for AWS Telco Network Builder. Authenticating with identities Authentication is how you sign in to AWS using your identity credentials. You must be authenticated (signed in to AWS) as the AWS account root user, as an IAM user, or by assuming an IAM role. You can sign in to AWS as a federated identity by using credentials provided through an identity source. AWS IAM Identity Center (IAM Identity Center) users, your company's single sign-on authentication, and your Google or Facebook credentials are examples of federated identities. When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles. When you access AWS by using federation, you are indirectly assuming a role. Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal. For more information about signing in to AWS, see How to sign in to your AWS account in the AWS Sign-In User Guide. If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If you don't use AWS tools, you must sign requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Authenticating with identities 121 AWS Telco Network Builder User Guide Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an AWS account, you begin with one sign-in identity that has complete access to all AWS services and resources in the account. This identity is called the AWS account root user and is accessed by signing in with the email address and password that you used to create the account. We strongly recommend that you don't use the root user for your everyday tasks. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform. For the complete list of tasks that require you to sign in as the root user, see Tasks that require root user credentials in the IAM User Guide. Federated identity As a best practice, require human users, including users that require administrator access, to use federation with an identity provider to access AWS services by using temporary credentials. A federated identity is a user from your enterprise user directory, a web identity provider, the AWS Directory Service, the Identity Center directory, or any user that accesses AWS services by using credentials provided through an identity source. When federated identities access AWS accounts, they assume roles, and the roles provide temporary credentials. For centralized access management, we recommend that you use AWS IAM Identity Center. You can create users and groups in IAM Identity Center, or you can connect and synchronize to a set of users and groups in your own identity source for use across all your AWS accounts and applications. For information about IAM Identity Center, see What is IAM Identity Center? in the AWS IAM Identity Center User Guide. IAM users and groups An IAM user is an identity within your AWS account that has specific permissions for a single person or application. Where possible, we recommend relying on temporary credentials instead of creating IAM users who have long-term credentials such as passwords and access keys. However, if you have specific use cases that require long-term credentials with IAM users, we recommend that you rotate access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. Authenticating with identities 122 AWS Telco Network Builder User Guide An IAM group is an identity that specifies a collection of IAM users. You can't sign
|
tnb-guide-026
|
tnb-guide.pdf
| 26 |
has specific permissions for a single person or application. Where possible, we recommend relying on temporary credentials instead of creating IAM users who have long-term credentials such as passwords and access keys. However, if you have specific use cases that require long-term credentials with IAM users, we recommend that you rotate access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. Authenticating with identities 122 AWS Telco Network Builder User Guide An IAM group is an identity that specifies a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Users are different from roles. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it. Users have permanent long-term credentials, but roles provide temporary credentials. To learn more, see Use cases for IAM users in the IAM User Guide. IAM roles An IAM role is an identity within your AWS account that has specific permissions. It is similar to an IAM user, but is not associated with a specific person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and define permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are defined by the role. For information about roles for federation, see Create a role for a third-party identity provider (federation) in the IAM User Guide. If you use IAM Identity Center, you configure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on different permissions for a specific task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a different account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource (instead of using a role as a proxy). To learn the difference between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or Authenticating with identities 123 AWS Telco Network Builder User Guide store objects in Amazon S3. A service might do this using the calling principal's permissions, using a service role, or using a service-linked role. • Forward access sessions (FAS) – When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. • Service role – A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned
|
tnb-guide-027
|
tnb-guide.pdf
| 27 |
Forward access sessions. • Service role – A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance profile that is attached to the instance. An instance profile contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, defines their permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request. Permissions in the policies determine whether the request is allowed or denied. Most policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Managing access using policies 124 AWS Telco Network Builder User Guide Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies define permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Identity-based policies Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account. Managed policies include AWS managed policies and customer managed policies. To learn how to choose between a managed policy or an inline policy, see Choose between managed policies and inline policies in the IAM User Guide. Resource-based policies Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. Resource-based policies are inline policies that are located in that service. You can't use AWS managed policies from IAM in a resource-based policy. Managing access using policies 125 AWS Telco Network Builder Access control lists (ACLs) User Guide Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple
|
tnb-guide-028
|
tnb-guide.pdf
| 28 |
policies are inline policies that are located in that service. You can't use AWS managed policies from IAM in a resource-based policy. Managing access using policies 125 AWS Telco Network Builder Access control lists (ACLs) User Guide Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Other policy types AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user or role). You can set a permissions boundary for an entity. The resulting permissions are the intersection of an entity's identity-based policies and its permissions boundaries. Resource-based policies that specify the user or role in the Principal field are not limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If you enable all features in an organization, then you can apply service control policies (SCPs) to any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the effective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's Managing access using policies 126 AWS Telco Network Builder User Guide permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Multiple policy types When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide. How AWS TNB works with IAM Before you use IAM to manage access to AWS TNB, learn what IAM features are available to use with AWS TNB. IAM features you can use with AWS Telco Network Builder IAM feature AWS TNB support Identity-based policies Resource-based policies Policy actions Policy resources Policy condition keys ACLs ABAC (tags in policies) Temporary credentials Principal permissions Service roles Service-linked roles Yes No Yes Yes Yes No Yes Yes Yes No No How AWS TNB works with IAM 127 AWS Telco Network Builder User Guide To get a high-level view of how AWS TNB and other AWS services work with most IAM features, see AWS services that work with IAM in the IAM User Guide. Identity-based policies for AWS TNB Supports identity-based policies: Yes Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. You can't specify the principal in an identity-based policy because it applies to the user or role to which it is attached. To learn about all
|
tnb-guide-029
|
tnb-guide.pdf
| 29 |
such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. You can't specify the principal in an identity-based policy because it applies to the user or role to which it is attached. To learn about all of the elements that you can use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide. Identity-based policy examples for AWS TNB To view examples of AWS TNB identity-based policies, see Identity-based policy examples for AWS Telco Network Builder. Resource-based policies within AWS TNB Supports resource-based policies: No Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. To enable cross-account access, you can specify an entire account or IAM entities in another account as the principal in a resource-based policy. Adding a cross-account principal to a resource- based policy is only half of establishing the trust relationship. When the principal and the resource are in different AWS accounts, an IAM administrator in the trusted account must also grant the principal entity (user or role) permission to access the resource. They grant permission by How AWS TNB works with IAM 128 AWS Telco Network Builder User Guide attaching an identity-based policy to the entity. However, if a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information, see Cross account resource access in IAM in the IAM User Guide. Policy actions for AWS TNB Supports policy actions: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. To see a list of AWS TNB actions, see Actions defined by AWS Telco Network Builder in the Service Authorization Reference. Policy actions in AWS TNB use the following prefix before the action: tnb To specify multiple actions in a single statement, separate them with commas. "Action": [ "tnb:CreateSolFunctionPackage", "tnb:DeleteSolFunctionPackage" ] You can specify multiple actions using wildcards (*). For example, to specify all actions that begin with the word List, include the following action: "Action": "tnb:List*" To view examples of AWS TNB identity-based policies, see Identity-based policy examples for AWS Telco Network Builder. How AWS TNB works with IAM 129 AWS Telco Network Builder User Guide Policy resources for AWS TNB Supports policy resources: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Resource JSON policy element specifies the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. As a best practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a specific resource type, known as resource-level permissions. For actions that don't support resource-level permissions, such as listing operations, use a wildcard (*) to indicate that the statement applies to all resources. "Resource": "*" To see a list of AWS TNB resource types and their ARNs, see Resources defined by AWS Telco Network Builder in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions defined by AWS Telco Network Builder. To view examples of AWS TNB identity-based policies, see Identity-based policy examples for AWS Telco Network Builder. Policy condition keys for AWS TNB Supports service-specific policy condition keys: Yes Administrators can use AWS JSON policies to specify who has
|
tnb-guide-030
|
tnb-guide.pdf
| 30 |
use a wildcard (*) to indicate that the statement applies to all resources. "Resource": "*" To see a list of AWS TNB resource types and their ARNs, see Resources defined by AWS Telco Network Builder in the Service Authorization Reference. To learn with which actions you can specify the ARN of each resource, see Actions defined by AWS Telco Network Builder. To view examples of AWS TNB identity-based policies, see Identity-based policy examples for AWS Telco Network Builder. Policy condition keys for AWS TNB Supports service-specific policy condition keys: Yes Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Condition element (or Condition block) lets you specify conditions in which a statement is in effect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted. How AWS TNB works with IAM 130 AWS Telco Network Builder User Guide You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM policy elements: variables and tags in the IAM User Guide. AWS supports global condition keys and service-specific condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. To see a list of AWS TNB condition keys, see Condition keys for AWS Telco Network Builder in the Service Authorization Reference. To learn with which actions and resources you can use a condition key, see Actions defined by AWS Telco Network Builder. To view examples of AWS TNB identity-based policies, see Identity-based policy examples for AWS Telco Network Builder. ACLs in AWS TNB Supports ACLs: No Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. ABAC with AWS TNB Supports ABAC (tags in policies): Yes Attribute-based access control (ABAC) is an authorization strategy that defines permissions based on attributes. In AWS, these attributes are called tags. You can attach tags to IAM entities (users or roles) and to many AWS resources. Tagging entities and resources is the first step of ABAC. Then you design ABAC policies to allow operations when the principal's tag matches the tag on the resource that they are trying to access. ABAC is helpful in environments that are growing rapidly and helps with situations where policy management becomes cumbersome. To control access based on tags, you provide tag information in the condition element of a policy using the aws:ResourceTag/key-name, aws:RequestTag/key-name, or aws:TagKeys condition keys. If a service supports all three condition keys for every resource type, then the value is Yes for the service. If a service supports all three condition keys for only some resource types, then the value is Partial. How AWS TNB works with IAM 131 AWS Telco Network Builder User Guide For more information about ABAC, see Define permissions with ABAC authorization in the IAM User Guide. To view a tutorial with steps for setting up ABAC, see Use attribute-based access control (ABAC) in the IAM User Guide. Using temporary credentials with AWS TNB Supports temporary credentials: Yes Some AWS services don't work when you sign in using temporary credentials. For additional information, including which AWS services work with temporary credentials, see AWS services that work with IAM in the IAM User Guide. You are using temporary credentials if you sign in to the AWS Management Console using any method except a user name and password. For example, when you access AWS using your company's single sign-on (SSO) link, that process automatically creates temporary credentials. You also automatically create temporary credentials when you sign in to the console as a user and then switch roles. For more information about switching roles, see Switch from a user to an IAM role (console) in the IAM User Guide. You can manually create temporary credentials using the AWS CLI or AWS API. You can then use those temporary credentials to access AWS. AWS recommends that you dynamically generate temporary credentials instead of using long-term access keys. For more information, see Temporary security credentials in IAM. Cross-service principal permissions
|
tnb-guide-031
|
tnb-guide.pdf
| 31 |
single sign-on (SSO) link, that process automatically creates temporary credentials. You also automatically create temporary credentials when you sign in to the console as a user and then switch roles. For more information about switching roles, see Switch from a user to an IAM role (console) in the IAM User Guide. You can manually create temporary credentials using the AWS CLI or AWS API. You can then use those temporary credentials to access AWS. AWS recommends that you dynamically generate temporary credentials instead of using long-term access keys. For more information, see Temporary security credentials in IAM. Cross-service principal permissions for AWS TNB Supports forward access sessions (FAS): Yes When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. Service roles for AWS TNB Supports service roles: No How AWS TNB works with IAM 132 AWS Telco Network Builder User Guide A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. Service-linked roles for AWS TNB Supports service-linked roles: No A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. Identity-based policy examples for AWS Telco Network Builder By default, users and roles don't have permission to create or modify AWS TNB resources. They also can't perform tasks by using the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS API. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. To learn how to create an IAM identity-based policy by using these example JSON policy documents, see Create IAM policies (console) in the IAM User Guide. For details about actions and resource types defined by AWS TNB, including the format of the ARNs for each of the resource types, see Actions, resources, and condition keys for AWS Telco Network Builder in the Service Authorization Reference. Contents • Policy best practices • Using the AWS TNB console • Service role policy examples • Allow users to view their own permissions Policy best practices Identity-based policies determine whether someone can create, access, or delete AWS TNB resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: Identity-based policy examples 133 AWS Telco Network Builder User Guide • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by defining AWS customer managed policies that are specific to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by defining the actions that can be taken on specific resources under specific conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a specific AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to
|
tnb-guide-032
|
tnb-guide.pdf
| 32 |
permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a specific AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security. To require MFA when API operations are called, add MFA conditions to your policies. For more information, see Secure API access with MFA in the IAM User Guide. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Using the AWS TNB console To access the AWS Telco Network Builder console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the AWS TNB resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum Identity-based policy examples 134 AWS Telco Network Builder User Guide required permissions, the console won't function as intended for entities (users or roles) with that policy. You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API operation that they're trying to perform. Service role policy examples As an administrator, you own and manage the resources that AWS TNB creates as defined by the environment and service templates. You must attach IAM service roles to your account to permit AWS TNB to create resources for your network life-cycle management. A IAM service role allows AWS TNB to make calls to resources on your behalf to instantiate and manage your networks. If you specify a service role, AWS TNB uses that role’s credential. You create the service role and its permission policy with the IAM service. For more information about creating a service role, see Creating a role to delegate permissions to an AWS service in the IAM User Guide. AWS TNB service role As a member of the platform team, you can as an administrator create an AWS TNB service role and provide it to AWS TNB. This role allows AWS TNB to make calls to other services such as Amazon Elastic Kubernetes Service and AWS CloudFormation to provision the required infrastructure for your network and provision network functions as defined in your NSD. We recommend that you use the following IAM role and trust policy for your AWS TNB service role. When scoping down permission on this policy, keep in mind that AWS TNB may fail with Access Denied errors toward resources descoped from your policy. The following code shows an AWS TNB service role policy: { "Version": "2012-10-17", "Statement": [ { "Action": [ "sts:GetCallerIdentity" ], "Resource": "*", "Effect": "Allow", Identity-based policy examples 135 AWS Telco Network Builder User Guide "Sid": "AssumeRole" }, { "Action": [ "tnb:*" ], "Resource": "*", "Effect": "Allow", "Sid": "TNBPolicy" }, { "Action": [ "iam:AddRoleToInstanceProfile", "iam:CreateInstanceProfile", "iam:DeleteInstanceProfile", "iam:GetInstanceProfile", "iam:RemoveRoleFromInstanceProfile", "iam:TagInstanceProfile", "iam:UntagInstanceProfile" ], "Resource": "*", "Effect": "Allow", "Sid": "IAMPolicy" }, { "Condition": { "StringEquals": { "iam:AWSServiceName": [ "eks.amazonaws.com", "eks-nodegroup.amazonaws.com" ] } }, "Action": [ "iam:CreateServiceLinkedRole" ], "Resource": "*", "Effect": "Allow", "Sid": "TNBAccessSLRPermissions" }, { "Action": [ "autoscaling:CreateAutoScalingGroup", "autoscaling:CreateOrUpdateTags", Identity-based policy examples 136 AWS Telco Network Builder User Guide "autoscaling:DeleteAutoScalingGroup", "autoscaling:DeleteTags", "autoscaling:DescribeAutoScalingGroups", "autoscaling:DescribeAutoScalingInstances", "autoscaling:DescribeScalingActivities", "autoscaling:DescribeTags", "autoscaling:UpdateAutoScalingGroup", "ec2:AuthorizeSecurityGroupEgress", "ec2:AuthorizeSecurityGroupIngress", "ec2:CreateLaunchTemplate", "ec2:CreateLaunchTemplateVersion", "ec2:CreateSecurityGroup", "ec2:DeleteLaunchTemplateVersions", "ec2:DescribeLaunchTemplates", "ec2:DescribeLaunchTemplateVersions", "ec2:DeleteLaunchTemplate", "ec2:DeleteSecurityGroup", "ec2:DescribeSecurityGroups", "ec2:DescribeTags", "ec2:GetLaunchTemplateData", "ec2:RevokeSecurityGroupEgress", "ec2:RevokeSecurityGroupIngress", "ec2:RunInstances", "ec2:AssociateRouteTable", "ec2:AttachInternetGateway", "ec2:CreateInternetGateway", "ec2:CreateNetworkInterface", "ec2:CreateRoute", "ec2:CreateRouteTable", "ec2:CreateSubnet", "ec2:CreateTags", "ec2:CreateVpc", "ec2:DeleteInternetGateway", "ec2:DeleteNetworkInterface", "ec2:DeleteRoute", "ec2:DeleteRouteTable", "ec2:DeleteSubnet", "ec2:DeleteTags", "ec2:DeleteVpc", "ec2:DetachNetworkInterface", "ec2:DescribeInstances", "ec2:DescribeInternetGateways", "ec2:DescribeKeyPairs", "ec2:DescribeNetworkInterfaces", Identity-based policy examples 137 AWS Telco Network Builder User Guide "ec2:DescribeRouteTables", "ec2:DescribeSecurityGroupRules", "ec2:DescribeSubnets", "ec2:DescribeVpcs", "ec2:DetachInternetGateway", "ec2:DisassociateRouteTable", "ec2:ModifySecurityGroupRules", "ec2:ModifySubnetAttribute", "ec2:ModifyVpcAttribute", "ec2:AllocateAddress", "ec2:AssignIpv6Addresses", "ec2:AssociateAddress", "ec2:AssociateNatGatewayAddress", "ec2:AssociateVpcCidrBlock", "ec2:CreateEgressOnlyInternetGateway", "ec2:CreateNatGateway", "ec2:DeleteEgressOnlyInternetGateway", "ec2:DeleteNatGateway", "ec2:DescribeAddresses", "ec2:DescribeEgressOnlyInternetGateways", "ec2:DescribeNatGateways", "ec2:DisassociateAddress", "ec2:DisassociateNatGatewayAddress", "ec2:DisassociateVpcCidrBlock", "ec2:ReleaseAddress", "ec2:UnassignIpv6Addresses", "ec2:DescribeImages", "eks:CreateCluster", "eks:ListClusters", "eks:RegisterCluster", "eks:TagResource", "eks:DescribeAddonVersions", "events:DescribeRule", "iam:GetRole", "iam:ListAttachedRolePolicies", "iam:PassRole" ], "Resource": "*", "Effect": "Allow", "Sid": "TNBAccessComputePerms" }, { "Action": [ "codebuild:BatchDeleteBuilds", Identity-based policy examples 138 AWS
|
tnb-guide-033
|
tnb-guide.pdf
| 33 |
"ec2:AuthorizeSecurityGroupEgress", "ec2:AuthorizeSecurityGroupIngress", "ec2:CreateLaunchTemplate", "ec2:CreateLaunchTemplateVersion", "ec2:CreateSecurityGroup", "ec2:DeleteLaunchTemplateVersions", "ec2:DescribeLaunchTemplates", "ec2:DescribeLaunchTemplateVersions", "ec2:DeleteLaunchTemplate", "ec2:DeleteSecurityGroup", "ec2:DescribeSecurityGroups", "ec2:DescribeTags", "ec2:GetLaunchTemplateData", "ec2:RevokeSecurityGroupEgress", "ec2:RevokeSecurityGroupIngress", "ec2:RunInstances", "ec2:AssociateRouteTable", "ec2:AttachInternetGateway", "ec2:CreateInternetGateway", "ec2:CreateNetworkInterface", "ec2:CreateRoute", "ec2:CreateRouteTable", "ec2:CreateSubnet", "ec2:CreateTags", "ec2:CreateVpc", "ec2:DeleteInternetGateway", "ec2:DeleteNetworkInterface", "ec2:DeleteRoute", "ec2:DeleteRouteTable", "ec2:DeleteSubnet", "ec2:DeleteTags", "ec2:DeleteVpc", "ec2:DetachNetworkInterface", "ec2:DescribeInstances", "ec2:DescribeInternetGateways", "ec2:DescribeKeyPairs", "ec2:DescribeNetworkInterfaces", Identity-based policy examples 137 AWS Telco Network Builder User Guide "ec2:DescribeRouteTables", "ec2:DescribeSecurityGroupRules", "ec2:DescribeSubnets", "ec2:DescribeVpcs", "ec2:DetachInternetGateway", "ec2:DisassociateRouteTable", "ec2:ModifySecurityGroupRules", "ec2:ModifySubnetAttribute", "ec2:ModifyVpcAttribute", "ec2:AllocateAddress", "ec2:AssignIpv6Addresses", "ec2:AssociateAddress", "ec2:AssociateNatGatewayAddress", "ec2:AssociateVpcCidrBlock", "ec2:CreateEgressOnlyInternetGateway", "ec2:CreateNatGateway", "ec2:DeleteEgressOnlyInternetGateway", "ec2:DeleteNatGateway", "ec2:DescribeAddresses", "ec2:DescribeEgressOnlyInternetGateways", "ec2:DescribeNatGateways", "ec2:DisassociateAddress", "ec2:DisassociateNatGatewayAddress", "ec2:DisassociateVpcCidrBlock", "ec2:ReleaseAddress", "ec2:UnassignIpv6Addresses", "ec2:DescribeImages", "eks:CreateCluster", "eks:ListClusters", "eks:RegisterCluster", "eks:TagResource", "eks:DescribeAddonVersions", "events:DescribeRule", "iam:GetRole", "iam:ListAttachedRolePolicies", "iam:PassRole" ], "Resource": "*", "Effect": "Allow", "Sid": "TNBAccessComputePerms" }, { "Action": [ "codebuild:BatchDeleteBuilds", Identity-based policy examples 138 AWS Telco Network Builder User Guide "codebuild:BatchGetBuilds", "codebuild:CreateProject", "codebuild:DeleteProject", "codebuild:ListBuildsForProject", "codebuild:StartBuild", "codebuild:StopBuild", "events:DeleteRule", "events:PutRule", "events:PutTargets", "events:RemoveTargets", "s3:CreateBucket", "s3:GetBucketAcl", "s3:GetObject", "eks:DescribeNodegroup", "eks:DeleteNodegroup", "eks:AssociateIdentityProviderConfig", "eks:CreateNodegroup", "eks:DeleteCluster", "eks:DeregisterCluster", "eks:UpdateAddon", "eks:UpdateClusterVersion", "eks:UpdateNodegroupConfig", "eks:UpdateNodegroupVersion", "eks:DescribeUpdate", "eks:UntagResource", "eks:DescribeCluster", "eks:ListNodegroups", "eks:CreateAddon", "eks:DeleteAddon", "eks:DescribeAddon", "eks:DescribeAddonVersions", "s3:PutObject", "cloudformation:CreateStack", "cloudformation:DeleteStack", "cloudformation:DescribeStackResources", "cloudformation:DescribeStacks", "cloudformation:UpdateStack", "cloudformation:UpdateTerminationProtection", "ssm:PutParameter", "ssm:GetParameters", "ssm:GetParameter", "ssm:DeleteParameter", "ssm:AddTagsToResource", "ssm:ListTagsForResource", Identity-based policy examples 139 AWS Telco Network Builder User Guide "ssm:RemoveTagsFromResource" ], "Resource": [ "arn:aws:events:*:*:rule/tnb*", "arn:aws:codebuild:*:*:project/tnb*", "arn:aws:logs:*:*:log-group:/aws/tnb*", "arn:aws:s3:::tnb*", "arn:aws:eks:*:*:addon/tnb*/*/*", "arn:aws:eks:*:*:cluster/tnb*", "arn:aws:eks:*:*:nodegroup/tnb*/tnb*/*", "arn:aws:cloudformation:*:*:stack/tnb*", "arn:aws:ssm:*:*:parameter/tnb/*" ], "Effect": "Allow", "Sid": "TNBAccessInfraResourcePerms" }, { "Sid": "CFNTemplatePerms", "Effect": "Allow", "Action": [ "cloudformation:GetTemplateSummary" ], "Resource": "*" }, { "Sid": "ImageAMISSMPerms", "Effect": "Allow", "Action": [ "ssm:GetParameters" ], "Resource": [ "arn:aws:ssm:*::parameter/aws/service/eks/optimized-ami/*", "arn:aws:ssm:*::parameter/aws/service/bottlerocket/*" ] }, { "Action": [ "tag:GetResources" ], "Resource": "*", "Effect": "Allow", "Sid": "TaggingPolicy" }, { Identity-based policy examples 140 AWS Telco Network Builder User Guide "Action": [ "outposts:GetOutpost" ], "Resource": "*", "Effect": "Allow", "Sid": "OutpostPolicy" } ] } The following code shows the AWS TNB service trust policy: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "ec2.amazonaws.com" }, "Action": "sts:AssumeRole" }, { "Effect": "Allow", "Principal": { "Service": "events.amazonaws.com" }, "Action": "sts:AssumeRole" }, { "Effect": "Allow", "Principal": { "Service": "codebuild.amazonaws.com" }, "Action": "sts:AssumeRole" }, { "Effect": "Allow", "Principal": { "Service": "eks.amazonaws.com" }, "Action": "sts:AssumeRole" }, Identity-based policy examples 141 User Guide AWS Telco Network Builder { "Effect": "Allow", "Principal": { "Service": "tnb.amazonaws.com" }, "Action": "sts:AssumeRole" } ] } AWS TNB service role for Amazon EKS cluster When you create an Amazon EKS resources in your NSD, you provide the cluster_role attribute to specify which role will be used to create your Amazon EKS cluster. The following example shows a AWS CloudFormation template that creates a AWS TNB service role for the Amazon EKS cluster policy. AWSTemplateFormatVersion: "2010-09-09" Resources: TNBEKSClusterRole: Type: "AWS::IAM::Role" Properties: RoleName: "TNBEKSClusterRole" AssumeRolePolicyDocument: Version: "2012-10-17" Statement: - Effect: Allow Principal: Service: - eks.amazonaws.com Action: - "sts:AssumeRole" Path: / ManagedPolicyArns: - !Sub "arn:${AWS::Partition}:iam::aws:policy/AmazonEKSClusterPolicy" For more information about IAM roles using AWS CloudFormation template, see the following sections in the AWS CloudFormation User Guide: • AWS::IAM::Role • Selecting a stack template Identity-based policy examples 142 AWS Telco Network Builder User Guide AWS TNB service role for Amazon EKS node group When you create an Amazon EKS node group resources in your NSD, you provide the node_role attribute to specify which role will be used to create your Amazon EKS node group. The following example shows a AWS CloudFormation template that creates a AWS TNB service role for the Amazon EKS node group policy. AWSTemplateFormatVersion: "2010-09-09" Resources: TNBEKSNodeRole: Type: "AWS::IAM::Role" Properties: RoleName: "TNBEKSNodeRole" AssumeRolePolicyDocument: Version: "2012-10-17" Statement: - Effect: Allow Principal: Service: - ec2.amazonaws.com Action: - "sts:AssumeRole" Path: / ManagedPolicyArns: - !Sub "arn:${AWS::Partition}:iam::aws:policy/AmazonEKSWorkerNodePolicy" - !Sub "arn:${AWS::Partition}:iam::aws:policy/AmazonEKS_CNI_Policy" - !Sub "arn:${AWS::Partition}:iam::aws:policy/ AmazonEC2ContainerRegistryReadOnly" - !Sub "arn:${AWS::Partition}:iam::aws:policy/service-role/ AmazonEBSCSIDriverPolicy" Policies: - PolicyName: EKSNodeRoleInlinePolicy PolicyDocument: Version: "2012-10-17" Statement: - Effect: Allow Action: - "logs:DescribeLogStreams" - "logs:PutLogEvents" - "logs:CreateLogGroup" - "logs:CreateLogStream" Resource: "arn:aws:logs:*:*:log-group:/aws/tnb/tnb*" Identity-based policy examples 143 AWS Telco Network Builder User Guide - PolicyName: EKSNodeRoleIpv6CNIPolicy PolicyDocument: Version: "2012-10-17" Statement: - Effect: Allow Action: - "ec2:AssignIpv6Addresses" Resource: "arn:aws:ec2:*:*:network-interface/*" For more information about IAM roles using AWS CloudFormation template, see the following sections in the AWS CloudFormation User Guide: • AWS::IAM::Role • Selecting a stack template AWS TNB service role for Multus When you create an Amazon EKS resource in your NSD and you want to manage Multus as part of your deployment template, you must provide the multus_role attribute to specify which role will be used for managing Multus. The following example shows a AWS CloudFormation template that creates a AWS TNB service role for a Multus policy. AWSTemplateFormatVersion: "2010-09-09" Resources: TNBMultusRole: Type: "AWS::IAM::Role" Properties: RoleName: "TNBMultusRole" AssumeRolePolicyDocument: Version: "2012-10-17" Statement: - Effect: Allow Principal: Service: - events.amazonaws.com Action: - "sts:AssumeRole" - Effect: Allow Principal: Identity-based policy examples 144 User Guide AWS Telco Network Builder Service: - codebuild.amazonaws.com Action: - "sts:AssumeRole" Path: / Policies: - PolicyName: MultusRoleInlinePolicy PolicyDocument: Version: "2012-10-17" Statement: - Effect: Allow Action: - "codebuild:StartBuild" - "logs:DescribeLogStreams" - "logs:PutLogEvents" - "logs:CreateLogGroup" - "logs:CreateLogStream" Resource: - "arn:aws:codebuild:*:*:project/tnb*" - "arn:aws:logs:*:*:log-group:/aws/tnb/*" - Effect: Allow Action: - "ec2:CreateNetworkInterface" - "ec2:ModifyNetworkInterfaceAttribute" - "ec2:AttachNetworkInterface" - "ec2:DeleteNetworkInterface" - "ec2:CreateTags" - "ec2:DetachNetworkInterface" Resource: "*" For more information about IAM roles using AWS CloudFormation template, see the following sections in the AWS CloudFormation User Guide: • AWS::IAM::Role • Selecting a
|
tnb-guide-034
|
tnb-guide.pdf
| 34 |
Allow Principal: Service: - events.amazonaws.com Action: - "sts:AssumeRole" - Effect: Allow Principal: Identity-based policy examples 144 User Guide AWS Telco Network Builder Service: - codebuild.amazonaws.com Action: - "sts:AssumeRole" Path: / Policies: - PolicyName: MultusRoleInlinePolicy PolicyDocument: Version: "2012-10-17" Statement: - Effect: Allow Action: - "codebuild:StartBuild" - "logs:DescribeLogStreams" - "logs:PutLogEvents" - "logs:CreateLogGroup" - "logs:CreateLogStream" Resource: - "arn:aws:codebuild:*:*:project/tnb*" - "arn:aws:logs:*:*:log-group:/aws/tnb/*" - Effect: Allow Action: - "ec2:CreateNetworkInterface" - "ec2:ModifyNetworkInterfaceAttribute" - "ec2:AttachNetworkInterface" - "ec2:DeleteNetworkInterface" - "ec2:CreateTags" - "ec2:DetachNetworkInterface" Resource: "*" For more information about IAM roles using AWS CloudFormation template, see the following sections in the AWS CloudFormation User Guide: • AWS::IAM::Role • Selecting a stack template AWS TNB service role for a life-cycle hook policy When your NSD or network function package uses a life-cycle hook, you need a service role to allow you to create an environment for execution of your life-cycle hooks. Identity-based policy examples 145 AWS Telco Network Builder User Guide Note Your life-cycle hook policy should be based on what your life-cycle hook is attempting to do. The following example shows a AWS CloudFormation template that creates a AWS TNB service role for a life-cycle hook policy. AWSTemplateFormatVersion: "2010-09-09" Resources: TNBHookRole: Type: "AWS::IAM::Role" Properties: RoleName: "TNBHookRole" AssumeRolePolicyDocument: Version: "2012-10-17" Statement: - Effect: Allow Principal: Service: - codebuild.amazonaws.com Action: - "sts:AssumeRole" Path: / ManagedPolicyArns: - !Sub "arn:${AWS::Partition}:iam::aws:policy/AdministratorAccess" For more information about IAM roles using AWS CloudFormation template, see the following sections in the AWS CloudFormation User Guide: • AWS::IAM::Role • Selecting a stack template Allow users to view their own permissions This example shows how you might create a policy that allows IAM users to view the inline and managed policies that are attached to their user identity. This policy includes permissions to complete this action on the console or programmatically using the AWS CLI or AWS API. Identity-based policy examples 146 AWS Telco Network Builder User Guide { "Version": "2012-10-17", "Statement": [ { "Sid": "ViewOwnUserInfo", "Effect": "Allow", "Action": [ "iam:GetUserPolicy", "iam:ListGroupsForUser", "iam:ListAttachedUserPolicies", "iam:ListUserPolicies", "iam:GetUser" ], "Resource": ["arn:aws:iam::*:user/${aws:username}"] }, { "Sid": "NavigateInConsole", "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" ], "Resource": "*" } ] } Troubleshooting AWS Telco Network Builder identity and access Use the following information to help you diagnose and fix common issues that you might encounter when working with AWS TNB and IAM. Issues • I am not authorized to perform an action in AWS TNB • I am not authorized to perform iam:PassRole Troubleshooting 147 AWS Telco Network Builder User Guide • I want to allow people outside of my AWS account to access my AWS TNB resources I am not authorized to perform an action in AWS TNB If you receive an error that you're not authorized to perform an action, your policies must be updated to allow you to perform the action. The following example error occurs when the mateojackson IAM user tries to use the console to view details about a fictional my-example-widget resource but does not have the fictional tnb:GetWidget permissions. User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: tnb:GetWidget on resource: my-example-widget In this case, Mateo's policy must be updated to allow him to access the my-example-widget resource using the tnb:GetWidget action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I am not authorized to perform iam:PassRole If you receive an error that you're not authorized to perform the iam:PassRole action, your policies must be updated to allow you to pass a role to AWS TNB. Some AWS services allow you to pass an existing role to that service instead of creating a new service role or service-linked role. To do this, you must have permissions to pass the role to the service. The following example error occurs when an IAM user named marymajor tries to use the console to perform an action in AWS TNB. However, the action requires the service to have permissions that are granted by a service role. Mary does not have permissions to pass the role to the service. User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole In this case, Mary's policies must be updated to allow her to perform the iam:PassRole action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. Troubleshooting 148 AWS Telco Network Builder User Guide I want to allow people outside of my AWS account to access my AWS TNB resources You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: • To learn
|
tnb-guide-035
|
tnb-guide.pdf
| 35 |
Your administrator is the person who provided you with your sign-in credentials. Troubleshooting 148 AWS Telco Network Builder User Guide I want to allow people outside of my AWS account to access my AWS TNB resources You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: • To learn whether AWS TNB supports these features, see How AWS TNB works with IAM. • To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User Guide. • To learn how to provide access to your resources to third-party AWS accounts, see Providing access to AWS accounts owned by third parties in the IAM User Guide. • To learn how to provide access through identity federation, see Providing access to externally authenticated users (identity federation) in the IAM User Guide. • To learn the difference between using roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. Compliance validation for AWS TNB To learn whether an AWS service is within the scope of specific compliance programs, see AWS services in Scope by Compliance Program and choose the compliance program that you are interested in. For general information, see AWS Compliance Programs. You can download third-party audit reports using AWS Artifact. For more information, see Downloading Reports in AWS Artifact. Your compliance responsibility when using AWS services is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations. AWS provides the following resources to help with compliance: • Security Compliance & Governance – These solution implementation guides discuss architectural considerations and provide steps for deploying security and compliance features. • HIPAA Eligible Services Reference – Lists HIPAA eligible services. Not all AWS services are HIPAA eligible. Compliance validation 149 AWS Telco Network Builder User Guide • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • AWS Customer Compliance Guides – Understand the shared responsibility model through the lens of compliance. The guides summarize the best practices for securing AWS services and map the guidance to security controls across multiple frameworks (including National Institute of Standards and Technology (NIST), Payment Card Industry Security Standards Council (PCI), and International Organization for Standardization (ISO)). • Evaluating Resources with Rules in the AWS Config Developer Guide – The AWS Config service assesses how well your resource configurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS. Security Hub uses security controls to evaluate your AWS resources and to check your compliance against security industry standards and best practices. For a list of supported services and controls, see Security Hub controls reference. • Amazon GuardDuty – This AWS service detects potential threats to your AWS accounts, workloads, containers, and data by monitoring your environment for suspicious and malicious activities. GuardDuty can help you address various compliance requirements, like PCI DSS, by meeting intrusion detection requirements mandated by certain compliance frameworks. • AWS Audit Manager – This AWS service helps you continuously audit your AWS usage to simplify how you manage risk and compliance with regulations and industry standards. Resilience in AWS TNB The AWS global infrastructure is built around AWS Regions and Availability Zones. AWS Regions provide multiple physically separated and isolated Availability Zones, which are connected with low-latency, high-throughput, and highly redundant networking. With Availability Zones, you can design and operate applications and databases that automatically fail over between zones without interruption. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures. For more information about AWS Regions and Availability Zones, see AWS Global Infrastructure. AWS TNB runs your Network Service on EKS clusters in a virtual private cloud (VPC) in the AWS Region that you choose. Resilience 150 AWS Telco Network Builder User Guide Infrastructure security in AWS TNB As a managed service, AWS Telco Network Builder is protected by AWS global network security. For information about AWS security services and how AWS protects infrastructure, see AWS Cloud Security. To design your AWS environment using the best practices for infrastructure security, see Infrastructure Protection in Security Pillar AWS Well‐Architected Framework. You use AWS published API calls to access AWS TNB through the network. Clients must support the following: • Transport Layer Security (TLS). We
|
tnb-guide-036
|
tnb-guide.pdf
| 36 |
a virtual private cloud (VPC) in the AWS Region that you choose. Resilience 150 AWS Telco Network Builder User Guide Infrastructure security in AWS TNB As a managed service, AWS Telco Network Builder is protected by AWS global network security. For information about AWS security services and how AWS protects infrastructure, see AWS Cloud Security. To design your AWS environment using the best practices for infrastructure security, see Infrastructure Protection in Security Pillar AWS Well‐Architected Framework. You use AWS published API calls to access AWS TNB through the network. Clients must support the following: • Transport Layer Security (TLS). We require TLS 1.2 and recommend TLS 1.3. • Cipher suites with perfect forward secrecy (PFS) such as DHE (Ephemeral Diffie-Hellman) or ECDHE (Elliptic Curve Ephemeral Diffie-Hellman). Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal. Or you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Here are some examples of shared responsibilities: • AWS is responsible for securing components that support AWS TNB, including: • Compute instances (also known as workers) • Internal databases • Network communications between internal components • The AWS TNB application programming interface (API) • AWS Software Development Kits (SDK) • You are responsible for securing your access to your AWS resources and your workload components, including (but not limited to): • IAM users, groups, roles, and policies • S3 buckets that you use to store your data for AWS TNB • Other AWS services and resources that you use to support the network service that you provisioned through AWS TNB • Your application code Infrastructure security 151 AWS Telco Network Builder User Guide • Connections between the network service that you provisioned through AWS TNB and its clients Important You are responsible for implementing a disaster recovery plan that can effectively recover a network service that you provisioned through AWS TNB. Network connectivity security model The network services that you provision through AWS TNB, run on compute instances within a virtual private cloud (VPC) located in an AWS Region that you select. A VPC is a virtual network in the AWS Cloud, which isolates infrastructure by workload or organizational entity. Communication between compute instances within VPCs stay within the AWS network and don't travel over the internet. Some internal service communication crosses the internet, and is encrypted. Network services provisioned through AWS TNB for all customers running in the same Region share the same VPC. Network services provisioned through AWS TNB for different customers use separate compute instances within the same VPC. Communications between your network service clients and your network service in AWS TNB traverse the internet. AWS TNB does not manage these connections. It is your responsibility to secure your client connections. Your connections to AWS TNB through the AWS Management Console, AWS Command Line Interface (AWS CLI), and AWS SDKs are encrypted. IMDS version AWS TNB supports instances that leverage Instance Metadata Service version 2 (IMDSv2), a session-oriented method. IMDSv2 includes higher security than IMDSV1. For more information, see Add defense in depth against open firewalls, reverse proxies, and SSRF vulnerabilities with enhancements to the Amazon EC2 Instance Metadata Service. When launching your instance, you must use IMDSv2. For more information on IMDSv2, see Use IMDSv2 in the Amazon EC2 User Guide. Network connectivity security model 152 AWS Telco Network Builder User Guide Monitoring AWS TNB Monitoring is an important part of maintaining the reliability, availability, and performance of AWS TNB and your other AWS solutions. AWS provides AWS CloudTrail to watch AWS TNB, report when something is wrong, and take automatic actions when appropriate. Use CloudTrail to capture detailed information about the calls made to AWS APIs. You can store these calls as log files in Amazon S3. You can use these CloudTrail logs to determine such information as which call was made, the source IP address where the call came from, who made the call, and when the call was made. The CloudTrail logs contain information about the calls to API actions for AWS TNB. They also contain information for calls to API actions from services such as Amazon EC2 and Amazon EBS. Logging AWS Telco Network Builder API calls using AWS CloudTrail AWS Telco Network Builder is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service. CloudTrail captures all API calls for AWS TNB as events. The calls captured include calls from the AWS TNB console and code calls to the AWS TNB API operations. Using the information collected by CloudTrail, you can determine the request that was made to AWS TNB,
|
tnb-guide-037
|
tnb-guide.pdf
| 37 |
They also contain information for calls to API actions from services such as Amazon EC2 and Amazon EBS. Logging AWS Telco Network Builder API calls using AWS CloudTrail AWS Telco Network Builder is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service. CloudTrail captures all API calls for AWS TNB as events. The calls captured include calls from the AWS TNB console and code calls to the AWS TNB API operations. Using the information collected by CloudTrail, you can determine the request that was made to AWS TNB, the IP address from which the request was made, when it was made, and additional details. Every event or log entry contains information about who generated the request. The identity information helps you determine the following: • Whether the request was made with root user or user credentials. • Whether the request was made on behalf of an IAM Identity Center user. • Whether the request was made with temporary security credentials for a role or federated user. • Whether the request was made by another AWS service. CloudTrail is active in your AWS account when you create the account and you automatically have access to the CloudTrail Event history. The CloudTrail Event history provides a viewable, searchable, downloadable, and immutable record of the past 90 days of recorded management CloudTrail logs 153 AWS Telco Network Builder User Guide events in an AWS Region. For more information, see Working with CloudTrail Event history in the AWS CloudTrail User Guide. There are no CloudTrail charges for viewing the Event history. For an ongoing record of events in your AWS account past 90 days, create a trail or a CloudTrail Lake event data store. CloudTrail trails A trail enables CloudTrail to deliver log files to an Amazon S3 bucket. All trails created using the AWS Management Console are multi-Region. You can create a single-Region or a multi-Region trail by using the AWS CLI. Creating a multi-Region trail is recommended because you capture activity in all AWS Regions in your account. If you create a single-Region trail, you can view only the events logged in the trail's AWS Region. For more information about trails, see Creating a trail for your AWS account and Creating a trail for an organization in the AWS CloudTrail User Guide. You can deliver one copy of your ongoing management events to your Amazon S3 bucket at no charge from CloudTrail by creating a trail, however, there are Amazon S3 storage charges. For more information about CloudTrail pricing, see AWS CloudTrail Pricing. For information about Amazon S3 pricing, see Amazon S3 Pricing. CloudTrail Lake event data stores CloudTrail Lake lets you run SQL-based queries on your events. CloudTrail Lake converts existing events in row-based JSON format to Apache ORC format. ORC is a columnar storage format that is optimized for fast retrieval of data. Events are aggregated into event data stores, which are immutable collections of events based on criteria that you select by applying advanced event selectors. The selectors that you apply to an event data store control which events persist and are available for you to query. For more information about CloudTrail Lake, see Working with AWS CloudTrail Lake in the AWS CloudTrail User Guide. CloudTrail Lake event data stores and queries incur costs. When you create an event data store, you choose the pricing option you want to use for the event data store. The pricing option determines the cost for ingesting and storing events, and the default and maximum retention period for the event data store. For more information about CloudTrail pricing, see AWS CloudTrail Pricing. CloudTrail logs 154 AWS Telco Network Builder User Guide AWS TNB event examples An event represents a single request from any source and includes information about the requested API operation, the date and time of the operation, request parameters, and so on. CloudTrail log files aren't an ordered stack trace of the public API calls, so events don't appear in any specific order. The following example shows a CloudTrail event that demonstrates the CreateSolFunctionPackage operation. { "eventVersion": "1.08", "userIdentity": { "type": "AssumedRole", "principalId": "AIDACKCEVSQ6C2EXAMPLE:example", "arn": "arn:aws:sts::111222333444:assumed-role/example/user", "accountId": "111222333444", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AIDACKCEVSQ6C2EXAMPLE", "arn": "arn:aws:iam::111222333444:role/example", "accountId": "111222333444", "userName": "example" }, "webIdFederationData": {}, "attributes": { "creationDate": "2023-02-02T01:42:39Z", "mfaAuthenticated": "false" } } }, "eventTime": "2023-02-02T01:43:17Z", "eventSource": "tnb.amazonaws.com", "eventName": "CreateSolFunctionPackage", "awsRegion": "us-east-1", "sourceIPAddress": "XXX.XXX.XXX.XXX", "userAgent": "userAgent", "requestParameters": null, "responseElements": { "vnfPkgArn": "arn:aws:tnb:us-east-1:111222333444:function-package/ fp-12345678abcEXAMPLE", AWS TNB event examples 155 AWS Telco Network Builder User Guide "id": "fp-12345678abcEXAMPLE", "operationalState": "DISABLED", "usageState": "NOT_IN_USE", "onboardingState": "CREATED" }, "requestID": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "eventID": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111222333444", "eventCategory": "Management" } For information about CloudTrail record contents, see CloudTrail record contents in the AWS CloudTrail User Guide. AWS TNB deployment
|
tnb-guide-038
|
tnb-guide.pdf
| 38 |
"AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AIDACKCEVSQ6C2EXAMPLE", "arn": "arn:aws:iam::111222333444:role/example", "accountId": "111222333444", "userName": "example" }, "webIdFederationData": {}, "attributes": { "creationDate": "2023-02-02T01:42:39Z", "mfaAuthenticated": "false" } } }, "eventTime": "2023-02-02T01:43:17Z", "eventSource": "tnb.amazonaws.com", "eventName": "CreateSolFunctionPackage", "awsRegion": "us-east-1", "sourceIPAddress": "XXX.XXX.XXX.XXX", "userAgent": "userAgent", "requestParameters": null, "responseElements": { "vnfPkgArn": "arn:aws:tnb:us-east-1:111222333444:function-package/ fp-12345678abcEXAMPLE", AWS TNB event examples 155 AWS Telco Network Builder User Guide "id": "fp-12345678abcEXAMPLE", "operationalState": "DISABLED", "usageState": "NOT_IN_USE", "onboardingState": "CREATED" }, "requestID": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "eventID": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111222333444", "eventCategory": "Management" } For information about CloudTrail record contents, see CloudTrail record contents in the AWS CloudTrail User Guide. AWS TNB deployment tasks Understand the deployment tasks to effectively monitor deployments and take action faster. The following table lists the AWS TNB deployment tasks: Task name for deployments started Task name for deployments started before March 7, on and after March 2024 7, 2024 AppInstallation ClusterPluginInstall Task description Installs the Multus plugin on the Amazon EKS cluster. AppUpdate no change in name Updates the network functions that are already installed in a network instance. - ClusterPluginUnins tall Uninstalls the plugins on the Amazon EKS cluster. ClusterStorageClas sConfiguration no change in name Configures the storage class (CSI driver) on an Amazon EKS cluster. Deployment tasks 156 AWS Telco Network Builder User Guide Task name for deployments started Task name for deployments started before March 7, on and after March 2024 7, 2024 FunctionDeletion no change in name Task description Deletes network functions from AWS TNB resources. FunctionInstantiation FunctionInstall Deploys network functions using HELM. FunctionUninstalla tion FunctionUninstall Uninstalls the network function from an Amazon EKS cluster. HookExecution no change in name Executes lifecycle hooks as defined in the NSD. InfrastructureCanc ellation InfrastructureInst antation InfrastructureTerm ination no change in name Cancels a network service. no change in name Provisions AWS resources on behalf of the user. no change in name Deprovisions AWS resources invoked through AWS TNB. - InfrastructureUpdate Updates the AWS resources provisioned on behalf of the user. InventoryDeregistr ation no change in name Deregisters AWS resources from AWS TNB. - InventoryRegistration Registers the AWS resources in AWS TNB. KubernetesClusterC onfiguration ClusterConfiguration Configures the Kubernetes cluster and adds additional IAM roles to the Amazon EKS AuthMap as defined in the NSD. NetworkServiceFina lization no change in name Finalizes the network service and provides a success or failure status update. Deployment tasks 157 AWS Telco Network Builder User Guide Task name for deployments started Task name for deployments started before March 7, on and after March 2024 7, 2024 Task description NetworkServiceInst antiation SelfManag edNodesConfigurati on - no change in name Initializes the network service. no change in name Bootstraps self-managed nodes with Amazon EKS and Kubernetes control plane. ValidateNetworkSer viceUpdate Runs the validations before updating a network instance. Deployment tasks 158 AWS Telco Network Builder User Guide Service quotas for AWS TNB Service quotas, also referred to as limits, are the maximum number of service resources or operations for your AWS account. For more information, see AWS service quotas in the Amazon Web Services General Reference. The following are the service quotas for AWS TNB. Name Default Description Adjustabl e Concurrent ongoing network service operations Each supported Region: 40 Yes The maximum number of concurrent ongoing network service operations in one Region. Function packages Network packages Network service instances Each supported Region: 200 Yes The maximum number of function packages in one region. Each supported Region: 40 Yes The maximum number of network packages in one region. Each supported Region: 800 Yes The maximum number of network service instances in one Region. 159 AWS Telco Network Builder User Guide Document history for the AWS TNB user guide The following table describes the documentation releases for AWS TNB. Change Description Date Root volume size Reference resources in scripts May 19, 2025 May 2, 2025 You can specify the size of the underlying Amazon EBS root volume of your Amazon EKS worker nodes through the root_volume_size field in the AWS.Compute.EKSMan agedNode and AWS.Compu te.EKSSelfManagedNode TOSCA nodes. You can reference resources created by AWS TNB to configure them in your Lifecycle Hook scripts and user data scripts. Kubernetes version 1.32 now supported for Amazon EKS AWS TNB supports Kubernete s version 1.32 for AWS.Compu April 24, 2025 nodes and managed node te.EKS and AWS.Compu groups. te.EKSManagedNode. Kubernetes version 1.24 is no longer supported for Amazon EKS nodes and managed node groups AL2023 AMI support for Amazon EKS managed nodes AWS TNB no longer supports Kubernetes version 1.24 for AWS.Compute.EKS and AWS.Compute.EKSMan agedNode. AWS TNB supports AL2023 AMI types for AWS.Compu te.EKSManagedNode. April 17, 2025 April 17, 2025 160 AWS Telco Network Builder User Guide Kubernetes version 1.23 is no longer supported for Amazon AWS TNB no longer supports Kubernetes version 1.23 April 4, 2025 EKS nodes and managed for AWS.Compute.EKS and node groups AWS.Compute.EKSMan AMI ID can
|
tnb-guide-039
|
tnb-guide.pdf
| 39 |
nodes and managed node te.EKS and AWS.Compu groups. te.EKSManagedNode. Kubernetes version 1.24 is no longer supported for Amazon EKS nodes and managed node groups AL2023 AMI support for Amazon EKS managed nodes AWS TNB no longer supports Kubernetes version 1.24 for AWS.Compute.EKS and AWS.Compute.EKSMan agedNode. AWS TNB supports AL2023 AMI types for AWS.Compu te.EKSManagedNode. April 17, 2025 April 17, 2025 160 AWS Telco Network Builder User Guide Kubernetes version 1.23 is no longer supported for Amazon AWS TNB no longer supports Kubernetes version 1.23 April 4, 2025 EKS nodes and managed for AWS.Compute.EKS and node groups AWS.Compute.EKSMan AMI ID can be updated agedNode. You can now update the ami_id field during an UpdateSolNetworkSe rvice API call. March 31, 2025 Kubernetes version 1.31 now supported for Amazon EKS AWS TNB supports Kubernete s version 1.31 for AWS.Compu February 18, 2025 nodes and managed node groups. te.EKS and AWS.Compu te.EKSManagedNode. Kubernetes version for AWS.Compute.EKSMan AWS TNB supports Kubernete s versions 1.23 through 1.30 January 28, 2025 agedNode Kubernetes version for cluster to create an Amazon EKS managed node group. AWS TNB now supports Kubernetes version 1.30 to create Amazon EKS clusters. August 19, 2024 161 AWS Telco Network Builder User Guide AWS TNB supports an additional operation to You can update an instantia ted or previously updated July 30, 2024 manage the network lifecycle. network instance with a new network package and parameter values. See: • Lifecycle operations • Update a network instance • AWS TNB service role example: • Add these Amazon EKS actions: eks:Updat eAddon , eks:Updat eClusterVersion , eks:UpdateNodegrou pConfig , eks:Updat eNodegroupVersion , eks:DescribeUpdate • Add this AWS CloudForm ation action: cloudform ation:UpdateStack • New Deployment tasks: InfrastructureUpda te , Inventory Registration , ValidateNetworkSer viceUpdate • API updates: GetSolNet workOperation, ListSolNe tworkOperations , and UpdateSolNetworkInstance 162 AWS Telco Network Builder User Guide New task and new task names for existing tasks A new task is available. As of March 7, 2024, some existing May 7, 2024 Kubernetes version for cluster Support for network interface security_groups tasks have new names for clarity. AWS TNB now supports Kubernetes version 1.29 to create Amazon EKS clusters. You can attach security groups to the AWS.Netwo rking.ENI node. April 10, 2024 April 2, 2024 Support for Amazon EBS root volume encryption You can enable Amazon EBS encryption for the Amazon April 2, 2024 EBS root volume. To enable, add the properties in the AWS.Compute.EKSMan agedNode or AWS.Compu te.EKSSelfManagedNode node. You can attach node labels to your node group in the AWS.Compute.EKSMan agedNode or AWS.Compu te.EKSSelfManagedNode node. You can indicate whether you want to enable or disable the network interface source/de stination check through the AWS.Networking.ENI node. March 19, 2024 January 25, 2024 Support for node labels Support for network interface source_dest_check 163 AWS Telco Network Builder User Guide Support for Amazon EC2 instances with custom user You can launch Amazon EC2 instances with custom user January 16, 2024 data data through the AWS.Compu te.UserData node. Support for Security Group Updated description of network_interfaces Support for private cluster Kubernetes version for cluster AWS TNB supports placement group AWS TNB allows you to import the Security Group AWS resource. When the network_i nterfaces property is included in the AWS.Compu te.EKSManagedNode or AWS.Compute.EKSSel fManagedNode node, AWS TNB gets the permission related to ENIs from the multus_role property if available, or from the node_role property. AWS TNB now supports private clusters. To indicate a private cluster, set the access property to PRIVATE. AWS TNB now supports Kubernetes version 1.28 to create Amazon EKS clusters. January 8, 2024 December 18, 2023 December 11, 2023 December 11, 2023 Added placement group for December 11, 2023 the AWS.Compute.EKSMan agedNode and AWS.Compu te.EKSSelfManagedN ode node definitions. 164 AWS Telco Network Builder User Guide AWS TNB adds support for IPv6 AWS TNB now supports creating network instances November 16, 2023 with IPv6 infrastructure. Check the nodes AWS.Netwo rking.VPC, AWS.Netwo rking.Subnet, AWS.Netwo rking.InternetGateway, AWS.Networking.Sec urityGroupIngressRule, AWS.Networking.Sec urityGroupEgressRule, and AWS.Compute.EKS for IPv6 configurations. We also added the nodes AWS.Netwo rking.NATGateway and AWS.Networking.Route for NAT64 configuration. We updated the AWS TNB service role and the AWS TNB service role for Amazon EKS node group for IPv6 permissio ns. See Service role policy examples. Added permissions to the AWS TNB service role policy We added permissions to the AWS TNB service role policy October 23, 2023 AWS TNB launched in more Regions for Amazon S3 and AWS CloudFormation to enable infrastructure instantiation. AWS TNB is now available in the Asia Pacific (Seoul), Canada (Central), Europe (Spain), Europe (Stockhol m), and South America (São Paulo) Regions. September 27, 2023 165 AWS Telco Network Builder User Guide Tags for AWS.Compu te.EKSSelfManagedNode AWS TNB now supports August 22, 2023 tags for the AWS.Compu te.EKSSelfManagedN ode node definition. AWS TNB supports instances that leverage IMDSv2 When launching your instance, you
|
tnb-guide-040
|
tnb-guide.pdf
| 40 |
to the AWS TNB service role policy We added permissions to the AWS TNB service role policy October 23, 2023 AWS TNB launched in more Regions for Amazon S3 and AWS CloudFormation to enable infrastructure instantiation. AWS TNB is now available in the Asia Pacific (Seoul), Canada (Central), Europe (Spain), Europe (Stockhol m), and South America (São Paulo) Regions. September 27, 2023 165 AWS Telco Network Builder User Guide Tags for AWS.Compu te.EKSSelfManagedNode AWS TNB now supports August 22, 2023 tags for the AWS.Compu te.EKSSelfManagedN ode node definition. AWS TNB supports instances that leverage IMDSv2 When launching your instance, you must use August 14, 2023 Updated permissions for the MultusRoleInlinePolicy Kubernetes version for cluster AWS.Compute.EKS.AuthRole IMDSv2. The MultusRoleInlinePolicy August 7, 2023 now includes the ec2:Delet eNetworkInterface permission. AWS TNB now supports Kubernetes versions 1.27 to create Amazon EKS clusters. AWS TNB supports AuthRole that allows you to add IAM roles to the Amazon EKS cluster aws-auth ConfigMap so that users can access the Amazon EKS cluster using an IAM role. July 25, 2023 July 19, 2023 AWS TNB supports security groups. Added the AWS.Netwo rking.SecurityGroup, July 18, 2023 AWS.Networking.Sec urityGroupEgressRule, and AWS.Networking.Sec urityGroupIngressRule to the NSD template. 166 AWS Telco Network Builder User Guide Kubernetes version for cluster AWS.Compute.EKSSel fManagedNode AWS TNB supports Kubernete s versions 1.22 through 1.26 to create Amazon EKS clusters. AWS TNB no longer supports Kubernetes versions 1.21. You can create self-managed worker nodes on in-region, AWS Local Zones, and AWS Outposts. May 11, 2023 March 29, 2023 Initial release This is the first release of the AWS TNB User Guide. February 21, 2023 167
|
transcribe-api-001
|
transcribe-api.pdf
| 1 |
API Reference Amazon Transcribe API Version 2017-10-26 Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon Transcribe API Reference Amazon Transcribe: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon Transcribe Table of Contents API Reference Welcome ........................................................................................................................................... 1 Amazon Transcribe Service ......................................................................................................................... 2 Amazon Transcribe Streaming Service ..................................................................................................... 2 Actions .............................................................................................................................................. 4 Amazon Transcribe Service ......................................................................................................................... 5 CreateCallAnalyticsCategory ................................................................................................................. 8 CreateLanguageModel ......................................................................................................................... 13 CreateMedicalVocabulary .................................................................................................................... 19 CreateVocabulary .................................................................................................................................. 25 CreateVocabularyFilter ......................................................................................................................... 32 DeleteCallAnalyticsCategory ............................................................................................................... 38 DeleteCallAnalyticsJob ......................................................................................................................... 41 DeleteLanguageModel ......................................................................................................................... 43 DeleteMedicalScribeJob ....................................................................................................................... 45 DeleteMedicalTranscriptionJob .......................................................................................................... 47 DeleteMedicalVocabulary .................................................................................................................... 49 DeleteTranscriptionJob ........................................................................................................................ 52 DeleteVocabulary .................................................................................................................................. 54 DeleteVocabularyFilter ......................................................................................................................... 57 DescribeLanguageModel ...................................................................................................................... 60 GetCallAnalyticsCategory .................................................................................................................... 64 GetCallAnalyticsJob .............................................................................................................................. 67 GetMedicalScribeJob ............................................................................................................................ 72 GetMedicalTranscriptionJob ................................................................................................................ 76 GetMedicalVocabulary .......................................................................................................................... 80 GetTranscriptionJob .............................................................................................................................. 84 GetVocabulary ....................................................................................................................................... 89 GetVocabularyFilter .............................................................................................................................. 93 ListCallAnalyticsCategories ................................................................................................................. 97 ListCallAnalyticsJobs .......................................................................................................................... 101 ListLanguageModels ........................................................................................................................... 106 ListMedicalScribeJobs ........................................................................................................................ 110 ListMedicalTranscriptionJobs ............................................................................................................ 114 ListMedicalVocabularies ..................................................................................................................... 119 API Version 2017-10-26 iii Amazon Transcribe API Reference ListTagsForResource ........................................................................................................................... 123 ListTranscriptionJobs .......................................................................................................................... 127 ListVocabularies .................................................................................................................................. 132 ListVocabularyFilters .......................................................................................................................... 136 StartCallAnalyticsJob ......................................................................................................................... 140 StartMedicalScribeJob ....................................................................................................................... 149 StartMedicalTranscriptionJob ........................................................................................................... 158 StartTranscriptionJob ......................................................................................................................... 169 TagResource ......................................................................................................................................... 185 UntagResource .................................................................................................................................... 188 UpdateCallAnalyticsCategory ........................................................................................................... 191 UpdateMedicalVocabulary ................................................................................................................ 195 UpdateVocabulary .............................................................................................................................. 200 UpdateVocabularyFilter ..................................................................................................................... 206 Amazon Transcribe Streaming Service ................................................................................................ 210 GetMedicalScribeStream ................................................................................................................... 211 StartCallAnalyticsStreamTranscription ........................................................................................... 215 StartMedicalScribeStream ................................................................................................................. 228 StartMedicalStreamTranscription .................................................................................................... 236 StartStreamTranscription .................................................................................................................. 247 Data Types ................................................................................................................................... 265 Amazon Transcribe Service .................................................................................................................... 268 AbsoluteTimeRange ........................................................................................................................... 270 CallAnalyticsJob .................................................................................................................................. 272 CallAnalyticsJobDetails ...................................................................................................................... 278 CallAnalyticsJobSettings ................................................................................................................... 279 CallAnalyticsJobSummary ................................................................................................................. 284 CallAnalyticsSkippedFeature ............................................................................................................ 287 CategoryProperties ............................................................................................................................. 289 ChannelDefinition ............................................................................................................................... 291 ClinicalNoteGenerationSettings ....................................................................................................... 292 ContentRedaction ............................................................................................................................... 293 InputDataConfig .................................................................................................................................. 295 InterruptionFilter ................................................................................................................................ 297 JobExecutionSettings ......................................................................................................................... 299 LanguageCodeItem ............................................................................................................................. 301 API Version 2017-10-26 iv Amazon Transcribe API Reference LanguageIdSettings ............................................................................................................................ 303 LanguageModel ................................................................................................................................... 306 Media ..................................................................................................................................................... 310 MedicalScribeChannelDefinition ...................................................................................................... 312 MedicalScribeJob ................................................................................................................................ 313 MedicalScribeJobSummary ............................................................................................................... 318 MedicalScribeOutput .......................................................................................................................... 321 MedicalScribeSettings ........................................................................................................................ 323 MedicalTranscript ................................................................................................................................ 326 MedicalTranscriptionJob .................................................................................................................... 327 MedicalTranscriptionJobSummary .................................................................................................. 333 MedicalTranscriptionSetting ............................................................................................................. 337 ModelSettings ...................................................................................................................................... 340 NonTalkTimeFilter .............................................................................................................................. 341 RelativeTimeRange ............................................................................................................................. 343 Rule ........................................................................................................................................................ 345 SentimentFilter .................................................................................................................................... 347 Settings ................................................................................................................................................. 349 Subtitles ................................................................................................................................................ 353 SubtitlesOutput ................................................................................................................................... 355 Summarization .................................................................................................................................... 357 Tag ......................................................................................................................................................... 358 ToxicityDetectionSettings ................................................................................................................. 360 Transcript .............................................................................................................................................. 361 TranscriptFilter .................................................................................................................................... 363 TranscriptionJob .................................................................................................................................. 366 TranscriptionJobSummary ................................................................................................................ 374 VocabularyFilterInfo ........................................................................................................................... 379 VocabularyInfo .................................................................................................................................... 381 Amazon Transcribe Streaming Service ................................................................................................ 382 Alternative ............................................................................................................................................ 385 AudioEvent ........................................................................................................................................... 386 AudioStream ........................................................................................................................................ 387 CallAnalyticsEntity .............................................................................................................................. 388 CallAnalyticsItem ................................................................................................................................ 390 CallAnalyticsTranscriptResultStream .............................................................................................. 392 API Version 2017-10-26 v Amazon Transcribe API Reference CategoryEvent ..................................................................................................................................... 395 ChannelDefinition ............................................................................................................................... 396 CharacterOffsets ................................................................................................................................. 397 ClinicalNoteGenerationResult ........................................................................................................... 398 ClinicalNoteGenerationSettings ....................................................................................................... 400 ConfigurationEvent ............................................................................................................................. 402 Entity ..................................................................................................................................................... 403 IssueDetected ...................................................................................................................................... 405 Item ....................................................................................................................................................... 406 LanguageWithScore ............................................................................................................................ 408 MedicalAlternative .............................................................................................................................. 410 MedicalEntity ....................................................................................................................................... 411 MedicalItem .......................................................................................................................................... 413 MedicalResult ....................................................................................................................................... 415 MedicalScribeAudioEvent .................................................................................................................. 417 MedicalScribeChannelDefinition ...................................................................................................... 418 MedicalScribeConfigurationEvent ................................................................................................... 420 MedicalScribeEncryptionSettings .................................................................................................... 423 MedicalScribeInputStream ................................................................................................................ 425 MedicalScribePostStreamAnalyticsResult ...................................................................................... 427 MedicalScribePostStreamAnalyticsSettings .................................................................................. 428 MedicalScribeResultStream .............................................................................................................. 429 MedicalScribeSessionControlEvent ................................................................................................. 431 MedicalScribeStreamDetails ............................................................................................................. 432 MedicalScribeTranscriptEvent .......................................................................................................... 437 MedicalScribeTranscriptItem ............................................................................................................ 438 MedicalScribeTranscriptSegment .................................................................................................... 440 MedicalTranscript ................................................................................................................................ 442 MedicalTranscriptEvent ...................................................................................................................... 443 MedicalTranscriptResultStream ........................................................................................................ 444 PointsOfInterest .................................................................................................................................. 446 PostCallAnalyticsSettings .................................................................................................................. 447 Result ..................................................................................................................................................... 450 TimestampRange ................................................................................................................................ 453 Transcript .............................................................................................................................................. 454 TranscriptEvent .................................................................................................................................... 455 API Version 2017-10-26 vi Amazon Transcribe API Reference TranscriptResultStream ...................................................................................................................... 456 UtteranceEvent .................................................................................................................................... 458 Common Parameters ................................................................................................................... 461 Common Errors ............................................................................................................................ 464 API Version 2017-10-26 vii Amazon Transcribe Welcome API Reference This guide provides detailed information on the Amazon Transcribe API, including operations, request and response syntax, data types, and error codes. For more information about Amazon Transcribe, refer to the Amazon Transcribe Developer Guide. The Amazon Transcribe API reference is separated into the following sections: • Actions • Data Types • Common Errors • Common Parameters If you're transcribing a media file located in an Amazon S3 bucket, you're performing a batch transcription and must use the operations and data types listed in the Amazon Transcribe Service section. If you're transcribing a real-time media stream, you're performing a streaming transcription and must use the operations and data types listed in the Amazon Transcribe Streaming Service section. Amazon Transcribe supports the following SDKs: Batch transcriptions Streaming transcriptions AWS Command Line Interface (CLI) The CLI is not supported for streaming. C++ Go Java V2 JavaScript PHP V3 C++ Go Java V2 JavaScript V3 PHP V3 Python Boto3 Python Streaming SDK for Amazon Transcribe API Version 2017-10-26 1 Amazon Transcribe API Reference Batch transcriptions Streaming transcriptions Ruby V3 .NET Ruby V3 .NET is not supported for streaming. All operations and
|
transcribe-api-002
|
transcribe-api.pdf
| 2 |
section. If you're transcribing a real-time media stream, you're performing a streaming transcription and must use the operations and data types listed in the Amazon Transcribe Streaming Service section. Amazon Transcribe supports the following SDKs: Batch transcriptions Streaming transcriptions AWS Command Line Interface (CLI) The CLI is not supported for streaming. C++ Go Java V2 JavaScript PHP V3 C++ Go Java V2 JavaScript V3 PHP V3 Python Boto3 Python Streaming SDK for Amazon Transcribe API Version 2017-10-26 1 Amazon Transcribe API Reference Batch transcriptions Streaming transcriptions Ruby V3 .NET Ruby V3 .NET is not supported for streaming. All operations and actions listed in this guide function equally across all supported SDKs. Amazon Transcribe Service Amazon Transcribe offers three main types of batch transcription: Standard, Medical, and Call Analytics. • Standard transcriptions are the most common option. Refer to StartTranscriptionJob for details. • Medical transcriptions are tailored to medical professionals and incorporate medical terms. A common use case for this service is transcribing doctor-patient dialogue into after-visit notes. Refer to StartMedicalTranscriptionJob for details. • Call Analytics transcriptions are designed for use with call center audio on two different channels; if you're looking for insight into customer service calls, use this option. Refer to StartCallAnalyticsJob for details. Amazon Transcribe Streaming Service Amazon Transcribe streaming offers four main types of real-time transcription: Standard, Medical, Call Analytics, and Health Scribe. • Standard transcriptions are the most common option. Refer to StartStreamTranscription for details. • Medical transcriptions are tailored to medical professionals and incorporate medical terms. A common use case for this service is transcribing doctor-patient dialogue in real time, so doctors can focus on their patient instead of taking notes. Refer to StartMedicalStreamTranscription for details. • Call Analytics transcriptions are designed for use with call center audio on two different channels; if you're looking for insight into customer service calls, use this option. Refer to StartCallAnalyticsStreamTranscription for details. Amazon Transcribe Service API Version 2017-10-26 2 Amazon Transcribe API Reference • HealthScribe transcriptions are designed to automatically create clinical notes from patient- clinician conversations using generative AI. Refer to [here] for details. Amazon Transcribe Streaming Service API Version 2017-10-26 3 Amazon Transcribe Actions The following actions are supported by Amazon Transcribe Service: API Reference • CreateCallAnalyticsCategory • CreateLanguageModel • CreateMedicalVocabulary • CreateVocabulary • CreateVocabularyFilter • DeleteCallAnalyticsCategory • DeleteCallAnalyticsJob • DeleteLanguageModel • DeleteMedicalScribeJob • DeleteMedicalTranscriptionJob • DeleteMedicalVocabulary • DeleteTranscriptionJob • DeleteVocabulary • DeleteVocabularyFilter • DescribeLanguageModel • GetCallAnalyticsCategory • GetCallAnalyticsJob • GetMedicalScribeJob • GetMedicalTranscriptionJob • GetMedicalVocabulary • GetTranscriptionJob • GetVocabulary • GetVocabularyFilter • ListCallAnalyticsCategories • ListCallAnalyticsJobs • ListLanguageModels • ListMedicalScribeJobs API Version 2017-10-26 4 API Reference Amazon Transcribe • ListMedicalTranscriptionJobs • ListMedicalVocabularies • ListTagsForResource • ListTranscriptionJobs • ListVocabularies • ListVocabularyFilters • StartCallAnalyticsJob • StartMedicalScribeJob • StartMedicalTranscriptionJob • StartTranscriptionJob • TagResource • UntagResource • UpdateCallAnalyticsCategory • UpdateMedicalVocabulary • UpdateVocabulary • UpdateVocabularyFilter The following actions are supported by Amazon Transcribe Streaming Service: • GetMedicalScribeStream • StartCallAnalyticsStreamTranscription • StartMedicalScribeStream • StartMedicalStreamTranscription • StartStreamTranscription Amazon Transcribe Service The following actions are supported by Amazon Transcribe Service: • CreateCallAnalyticsCategory • CreateLanguageModel • CreateMedicalVocabulary Amazon Transcribe Service API Version 2017-10-26 5 API Reference Amazon Transcribe • CreateVocabulary • CreateVocabularyFilter • DeleteCallAnalyticsCategory • DeleteCallAnalyticsJob • DeleteLanguageModel • DeleteMedicalScribeJob • DeleteMedicalTranscriptionJob • DeleteMedicalVocabulary • DeleteTranscriptionJob • DeleteVocabulary • DeleteVocabularyFilter • DescribeLanguageModel • GetCallAnalyticsCategory • GetCallAnalyticsJob • GetMedicalScribeJob • GetMedicalTranscriptionJob • GetMedicalVocabulary • GetTranscriptionJob • GetVocabulary • GetVocabularyFilter • ListCallAnalyticsCategories • ListCallAnalyticsJobs • ListLanguageModels • ListMedicalScribeJobs • ListMedicalTranscriptionJobs • ListMedicalVocabularies • ListTagsForResource • ListTranscriptionJobs • ListVocabularies • ListVocabularyFilters Amazon Transcribe Service API Version 2017-10-26 6 API Reference Amazon Transcribe • StartCallAnalyticsJob • StartMedicalScribeJob • StartMedicalTranscriptionJob • StartTranscriptionJob • TagResource • UntagResource • UpdateCallAnalyticsCategory • UpdateMedicalVocabulary • UpdateVocabulary • UpdateVocabularyFilter Amazon Transcribe Service API Version 2017-10-26 7 Amazon Transcribe API Reference CreateCallAnalyticsCategory Service: Amazon Transcribe Service Creates a new Call Analytics category. All categories are automatically applied to your Call Analytics transcriptions. Note that in order to apply categories to your transcriptions, you must create them before submitting your transcription request, as categories cannot be applied retroactively. When creating a new category, you can use the InputType parameter to label the category as a POST_CALL or a REAL_TIME category. POST_CALL categories can only be applied to post-call transcriptions and REAL_TIME categories can only be applied to real-time transcriptions. If you do not include InputType, your category is created as a POST_CALL category by default. Call Analytics categories are composed of rules. For each category, you must create between 1 and 20 rules. Rules can include these parameters: InterruptionFilter, NonTalkTimeFilter, SentimentFilter, and TranscriptFilter. To update an existing category, see UpdateCallAnalyticsCategory. To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions. Request Syntax { "CategoryName": "string", "InputType": "string", "Rules": [ { ... } ], "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the
|
transcribe-api-003
|
transcribe-api.pdf
| 3 |
transcriptions. If you do not include InputType, your category is created as a POST_CALL category by default. Call Analytics categories are composed of rules. For each category, you must create between 1 and 20 rules. Rules can include these parameters: InterruptionFilter, NonTalkTimeFilter, SentimentFilter, and TranscriptFilter. To update an existing category, see UpdateCallAnalyticsCategory. To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions. Request Syntax { "CategoryName": "string", "InputType": "string", "Rules": [ { ... } ], "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. CreateCallAnalyticsCategory API Version 2017-10-26 8 Amazon Transcribe API Reference The request accepts the following data in JSON format. CategoryName A unique name, chosen by you, for your Call Analytics category. It's helpful to use a detailed naming system that will make sense to you in the future. For example, it's better to use sentiment-positive-last30seconds for a category over a generic name like test- category. Category names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes InputType Choose whether you want to create a real-time or a post-call category for your Call Analytics transcription. Specifying POST_CALL assigns your category to post-call transcriptions; categories with this input type cannot be applied to streaming (real-time) transcriptions. Specifying REAL_TIME assigns your category to streaming transcriptions; categories with this input type cannot be applied to post-call transcriptions. If you do not include InputType, your category is created as a post-call category by default. Type: String Valid Values: REAL_TIME | POST_CALL Required: No Rules Rules define a Call Analytics category. When creating a new category, you must create between 1 and 20 rules for that category. For each rule, you specify a filter you want applied to the attributes of a call. For example, you can choose a sentiment filter that detects if a customer's sentiment was positive during the last 30 seconds of the call. CreateCallAnalyticsCategory API Version 2017-10-26 9 Amazon Transcribe Type: Array of Rule objects API Reference Array Members: Minimum number of 1 item. Maximum number of 20 items. Required: Yes Tags Adds one or more custom tags, each in the form of a key:value pair, to a new call analytics category at the time you start this new job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: No Response Syntax { "CategoryProperties": { "CategoryName": "string", "CreateTime": number, "InputType": "string", "LastUpdateTime": number, "Rules": [ { ... } ], "Tags": [ { "Key": "string", "Value": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CreateCallAnalyticsCategory API Version 2017-10-26 10 Amazon Transcribe CategoryProperties API Reference Provides you with the properties of your new category, including its associated rules. Type: CategoryProperties object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 ConflictException A resource already exists with this name. Resource names must be unique within an AWS account. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: CreateCallAnalyticsCategory API Version 2017-10-26 11 API Reference Amazon Transcribe • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateCallAnalyticsCategory API Version 2017-10-26 12 Amazon Transcribe API Reference CreateLanguageModel Service: Amazon Transcribe Service Creates a new custom language model. When creating a new custom language model, you must specify: • If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model • The location of your training and tuning files (this must be an Amazon S3 URI) • The
|
transcribe-api-004
|
transcribe-api.pdf
| 4 |
Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateCallAnalyticsCategory API Version 2017-10-26 12 Amazon Transcribe API Reference CreateLanguageModel Service: Amazon Transcribe Service Creates a new custom language model. When creating a new custom language model, you must specify: • If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model • The location of your training and tuning files (this must be an Amazon S3 URI) • The language of your model • A unique name for your model For more information, see Custom language models. Request Syntax { "BaseModelName": "string", "InputDataConfig": { "DataAccessRoleArn": "string", "S3Uri": "string", "TuningDataS3Uri": "string" }, "LanguageCode": "string", "ModelName": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CreateLanguageModel API Version 2017-10-26 13 Amazon Transcribe BaseModelName API Reference The Amazon Transcribe standard language model, or base model, used to create your custom language model. Amazon Transcribe offers two options for base models: Wideband and Narrowband. If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose WideBand. To transcribe audio with a sample rate less than 16,000 Hz, choose NarrowBand. Type: String Valid Values: NarrowBand | WideBand Required: Yes InputDataConfig Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and permissions to access this location. When using InputDataConfig, you must include these sub-parameters: S3Uri, which is the Amazon S3 location of your training data, and DataAccessRoleArn, which is the Amazon Resource Name (ARN) of the role that has permission to access your specified Amazon S3 location. You can optionally include TuningDataS3Uri, which is the Amazon S3 location of your tuning data. If you specify different Amazon S3 locations for training and tuning data, the ARN you use must have permissions to access both locations. Type: InputDataConfig object Required: Yes LanguageCode The language code that represents the language of your model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data. For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that US English (en-US) is the only language supported with Amazon Transcribe Medical. A custom language model can only be used to transcribe files in the same language as the model. For example, if you create a custom language model using US English (en-US), you can only apply this model to files that contain English audio. CreateLanguageModel API Version 2017-10-26 14 Amazon Transcribe Type: String API Reference Valid Values: en-US | hi-IN | es-US | en-GB | en-AU | de-DE | ja-JP Required: Yes ModelName A unique name, chosen by you, for your custom language model. This name is case sensitive, cannot contain spaces, and must be unique within an AWS account. If you try to create a new custom language model with the same name as an existing custom language model, you get a ConflictException error. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Tags Adds one or more custom tags, each in the form of a key:value pair, to a new custom language model at the time you create this new model. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: No Response Syntax { "BaseModelName": "string", "InputDataConfig": { "DataAccessRoleArn": "string", "S3Uri": "string", CreateLanguageModel API Version 2017-10-26 15 Amazon Transcribe API Reference "TuningDataS3Uri": "string" }, "LanguageCode": "string", "ModelName": "string", "ModelStatus": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. BaseModelName The Amazon Transcribe standard language model, or base model, you specified when creating your custom language model. Type: String Valid Values: NarrowBand | WideBand InputDataConfig Lists your data access role ARN (Amazon Resource Name) and the Amazon S3 locations you provided for your training (S3Uri) and tuning (TuningDataS3Uri) data. Type: InputDataConfig object LanguageCode The language code you selected for your custom language model. Type: String Valid Values: en-US | hi-IN | es-US | en-GB | en-AU | de-DE | ja-JP ModelName The name of your custom language model. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. CreateLanguageModel API Version 2017-10-26 16 Amazon Transcribe API Reference Pattern:
|
transcribe-api-005
|
transcribe-api.pdf
| 5 |
specified when creating your custom language model. Type: String Valid Values: NarrowBand | WideBand InputDataConfig Lists your data access role ARN (Amazon Resource Name) and the Amazon S3 locations you provided for your training (S3Uri) and tuning (TuningDataS3Uri) data. Type: InputDataConfig object LanguageCode The language code you selected for your custom language model. Type: String Valid Values: en-US | hi-IN | es-US | en-GB | en-AU | de-DE | ja-JP ModelName The name of your custom language model. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. CreateLanguageModel API Version 2017-10-26 16 Amazon Transcribe API Reference Pattern: ^[0-9a-zA-Z._-]+ ModelStatus The status of your custom language model. When the status displays as COMPLETED, your model is ready to use. Type: String Valid Values: IN_PROGRESS | FAILED | COMPLETED Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 ConflictException A resource already exists with this name. Resource names must be unique within an AWS account. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 CreateLanguageModel API Version 2017-10-26 17 Amazon Transcribe See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateLanguageModel API Version 2017-10-26 18 Amazon Transcribe API Reference CreateMedicalVocabulary Service: Amazon Transcribe Service Creates a new custom medical vocabulary. Before creating a new custom medical vocabulary, you must first upload a text file that contains your vocabulary table into an Amazon S3 bucket. Note that this differs from CreateVocabulary, where you can include a list of terms within your request using the Phrases flag; CreateMedicalVocabulary does not support the Phrases flag and only accepts vocabularies in table format. Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language. For more information, see Custom vocabularies. Request Syntax { "LanguageCode": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VocabularyFileUri": "string", "VocabularyName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. LanguageCode The language code that represents the language of the entries in your custom vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical. CreateMedicalVocabulary API Version 2017-10-26 19 Amazon Transcribe Type: String API Reference Valid Values: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ | vi-VN | sv-SE | ab-GE | ast-ES | az-AZ | ba-RU | be- BY | bg-BG | bn-IN | bs-BA | ca-ES | ckb-IQ | ckb-IR | cs-CZ | cy-WL | el-GR | et-ET | eu-ES | fi-FI | gl-ES | gu-IN | ha-NG | hr-HR | hu-HU | hy-AM | is-IS | ka-GE | kab-DZ | kk-KZ | kn-IN | ky-KG | lg-IN | lt-LT | lv-LV | mhr-RU | mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | so-SO | sr-RS | su-ID | sw-BI | sw-KE | sw-RW | sw-TZ | sw-UG | tl-PH | tt-RU | ug-CN | uk-UA | uz-UZ | wo-SN | zu-ZA Required: Yes Tags Adds one or more custom tags, each in the form of a key:value pair, to a new custom medical vocabulary at the time you create this new custom vocabulary. To learn more about
|
transcribe-api-006
|
transcribe-api.pdf
| 6 |
| mhr-RU | mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | so-SO | sr-RS | su-ID | sw-BI | sw-KE | sw-RW | sw-TZ | sw-UG | tl-PH | tt-RU | ug-CN | uk-UA | uz-UZ | wo-SN | zu-ZA Required: Yes Tags Adds one or more custom tags, each in the form of a key:value pair, to a new custom medical vocabulary at the time you create this new custom vocabulary. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: No VocabularyFileUri The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary. The URI must be in the same AWS Region as the resource you're calling. Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://|http(s*)://).+ Required: Yes CreateMedicalVocabulary API Version 2017-10-26 20 Amazon Transcribe VocabularyName API Reference A unique name, chosen by you, for your new custom medical vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an AWS account. If you try to create a new custom medical vocabulary with the same name as an existing custom medical vocabulary, you get a ConflictException error. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Syntax { "FailureReason": "string", "LanguageCode": "string", "LastModifiedTime": number, "VocabularyName": "string", "VocabularyState": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. FailureReason If VocabularyState is FAILED, FailureReason contains information about why the medical transcription job request failed. See also: Common Errors. Type: String LanguageCode The language code you selected for your custom medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical. CreateMedicalVocabulary API Version 2017-10-26 21 Amazon Transcribe Type: String API Reference Valid Values: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ | vi-VN | sv-SE | ab-GE | ast-ES | az-AZ | ba-RU | be- BY | bg-BG | bn-IN | bs-BA | ca-ES | ckb-IQ | ckb-IR | cs-CZ | cy-WL | el-GR | et-ET | eu-ES | fi-FI | gl-ES | gu-IN | ha-NG | hr-HR | hu-HU | hy-AM | is-IS | ka-GE | kab-DZ | kk-KZ | kn-IN | ky-KG | lg-IN | lt-LT | lv-LV | mhr-RU | mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | so-SO | sr-RS | su-ID | sw-BI | sw-KE | sw-RW | sw-TZ | sw-UG | tl-PH | tt-RU | ug-CN | uk-UA | uz-UZ | wo-SN | zu-ZA LastModifiedTime The date and time you created your custom medical vocabulary. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp VocabularyName The name you chose for your custom medical vocabulary. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ VocabularyState The processing state of your custom medical vocabulary. If the state is READY, you can use the custom vocabulary in a StartMedicalTranscriptionJob request. Type: String Valid Values: PENDING | READY | FAILED CreateMedicalVocabulary API Version 2017-10-26 22 Amazon Transcribe Errors API Reference For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 ConflictException A resource already exists with this name. Resource names must be unique within an AWS account. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 See Also For more information
|
transcribe-api-007
|
transcribe-api.pdf
| 7 |
a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 ConflictException A resource already exists with this name. Resource names must be unique within an AWS account. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 CreateMedicalVocabulary API Version 2017-10-26 23 Amazon Transcribe • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference CreateMedicalVocabulary API Version 2017-10-26 24 Amazon Transcribe API Reference CreateVocabulary Service: Amazon Transcribe Service Creates a new custom vocabulary. When creating a new custom vocabulary, you can either upload a text file that contains your new entries, phrases, and terms into an Amazon S3 bucket and include the URI in your request. Or you can include a list of terms directly in your request using the Phrases flag. Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language. For more information, see Custom vocabularies. Request Syntax { "DataAccessRoleArn": "string", "LanguageCode": "string", "Phrases": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VocabularyFileUri": "string", "VocabularyName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DataAccessRoleArn The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary). If the role that you CreateVocabulary API Version 2017-10-26 25 Amazon Transcribe API Reference specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails. IAM role ARNs have the format arn:partition:iam::account:role/role-name-with- path. For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9] {0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$ Required: No LanguageCode The language code that represents the language of the entries in your custom vocabulary. Each custom vocabulary must contain terms in only one language. A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to files that contain English audio. For a list of supported languages and their associated language codes, refer to the Supported languages table. Type: String Valid Values: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ | vi-VN | sv-SE | ab-GE | ast-ES | az-AZ | ba-RU | be- BY | bg-BG | bn-IN | bs-BA | ca-ES | ckb-IQ | ckb-IR | cs-CZ | cy-WL | el-GR | et-ET | eu-ES | fi-FI | gl-ES | gu-IN | ha-NG | hr-HR | hu-HU | hy-AM | is-IS | ka-GE | kab-DZ | kk-KZ | kn-IN | ky-KG | lg-IN | lt-LT | lv-LV | mhr-RU | mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | CreateVocabulary API Version 2017-10-26 26 Amazon Transcribe API Reference so-SO | sr-RS | su-ID | sw-BI | sw-KE | sw-RW | sw-TZ | sw-UG | tl-PH | tt-RU | ug-CN | uk-UA | uz-UZ | wo-SN | zu-ZA Required: Yes Phrases Use this parameter if you want to create your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for creating your custom vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri
|
transcribe-api-008
|
transcribe-api.pdf
| 8 |
sl-SI | CreateVocabulary API Version 2017-10-26 26 Amazon Transcribe API Reference so-SO | sr-RS | su-ID | sw-BI | sw-KE | sw-RW | sw-TZ | sw-UG | tl-PH | tt-RU | ug-CN | uk-UA | uz-UZ | wo-SN | zu-ZA Required: Yes Phrases Use this parameter if you want to create your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for creating your custom vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri parameter. Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you must choose one or the other. Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language. Type: Array of strings Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: .+ Required: No Tags Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary at the time you create this new custom vocabulary. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: No VocabularyFileUri The Amazon S3 location of the text file that contains your custom vocabulary. The URI must be located in the same AWS Region as the resource you're calling. CreateVocabulary API Version 2017-10-26 27 Amazon Transcribe API Reference Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt Note that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you must choose one or the other. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://|http(s*)://).+ Required: No VocabularyName A unique name, chosen by you, for your new custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an AWS account. If you try to create a new custom vocabulary with the same name as an existing custom vocabulary, you get a ConflictException error. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Syntax { "FailureReason": "string", "LanguageCode": "string", "LastModifiedTime": number, "VocabularyName": "string", "VocabularyState": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. CreateVocabulary API Version 2017-10-26 28 Amazon Transcribe API Reference The following data is returned in JSON format by the service. FailureReason If VocabularyState is FAILED, FailureReason contains information about why the custom vocabulary request failed. See also: Common Errors. Type: String LanguageCode The language code you selected for your custom vocabulary. Type: String Valid Values: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ | vi-VN | sv-SE | ab-GE | ast-ES | az-AZ | ba-RU | be- BY | bg-BG | bn-IN | bs-BA | ca-ES | ckb-IQ | ckb-IR | cs-CZ | cy-WL | el-GR | et-ET | eu-ES | fi-FI | gl-ES | gu-IN | ha-NG | hr-HR | hu-HU | hy-AM | is-IS | ka-GE | kab-DZ | kk-KZ | kn-IN | ky-KG | lg-IN | lt-LT | lv-LV | mhr-RU | mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | so-SO | sr-RS | su-ID | sw-BI | sw-KE | sw-RW | sw-TZ | sw-UG | tl-PH | tt-RU | ug-CN | uk-UA | uz-UZ | wo-SN | zu-ZA LastModifiedTime The date and time you created your custom vocabulary. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp VocabularyName The name you chose for your custom vocabulary. Type: String CreateVocabulary API Version 2017-10-26 29 Amazon Transcribe API Reference Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ VocabularyState The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request. Type: String Valid Values: PENDING | READY | FAILED Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can
|
transcribe-api-009
|
transcribe-api.pdf
| 9 |
12:32 PM UTC-7 on May 4, 2022. Type: Timestamp VocabularyName The name you chose for your custom vocabulary. Type: String CreateVocabulary API Version 2017-10-26 29 Amazon Transcribe API Reference Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ VocabularyState The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request. Type: String Valid Values: PENDING | READY | FAILED Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 ConflictException A resource already exists with this name. Resource names must be unique within an AWS account. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 CreateVocabulary API Version 2017-10-26 30 Amazon Transcribe See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateVocabulary API Version 2017-10-26 31 Amazon Transcribe API Reference CreateVocabularyFilter Service: Amazon Transcribe Service Creates a new custom vocabulary filter. You can use custom vocabulary filters to mask, delete, or flag specific words from your transcript. Custom vocabulary filters are commonly used to mask profanity in transcripts. Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language. For more information, see Vocabulary filtering. Request Syntax { "DataAccessRoleArn": "string", "LanguageCode": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VocabularyFilterFileUri": "string", "VocabularyFilterName": "string", "Words": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DataAccessRoleArn The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary filter). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails. CreateVocabularyFilter API Version 2017-10-26 32 Amazon Transcribe API Reference IAM role ARNs have the format arn:partition:iam::account:role/role-name-with- path. For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9] {0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$ Required: No LanguageCode The language code that represents the language of the entries in your vocabulary filter. Each custom vocabulary filter must contain terms in only one language. A custom vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a custom vocabulary filter using US English (en-US), you can only apply this filter to files that contain English audio. For a list of supported languages and their associated language codes, refer to the Supported languages table. Type: String Valid Values: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ | vi-VN | sv-SE | ab-GE | ast-ES | az-AZ | ba-RU | be- BY | bg-BG | bn-IN | bs-BA | ca-ES | ckb-IQ | ckb-IR | cs-CZ | cy-WL | el-GR | et-ET | eu-ES | fi-FI | gl-ES | gu-IN | ha-NG | hr-HR | hu-HU | hy-AM | is-IS | ka-GE | kab-DZ | kk-KZ | kn-IN | ky-KG | lg-IN | lt-LT | lv-LV | mhr-RU | mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | so-SO |
|
transcribe-api-010
|
transcribe-api.pdf
| 10 |
| ast-ES | az-AZ | ba-RU | be- BY | bg-BG | bn-IN | bs-BA | ca-ES | ckb-IQ | ckb-IR | cs-CZ | cy-WL | el-GR | et-ET | eu-ES | fi-FI | gl-ES | gu-IN | ha-NG | hr-HR | hu-HU | hy-AM | is-IS | ka-GE | kab-DZ | kk-KZ | kn-IN | ky-KG | lg-IN | lt-LT | lv-LV | mhr-RU | mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | so-SO | sr-RS | su-ID | sw-BI | sw-KE | sw-RW | sw-TZ | sw-UG | tl-PH | tt-RU | ug-CN | uk-UA | uz-UZ | wo-SN | zu-ZA Required: Yes CreateVocabularyFilter API Version 2017-10-26 33 Amazon Transcribe Tags API Reference Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time you create this new vocabulary filter. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. Type: Array of Tag objects Array Members: Minimum number of 1 item. Maximum number of 200 items. Required: No VocabularyFilterFileUri The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same AWS Region as the resource you're calling. Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt Note that if you include VocabularyFilterFileUri in your request, you cannot use Words; you must choose one or the other. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://|http(s*)://).+ Required: No VocabularyFilterName A unique name, chosen by you, for your new custom vocabulary filter. This name is case sensitive, cannot contain spaces, and must be unique within an AWS account. If you try to create a new custom vocabulary filter with the same name as an existing custom vocabulary filter, you get a ConflictException error. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes CreateVocabularyFilter API Version 2017-10-26 34 Amazon Transcribe Words API Reference Use this parameter if you want to create your custom vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFilterFileUri parameter. Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; you must choose one or the other. Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language. Type: Array of strings Array Members: Minimum number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 256. Required: No Response Syntax { "LanguageCode": "string", "LastModifiedTime": number, "VocabularyFilterName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LanguageCode The language code you selected for your custom vocabulary filter. Type: String CreateVocabularyFilter API Version 2017-10-26 35 Amazon Transcribe API Reference Valid Values: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ | vi-VN | sv-SE | ab-GE | ast-ES | az-AZ | ba-RU | be- BY | bg-BG | bn-IN | bs-BA | ca-ES | ckb-IQ | ckb-IR | cs-CZ | cy-WL | el-GR | et-ET | eu-ES | fi-FI | gl-ES | gu-IN | ha-NG | hr-HR | hu-HU | hy-AM | is-IS | ka-GE | kab-DZ | kk-KZ | kn-IN | ky-KG | lg-IN | lt-LT | lv-LV | mhr-RU | mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | so-SO | sr-RS | su-ID | sw-BI | sw-KE | sw-RW | sw-TZ | sw-UG | tl-PH | tt-RU | ug-CN | uk-UA | uz-UZ | wo-SN | zu-ZA LastModifiedTime The date and time you created your custom vocabulary filter. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp VocabularyFilterName The name you chose for your custom
|
transcribe-api-011
|
transcribe-api.pdf
| 11 |
| mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | so-SO | sr-RS | su-ID | sw-BI | sw-KE | sw-RW | sw-TZ | sw-UG | tl-PH | tt-RU | ug-CN | uk-UA | uz-UZ | wo-SN | zu-ZA LastModifiedTime The date and time you created your custom vocabulary filter. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp VocabularyFilterName The name you chose for your custom vocabulary filter. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. CreateVocabularyFilter API Version 2017-10-26 36 Amazon Transcribe HTTP Status Code: 400 ConflictException API Reference A resource already exists with this name. Resource names must be unique within an AWS account. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateVocabularyFilter API Version 2017-10-26 37 Amazon Transcribe API Reference DeleteCallAnalyticsCategory Service: Amazon Transcribe Service Deletes a Call Analytics category. To use this operation, specify the name of the category you want to delete using CategoryName. Category names are case sensitive. Request Syntax { "CategoryName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CategoryName The name of the Call Analytics category you want to delete. Category names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteCallAnalyticsCategory API Version 2017-10-26 38 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin DeleteCallAnalyticsCategory API Version 2017-10-26 39 Amazon Transcribe • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeleteCallAnalyticsCategory API Version 2017-10-26 40 Amazon Transcribe API Reference DeleteCallAnalyticsJob Service: Amazon Transcribe Service Deletes a Call Analytics job. To use this operation, specify the name of the job you want to delete using CallAnalyticsJobName. Job names are case sensitive. Request Syntax { "CallAnalyticsJobName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CallAnalyticsJobName The name of the Call Analytics job you want to delete. Job names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Elements If the action is successful,
|
transcribe-api-012
|
transcribe-api.pdf
| 12 |
Amazon Transcribe Service Deletes a Call Analytics job. To use this operation, specify the name of the job you want to delete using CallAnalyticsJobName. Job names are case sensitive. Request Syntax { "CallAnalyticsJobName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CallAnalyticsJobName The name of the Call Analytics job you want to delete. Job names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteCallAnalyticsJob API Version 2017-10-26 41 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteCallAnalyticsJob API Version 2017-10-26 42 Amazon Transcribe API Reference DeleteLanguageModel Service: Amazon Transcribe Service Deletes a custom language model. To use this operation, specify the name of the language model you want to delete using ModelName. custom language model names are case sensitive. Request Syntax { "ModelName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ModelName The name of the custom language model you want to delete. Model names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteLanguageModel API Version 2017-10-26 43 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteLanguageModel API Version 2017-10-26 44 Amazon Transcribe API Reference DeleteMedicalScribeJob Service: Amazon Transcribe Service Deletes a Medical Scribe job. To use this operation, specify the name of the job you want to delete using MedicalScribeJobName. Job names are case sensitive. Request Syntax { "MedicalScribeJobName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MedicalScribeJobName The name of the Medical Scribe job you want to delete. Job names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteMedicalScribeJob API Version 2017-10-26 45 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity
|
transcribe-api-013
|
transcribe-api.pdf
| 13 |
accepts the following data in JSON format. MedicalScribeJobName The name of the Medical Scribe job you want to delete. Job names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteMedicalScribeJob API Version 2017-10-26 45 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteMedicalScribeJob API Version 2017-10-26 46 Amazon Transcribe API Reference DeleteMedicalTranscriptionJob Service: Amazon Transcribe Service Deletes a medical transcription job. To use this operation, specify the name of the job you want to delete using MedicalTranscriptionJobName. Job names are case sensitive. Request Syntax { "MedicalTranscriptionJobName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MedicalTranscriptionJobName The name of the medical transcription job you want to delete. Job names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteMedicalTranscriptionJob API Version 2017-10-26 47 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteMedicalTranscriptionJob API Version 2017-10-26 48 Amazon Transcribe API Reference DeleteMedicalVocabulary Service: Amazon Transcribe Service Deletes a custom medical vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete using VocabularyName. Custom vocabulary names are case sensitive. Request Syntax { "VocabularyName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. VocabularyName The name of the custom medical vocabulary you want to delete. Custom medical vocabulary names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteMedicalVocabulary API Version 2017-10-26 49 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException
|
transcribe-api-014
|
transcribe-api.pdf
| 14 |
HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteMedicalVocabulary API Version 2017-10-26 49 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin DeleteMedicalVocabulary API Version 2017-10-26 50 Amazon Transcribe • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeleteMedicalVocabulary API Version 2017-10-26 51 Amazon Transcribe API Reference DeleteTranscriptionJob Service: Amazon Transcribe Service Deletes a transcription job. To use this operation, specify the name of the job you want to delete using TranscriptionJobName. Job names are case sensitive. Request Syntax { "TranscriptionJobName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. TranscriptionJobName The name of the transcription job you want to delete. Job names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteTranscriptionJob API Version 2017-10-26 52 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteTranscriptionJob API Version 2017-10-26 53 Amazon Transcribe API Reference DeleteVocabulary Service: Amazon Transcribe Service Deletes a custom vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete using VocabularyName. Custom vocabulary names are case sensitive. Request Syntax { "VocabularyName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. VocabularyName The name of the custom vocabulary you want to delete. Custom vocabulary names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteVocabulary API Version 2017-10-26 54 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try
|
transcribe-api-015
|
transcribe-api.pdf
| 15 |
Version 2017-10-26 54 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin DeleteVocabulary API Version 2017-10-26 55 Amazon Transcribe • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeleteVocabulary API Version 2017-10-26 56 Amazon Transcribe API Reference DeleteVocabularyFilter Service: Amazon Transcribe Service Deletes a custom vocabulary filter. To use this operation, specify the name of the custom vocabulary filter you want to delete using VocabularyFilterName. Custom vocabulary filter names are case sensitive. Request Syntax { "VocabularyFilterName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. VocabularyFilterName The name of the custom vocabulary filter you want to delete. Custom vocabulary filter names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteVocabularyFilter API Version 2017-10-26 57 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin DeleteVocabularyFilter API Version 2017-10-26 58 Amazon Transcribe • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeleteVocabularyFilter API Version 2017-10-26 59 Amazon Transcribe API Reference DescribeLanguageModel Service: Amazon Transcribe Service Provides information about the specified custom language model. This operation also shows if the base language model that you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model. If you tried to create a new custom language model and the request wasn't successful, you can use DescribeLanguageModel to help identify the reason for this failure. To get a list of your custom language models, use the ListLanguageModels operation. Request Syntax { "ModelName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ModelName The name of the custom language model you want information about. Model names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Syntax { DescribeLanguageModel API Version 2017-10-26 60 Amazon Transcribe API Reference "LanguageModel": { "BaseModelName": "string", "CreateTime": number, "FailureReason": "string", "InputDataConfig": { "DataAccessRoleArn": "string", "S3Uri": "string", "TuningDataS3Uri": "string" }, "LanguageCode": "string", "LastModifiedTime": number, "ModelName": "string", "ModelStatus": "string", "UpgradeAvailability": boolean } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data
|
transcribe-api-016
|
transcribe-api.pdf
| 16 |
request accepts the following data in JSON format. ModelName The name of the custom language model you want information about. Model names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Syntax { DescribeLanguageModel API Version 2017-10-26 60 Amazon Transcribe API Reference "LanguageModel": { "BaseModelName": "string", "CreateTime": number, "FailureReason": "string", "InputDataConfig": { "DataAccessRoleArn": "string", "S3Uri": "string", "TuningDataS3Uri": "string" }, "LanguageCode": "string", "LastModifiedTime": number, "ModelName": "string", "ModelStatus": "string", "UpgradeAvailability": boolean } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LanguageModel Provides information about the specified custom language model. This parameter also shows if the base language model you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model. If you tried to create a new custom language model and the request wasn't successful, you can use this DescribeLanguageModel to help identify the reason for this failure. Type: LanguageModel object Errors For information about the errors that are common to all actions, see Common Errors. DescribeLanguageModel API Version 2017-10-26 61 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin DescribeLanguageModel API Version 2017-10-26 62 Amazon Transcribe • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DescribeLanguageModel API Version 2017-10-26 63 Amazon Transcribe API Reference GetCallAnalyticsCategory Service: Amazon Transcribe Service Provides information about the specified Call Analytics category. To get a list of your Call Analytics categories, use the ListCallAnalyticsCategories operation. Request Syntax { "CategoryName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CategoryName The name of the Call Analytics category you want information about. Category names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Syntax { "CategoryProperties": { "CategoryName": "string", "CreateTime": number, "InputType": "string", "LastUpdateTime": number, "Rules": [ GetCallAnalyticsCategory API Version 2017-10-26 64 API Reference Amazon Transcribe { ... } ], "Tags": [ { "Key": "string", "Value": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CategoryProperties Provides you with the properties of the Call Analytics category you specified in your GetCallAnalyticsCategory request. Type: CategoryProperties object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 GetCallAnalyticsCategory API Version 2017-10-26 65 Amazon Transcribe LimitExceededException API Reference You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for
|
transcribe-api-017
|
transcribe-api.pdf
| 17 |
requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetCallAnalyticsCategory API Version 2017-10-26 66 Amazon Transcribe API Reference GetCallAnalyticsJob Service: Amazon Transcribe Service Provides information about the specified Call Analytics job. To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed. If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri. If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in RedactedMediaFileUri. To get a list of your Call Analytics jobs, use the ListCallAnalyticsJobs operation. Request Syntax { "CallAnalyticsJobName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CallAnalyticsJobName The name of the Call Analytics job you want information about. Job names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes GetCallAnalyticsJob API Version 2017-10-26 67 Amazon Transcribe Response Syntax API Reference { "CallAnalyticsJob": { "CallAnalyticsJobDetails": { "Skipped": [ { "Feature": "string", "Message": "string", "ReasonCode": "string" } ] }, "CallAnalyticsJobName": "string", "CallAnalyticsJobStatus": "string", "ChannelDefinitions": [ { "ChannelId": number, "ParticipantRole": "string" } ], "CompletionTime": number, "CreationTime": number, "DataAccessRoleArn": "string", "FailureReason": "string", "IdentifiedLanguageScore": number, "LanguageCode": "string", "Media": { "MediaFileUri": "string", "RedactedMediaFileUri": "string" }, "MediaFormat": "string", "MediaSampleRateHertz": number, "Settings": { "ContentRedaction": { "PiiEntityTypes": [ "string" ], "RedactionOutput": "string", "RedactionType": "string" }, "LanguageIdSettings": { "string" : { "LanguageModelName": "string", "VocabularyFilterName": "string", GetCallAnalyticsJob API Version 2017-10-26 68 Amazon Transcribe API Reference "VocabularyName": "string" } }, "LanguageModelName": "string", "LanguageOptions": [ "string" ], "Summarization": { "GenerateAbstractiveSummary": boolean }, "VocabularyFilterMethod": "string", "VocabularyFilterName": "string", "VocabularyName": "string" }, "StartTime": number, "Tags": [ { "Key": "string", "Value": "string" } ], "Transcript": { "RedactedTranscriptFileUri": "string", "TranscriptFileUri": "string" } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CallAnalyticsJob Provides detailed information about the specified Call Analytics job, including job status and, if applicable, failure reason. Type: CallAnalyticsJob object Errors For information about the errors that are common to all actions, see Common Errors. GetCallAnalyticsJob API Version 2017-10-26 69 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin GetCallAnalyticsJob API Version 2017-10-26 70 Amazon Transcribe • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference GetCallAnalyticsJob API Version 2017-10-26 71 Amazon Transcribe API Reference GetMedicalScribeJob Service: Amazon Transcribe Service Provides information about the specified Medical Scribe job. To view the status of the specified medical transcription job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed. To get a list of your Medical
|
transcribe-api-018
|
transcribe-api.pdf
| 18 |
70 Amazon Transcribe • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference GetCallAnalyticsJob API Version 2017-10-26 71 Amazon Transcribe API Reference GetMedicalScribeJob Service: Amazon Transcribe Service Provides information about the specified Medical Scribe job. To view the status of the specified medical transcription job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed. To get a list of your Medical Scribe jobs, use the ListMedicalScribeJobs operation. Request Syntax { "MedicalScribeJobName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MedicalScribeJobName The name of the Medical Scribe job you want information about. Job names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Syntax { "MedicalScribeJob": { "ChannelDefinitions": [ { GetMedicalScribeJob API Version 2017-10-26 72 Amazon Transcribe API Reference "ChannelId": number, "ParticipantRole": "string" } ], "CompletionTime": number, "CreationTime": number, "DataAccessRoleArn": "string", "FailureReason": "string", "LanguageCode": "string", "Media": { "MediaFileUri": "string", "RedactedMediaFileUri": "string" }, "MedicalScribeJobName": "string", "MedicalScribeJobStatus": "string", "MedicalScribeOutput": { "ClinicalDocumentUri": "string", "TranscriptFileUri": "string" }, "Settings": { "ChannelIdentification": boolean, "ClinicalNoteGenerationSettings": { "NoteTemplate": "string" }, "MaxSpeakerLabels": number, "ShowSpeakerLabels": boolean, "VocabularyFilterMethod": "string", "VocabularyFilterName": "string", "VocabularyName": "string" }, "StartTime": number, "Tags": [ { "Key": "string", "Value": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. GetMedicalScribeJob API Version 2017-10-26 73 Amazon Transcribe API Reference The following data is returned in JSON format by the service. MedicalScribeJob Provides detailed information about the specified Medical Scribe job, including job status and, if applicable, failure reason Type: MedicalScribeJob object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again. HTTP Status Code: 400 GetMedicalScribeJob API Version 2017-10-26 74 Amazon Transcribe See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetMedicalScribeJob API Version 2017-10-26 75 Amazon Transcribe API Reference GetMedicalTranscriptionJob Service: Amazon Transcribe Service Provides information about the specified medical transcription job. To view the status of the specified medical transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed. To get a list of your medical transcription jobs, use the ListMedicalTranscriptionJobs operation. Request Syntax { "MedicalTranscriptionJobName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MedicalTranscriptionJobName The name of the medical transcription job you want information about. Job names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Syntax { GetMedicalTranscriptionJob API Version 2017-10-26 76 Amazon Transcribe API Reference "MedicalTranscriptionJob": { "CompletionTime": number, "ContentIdentificationType": "string", "CreationTime": number, "FailureReason": "string", "LanguageCode": "string", "Media": { "MediaFileUri": "string", "RedactedMediaFileUri": "string" }, "MediaFormat": "string", "MediaSampleRateHertz": number, "MedicalTranscriptionJobName": "string", "Settings": { "ChannelIdentification": boolean, "MaxAlternatives": number, "MaxSpeakerLabels": number, "ShowAlternatives": boolean, "ShowSpeakerLabels": boolean, "VocabularyName": "string" }, "Specialty": "string", "StartTime": number, "Tags": [ { "Key": "string", "Value": "string" } ], "Transcript": { "TranscriptFileUri": "string" }, "TranscriptionJobStatus": "string", "Type": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GetMedicalTranscriptionJob API Version 2017-10-26 77 Amazon Transcribe MedicalTranscriptionJob API Reference Provides detailed information about the specified medical transcription job, including
|
transcribe-api-019
|
transcribe-api.pdf
| 19 |
"LanguageCode": "string", "Media": { "MediaFileUri": "string", "RedactedMediaFileUri": "string" }, "MediaFormat": "string", "MediaSampleRateHertz": number, "MedicalTranscriptionJobName": "string", "Settings": { "ChannelIdentification": boolean, "MaxAlternatives": number, "MaxSpeakerLabels": number, "ShowAlternatives": boolean, "ShowSpeakerLabels": boolean, "VocabularyName": "string" }, "Specialty": "string", "StartTime": number, "Tags": [ { "Key": "string", "Value": "string" } ], "Transcript": { "TranscriptFileUri": "string" }, "TranscriptionJobStatus": "string", "Type": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GetMedicalTranscriptionJob API Version 2017-10-26 77 Amazon Transcribe MedicalTranscriptionJob API Reference Provides detailed information about the specified medical transcription job, including job status and, if applicable, failure reason. Type: MedicalTranscriptionJob object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: GetMedicalTranscriptionJob API Version 2017-10-26 78 API Reference Amazon Transcribe • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetMedicalTranscriptionJob API Version 2017-10-26 79 Amazon Transcribe API Reference GetMedicalVocabulary Service: Amazon Transcribe Service Provides information about the specified custom medical vocabulary. To view the status of the specified custom medical vocabulary, check the VocabularyState field. If the status is READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your vocabulary failed. To get a list of your custom medical vocabularies, use the ListMedicalVocabularies operation. Request Syntax { "VocabularyName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. VocabularyName The name of the custom medical vocabulary you want information about. Custom medical vocabulary names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Syntax { "DownloadUri": "string", "FailureReason": "string", GetMedicalVocabulary API Version 2017-10-26 80 Amazon Transcribe API Reference "LanguageCode": "string", "LastModifiedTime": number, "VocabularyName": "string", "VocabularyState": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DownloadUri The Amazon S3 location where the specified custom medical vocabulary is stored; use this URI to view or download the custom vocabulary. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://|http(s*)://).+ FailureReason If VocabularyState is FAILED, FailureReason contains information about why the custom medical vocabulary request failed. See also: Common Errors. Type: String LanguageCode The language code you selected for your custom medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical. Type: String Valid Values: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ | vi-VN | sv-SE | ab-GE | ast-ES | az-AZ | ba-RU | be- BY | bg-BG | bn-IN | bs-BA | ca-ES | ckb-IQ | ckb-IR | cs-CZ | cy-WL | GetMedicalVocabulary API Version 2017-10-26 81 Amazon Transcribe API Reference el-GR | et-ET | eu-ES | fi-FI | gl-ES | gu-IN | ha-NG | hr-HR | hu-HU | hy-AM | is-IS | ka-GE | kab-DZ | kk-KZ | kn-IN | ky-KG | lg-IN | lt-LT | lv-LV | mhr-RU | mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | so-SO | sr-RS | su-ID |
|
transcribe-api-020
|
transcribe-api.pdf
| 20 |
| bs-BA | ca-ES | ckb-IQ | ckb-IR | cs-CZ | cy-WL | GetMedicalVocabulary API Version 2017-10-26 81 Amazon Transcribe API Reference el-GR | et-ET | eu-ES | fi-FI | gl-ES | gu-IN | ha-NG | hr-HR | hu-HU | hy-AM | is-IS | ka-GE | kab-DZ | kk-KZ | kn-IN | ky-KG | lg-IN | lt-LT | lv-LV | mhr-RU | mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | so-SO | sr-RS | su-ID | sw-BI | sw-KE | sw-RW | sw-TZ | sw-UG | tl-PH | tt-RU | ug-CN | uk-UA | uz-UZ | wo-SN | zu-ZA LastModifiedTime The date and time the specified custom medical vocabulary was last modified. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp VocabularyName The name of the custom medical vocabulary you requested information about. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ VocabularyState The processing state of your custom medical vocabulary. If the state is READY, you can use the custom vocabulary in a StartMedicalTranscriptionJob request. Type: String Valid Values: PENDING | READY | FAILED Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. GetMedicalVocabulary API Version 2017-10-26 82 Amazon Transcribe HTTP Status Code: 400 InternalFailureException API Reference There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetMedicalVocabulary API Version 2017-10-26 83 Amazon Transcribe API Reference GetTranscriptionJob Service: Amazon Transcribe Service Provides information about the specified transcription job. To view the status of the specified transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed. If you enabled content redaction, the redacted transcript can be found at the location specified in RedactedTranscriptFileUri. To get a list of your transcription jobs, use the ListTranscriptionJobs operation. Request Syntax { "TranscriptionJobName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. TranscriptionJobName The name of the transcription job you want information about. Job names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Syntax { GetTranscriptionJob API Version 2017-10-26 84 Amazon Transcribe API Reference "TranscriptionJob": { "CompletionTime": number, "ContentRedaction": { "PiiEntityTypes": [ "string" ], "RedactionOutput": "string", "RedactionType": "string" }, "CreationTime": number, "FailureReason": "string", "IdentifiedLanguageScore": number, "IdentifyLanguage": boolean, "IdentifyMultipleLanguages": boolean, "JobExecutionSettings": { "AllowDeferredExecution": boolean, "DataAccessRoleArn": "string" }, "LanguageCode": "string", "LanguageCodes": [ { "DurationInSeconds": number, "LanguageCode": "string" } ], "LanguageIdSettings": { "string" : { "LanguageModelName": "string", "VocabularyFilterName": "string", "VocabularyName": "string" } }, "LanguageOptions": [ "string" ], "Media": { "MediaFileUri": "string", "RedactedMediaFileUri": "string" }, "MediaFormat": "string", "MediaSampleRateHertz": number, "ModelSettings": { "LanguageModelName": "string" }, "Settings": { "ChannelIdentification": boolean, "MaxAlternatives": number, "MaxSpeakerLabels": number, GetTranscriptionJob API Version 2017-10-26 85 Amazon Transcribe API Reference "ShowAlternatives": boolean, "ShowSpeakerLabels": boolean, "VocabularyFilterMethod": "string", "VocabularyFilterName": "string", "VocabularyName": "string" }, "StartTime": number, "Subtitles": { "Formats": [ "string" ], "OutputStartIndex": number, "SubtitleFileUris": [ "string" ] }, "Tags": [ { "Key": "string", "Value": "string" } ], "ToxicityDetection": [ { "ToxicityCategories": [ "string" ] } ], "Transcript": { "RedactedTranscriptFileUri": "string", "TranscriptFileUri": "string" }, "TranscriptionJobName": "string", "TranscriptionJobStatus": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. TranscriptionJob Provides detailed information about the specified transcription job, including job status and, if applicable, failure reason.
|
transcribe-api-021
|
transcribe-api.pdf
| 21 |
"ShowAlternatives": boolean, "ShowSpeakerLabels": boolean, "VocabularyFilterMethod": "string", "VocabularyFilterName": "string", "VocabularyName": "string" }, "StartTime": number, "Subtitles": { "Formats": [ "string" ], "OutputStartIndex": number, "SubtitleFileUris": [ "string" ] }, "Tags": [ { "Key": "string", "Value": "string" } ], "ToxicityDetection": [ { "ToxicityCategories": [ "string" ] } ], "Transcript": { "RedactedTranscriptFileUri": "string", "TranscriptFileUri": "string" }, "TranscriptionJobName": "string", "TranscriptionJobStatus": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. TranscriptionJob Provides detailed information about the specified transcription job, including job status and, if applicable, failure reason. Type: TranscriptionJob object GetTranscriptionJob API Version 2017-10-26 86 Amazon Transcribe Errors API Reference For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 GetTranscriptionJob API Version 2017-10-26 87 Amazon Transcribe • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference GetTranscriptionJob API Version 2017-10-26 88 Amazon Transcribe API Reference GetVocabulary Service: Amazon Transcribe Service Provides information about the specified custom vocabulary. To view the status of the specified custom vocabulary, check the VocabularyState field. If the status is READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your custom vocabulary failed. To get a list of your custom vocabularies, use the ListVocabularies operation. Request Syntax { "VocabularyName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. VocabularyName The name of the custom vocabulary you want information about. Custom vocabulary names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Syntax { "DownloadUri": "string", "FailureReason": "string", GetVocabulary API Version 2017-10-26 89 Amazon Transcribe API Reference "LanguageCode": "string", "LastModifiedTime": number, "VocabularyName": "string", "VocabularyState": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DownloadUri The Amazon S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://|http(s*)://).+ FailureReason If VocabularyState is FAILED, FailureReason contains information about why the custom vocabulary request failed. See also: Common Errors. Type: String LanguageCode The language code you selected for your custom vocabulary. Type: String Valid Values: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ | vi-VN | sv-SE | ab-GE | ast-ES | az-AZ | ba-RU | be- BY | bg-BG | bn-IN | bs-BA | ca-ES | ckb-IQ | ckb-IR | cs-CZ | cy-WL | el-GR | et-ET | eu-ES | fi-FI | gl-ES | gu-IN | ha-NG | hr-HR | hu-HU | GetVocabulary API Version 2017-10-26 90 Amazon Transcribe API Reference hy-AM | is-IS | ka-GE | kab-DZ | kk-KZ | kn-IN | ky-KG | lg-IN | lt-LT | lv-LV | mhr-RU | mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | so-SO | sr-RS | su-ID | sw-BI | sw-KE | sw-RW | sw-TZ | sw-UG | tl-PH | tt-RU | ug-CN | uk-UA |
|
transcribe-api-022
|
transcribe-api.pdf
| 22 |
| fi-FI | gl-ES | gu-IN | ha-NG | hr-HR | hu-HU | GetVocabulary API Version 2017-10-26 90 Amazon Transcribe API Reference hy-AM | is-IS | ka-GE | kab-DZ | kk-KZ | kn-IN | ky-KG | lg-IN | lt-LT | lv-LV | mhr-RU | mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | so-SO | sr-RS | su-ID | sw-BI | sw-KE | sw-RW | sw-TZ | sw-UG | tl-PH | tt-RU | ug-CN | uk-UA | uz-UZ | wo-SN | zu-ZA LastModifiedTime The date and time the specified custom vocabulary was last modified. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. Type: Timestamp VocabularyName The name of the custom vocabulary you requested information about. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ VocabularyState The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request. Type: String Valid Values: PENDING | READY | FAILED Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. GetVocabulary API Version 2017-10-26 91 Amazon Transcribe HTTP Status Code: 400 InternalFailureException API Reference There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetVocabulary API Version 2017-10-26 92 Amazon Transcribe API Reference GetVocabularyFilter Service: Amazon Transcribe Service Provides information about the specified custom vocabulary filter. To get a list of your custom vocabulary filters, use the ListVocabularyFilters operation. Request Syntax { "VocabularyFilterName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. VocabularyFilterName The name of the custom vocabulary filter you want information about. Custom vocabulary filter names are case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: Yes Response Syntax { "DownloadUri": "string", "LanguageCode": "string", "LastModifiedTime": number, "VocabularyFilterName": "string" } GetVocabularyFilter API Version 2017-10-26 93 Amazon Transcribe Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DownloadUri The Amazon S3 location where the custom vocabulary filter is stored; use this URI to view or download the custom vocabulary filter. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: (s3://|http(s*)://).+ LanguageCode The language code you selected for your custom vocabulary filter. Type: String Valid Values: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ | vi-VN | sv-SE | ab-GE | ast-ES | az-AZ | ba-RU | be- BY | bg-BG | bn-IN | bs-BA | ca-ES | ckb-IQ | ckb-IR | cs-CZ | cy-WL | el-GR | et-ET | eu-ES | fi-FI | gl-ES | gu-IN | ha-NG | hr-HR | hu-HU | hy-AM | is-IS | ka-GE | kab-DZ | kk-KZ | kn-IN | ky-KG | lg-IN | lt-LT | lv-LV | mhr-RU | mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | so-SO | sr-RS | su-ID | sw-BI | sw-KE
|
transcribe-api-023
|
transcribe-api.pdf
| 23 |
be- BY | bg-BG | bn-IN | bs-BA | ca-ES | ckb-IQ | ckb-IR | cs-CZ | cy-WL | el-GR | et-ET | eu-ES | fi-FI | gl-ES | gu-IN | ha-NG | hr-HR | hu-HU | hy-AM | is-IS | ka-GE | kab-DZ | kk-KZ | kn-IN | ky-KG | lg-IN | lt-LT | lv-LV | mhr-RU | mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | so-SO | sr-RS | su-ID | sw-BI | sw-KE | sw-RW | sw-TZ | sw-UG | tl-PH | tt-RU | ug-CN | uk-UA | uz-UZ | wo-SN | zu-ZA LastModifiedTime The date and time the specified custom vocabulary filter was last modified. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. GetVocabularyFilter API Version 2017-10-26 94 Amazon Transcribe Type: Timestamp VocabularyFilterName API Reference The name of the custom vocabulary filter you requested information about. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again. HTTP Status Code: 400 GetVocabularyFilter API Version 2017-10-26 95 Amazon Transcribe See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetVocabularyFilter API Version 2017-10-26 96 Amazon Transcribe API Reference ListCallAnalyticsCategories Service: Amazon Transcribe Service Provides a list of Call Analytics categories, including all rules that make up each category. To get detailed information about a specific Call Analytics category, use the GetCallAnalyticsCategory operation. Request Syntax { "MaxResults": number, "NextToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of Call Analytics categories to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextToken If your ListCallAnalyticsCategories request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results. Type: String ListCallAnalyticsCategories API Version 2017-10-26 97 Amazon Transcribe API Reference Length Constraints: Maximum length of 8192. Pattern: .+ Required: No Response Syntax { "Categories": [ { "CategoryName": "string", "CreateTime": number, "InputType": "string", "LastUpdateTime": number, "Rules": [ { ... } ], "Tags": [ { "Key": "string", "Value": "string" } ] } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Categories Provides detailed information about your Call Analytics categories, including all the rules associated with each category. Type: Array of CategoryProperties objects ListCallAnalyticsCategories API Version 2017-10-26 98 Amazon Transcribe NextToken API Reference If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests.
|
transcribe-api-024
|
transcribe-api.pdf
| 24 |
API Version 2017-10-26 98 Amazon Transcribe NextToken API Reference If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: ListCallAnalyticsCategories API Version 2017-10-26 99 API Reference Amazon Transcribe • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListCallAnalyticsCategories API Version 2017-10-26 100 Amazon Transcribe API Reference ListCallAnalyticsJobs Service: Amazon Transcribe Service Provides a list of Call Analytics jobs that match the specified criteria. If no criteria are specified, all Call Analytics jobs are returned. To get detailed information about a specific Call Analytics job, use the GetCallAnalyticsJob operation. Request Syntax { "JobNameContains": "string", "MaxResults": number, "NextToken": "string", "Status": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. JobNameContains Returns only the Call Analytics jobs that contain the specified string. The search is not case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No MaxResults The maximum number of Call Analytics jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used. ListCallAnalyticsJobs API Version 2017-10-26 101 Amazon Transcribe Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. API Reference Required: No NextToken If your ListCallAnalyticsJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ Required: No Status Returns only Call Analytics jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include Status, all Call Analytics jobs are returned. Type: String Valid Values: QUEUED | IN_PROGRESS | FAILED | COMPLETED Required: No Response Syntax { "CallAnalyticsJobSummaries": [ { "CallAnalyticsJobDetails": { "Skipped": [ { "Feature": "string", "Message": "string", "ReasonCode": "string" } ListCallAnalyticsJobs API Version 2017-10-26 102 API Reference Amazon Transcribe ] }, "CallAnalyticsJobName": "string", "CallAnalyticsJobStatus": "string", "CompletionTime": number, "CreationTime": number, "FailureReason": "string", "LanguageCode": "string", "StartTime": number } ], "NextToken": "string", "Status": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CallAnalyticsJobSummaries Provides a summary of information about each result. Type: Array of CallAnalyticsJobSummary objects NextToken If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ Status Lists all Call Analytics jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first. ListCallAnalyticsJobs API Version 2017-10-26 103 Amazon Transcribe Type: String API Reference Valid Values: QUEUED | IN_PROGRESS | FAILED | COMPLETED Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation
|
transcribe-api-025
|
transcribe-api.pdf
| 25 |
run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ Status Lists all Call Analytics jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first. ListCallAnalyticsJobs API Version 2017-10-26 103 Amazon Transcribe Type: String API Reference Valid Values: QUEUED | IN_PROGRESS | FAILED | COMPLETED Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 ListCallAnalyticsJobs API Version 2017-10-26 104 Amazon Transcribe • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListCallAnalyticsJobs API Version 2017-10-26 105 Amazon Transcribe API Reference ListLanguageModels Service: Amazon Transcribe Service Provides a list of custom language models that match the specified criteria. If no criteria are specified, all custom language models are returned. To get detailed information about a specific custom language model, use the DescribeLanguageModel operation. Request Syntax { "MaxResults": number, "NameContains": "string", "NextToken": "string", "StatusEquals": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of custom language models to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NameContains Returns only the custom language models that contain the specified string. The search is not case sensitive. Type: String ListLanguageModels API Version 2017-10-26 106 Amazon Transcribe API Reference Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No NextToken If your ListLanguageModels request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ Required: No StatusEquals Returns only custom language models with the specified status. Language models are ordered by creation date, with the newest model first. If you do not include StatusEquals, all custom language models are returned. Type: String Valid Values: IN_PROGRESS | FAILED | COMPLETED Required: No Response Syntax { "Models": [ { "BaseModelName": "string", "CreateTime": number, "FailureReason": "string", "InputDataConfig": { "DataAccessRoleArn": "string", ListLanguageModels API Version 2017-10-26 107 Amazon Transcribe API Reference "S3Uri": "string", "TuningDataS3Uri": "string" }, "LanguageCode": "string", "LastModifiedTime": number, "ModelName": "string", "ModelStatus": "string", "UpgradeAvailability": boolean } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Models Provides information about the custom language models that match the criteria specified in your request. Type: Array of LanguageModel objects NextToken If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ Errors For information about the errors that are common to all actions, see Common Errors. ListLanguageModels API Version 2017-10-26 108 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status
|
transcribe-api-026
|
transcribe-api.pdf
| 26 |
output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ Errors For information about the errors that are common to all actions, see Common Errors. ListLanguageModels API Version 2017-10-26 108 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListLanguageModels API Version 2017-10-26 109 Amazon Transcribe API Reference ListMedicalScribeJobs Service: Amazon Transcribe Service Provides a list of Medical Scribe jobs that match the specified criteria. If no criteria are specified, all Medical Scribe jobs are returned. To get detailed information about a specific Medical Scribe job, use the GetMedicalScribeJob operation. Request Syntax { "JobNameContains": "string", "MaxResults": number, "NextToken": "string", "Status": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. JobNameContains Returns only the Medical Scribe jobs that contain the specified string. The search is not case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No MaxResults The maximum number of Medical Scribe jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used. ListMedicalScribeJobs API Version 2017-10-26 110 Amazon Transcribe Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. API Reference Required: No NextToken If your ListMedicalScribeJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ Required: No Status Returns only Medical Scribe jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include Status, all Medical Scribe jobs are returned. Type: String Valid Values: QUEUED | IN_PROGRESS | FAILED | COMPLETED Required: No Response Syntax { "MedicalScribeJobSummaries": [ { "CompletionTime": number, "CreationTime": number, "FailureReason": "string", "LanguageCode": "string", "MedicalScribeJobName": "string", "MedicalScribeJobStatus": "string", "StartTime": number ListMedicalScribeJobs API Version 2017-10-26 111 Amazon Transcribe } ], "NextToken": "string", "Status": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MedicalScribeJobSummaries Provides a summary of information about each result. Type: Array of MedicalScribeJobSummary objects NextToken If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ Status Lists all Medical Scribe jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first. Type: String Valid Values: QUEUED | IN_PROGRESS | FAILED | COMPLETED Errors For information about the errors that are common to all actions, see Common Errors. ListMedicalScribeJobs API Version 2017-10-26 112 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status
|
transcribe-api-027
|
transcribe-api.pdf
| 27 |
Type: String Valid Values: QUEUED | IN_PROGRESS | FAILED | COMPLETED Errors For information about the errors that are common to all actions, see Common Errors. ListMedicalScribeJobs API Version 2017-10-26 112 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListMedicalScribeJobs API Version 2017-10-26 113 Amazon Transcribe API Reference ListMedicalTranscriptionJobs Service: Amazon Transcribe Service Provides a list of medical transcription jobs that match the specified criteria. If no criteria are specified, all medical transcription jobs are returned. To get detailed information about a specific medical transcription job, use the GetMedicalTranscriptionJob operation. Request Syntax { "JobNameContains": "string", "MaxResults": number, "NextToken": "string", "Status": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. JobNameContains Returns only the medical transcription jobs that contain the specified string. The search is not case sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No MaxResults The maximum number of medical transcription jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used. ListMedicalTranscriptionJobs API Version 2017-10-26 114 Amazon Transcribe Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. API Reference Required: No NextToken If your ListMedicalTranscriptionJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ Required: No Status Returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include Status, all medical transcription jobs are returned. Type: String Valid Values: QUEUED | IN_PROGRESS | FAILED | COMPLETED Required: No Response Syntax { "MedicalTranscriptionJobSummaries": [ { "CompletionTime": number, "ContentIdentificationType": "string", "CreationTime": number, "FailureReason": "string", "LanguageCode": "string", ListMedicalTranscriptionJobs API Version 2017-10-26 115 Amazon Transcribe API Reference "MedicalTranscriptionJobName": "string", "OutputLocationType": "string", "Specialty": "string", "StartTime": number, "TranscriptionJobStatus": "string", "Type": "string" } ], "NextToken": "string", "Status": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MedicalTranscriptionJobSummaries Provides a summary of information about each result. Type: Array of MedicalTranscriptionJobSummary objects NextToken If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ Status Lists all medical transcription jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first. Type: String ListMedicalTranscriptionJobs API Version 2017-10-26 116 Amazon Transcribe API Reference Valid Values: QUEUED | IN_PROGRESS | FAILED | COMPLETED Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is
|
transcribe-api-028
|
transcribe-api.pdf
| 28 |
| IN_PROGRESS | FAILED | COMPLETED Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin ListMedicalTranscriptionJobs API Version 2017-10-26 117 Amazon Transcribe • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListMedicalTranscriptionJobs API Version 2017-10-26 118 Amazon Transcribe API Reference ListMedicalVocabularies Service: Amazon Transcribe Service Provides a list of custom medical vocabularies that match the specified criteria. If no criteria are specified, all custom medical vocabularies are returned. To get detailed information about a specific custom medical vocabulary, use the GetMedicalVocabulary operation. Request Syntax { "MaxResults": number, "NameContains": "string", "NextToken": "string", "StateEquals": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxResults The maximum number of custom medical vocabularies to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NameContains Returns only the custom medical vocabularies that contain the specified string. The search is not case sensitive. Type: String ListMedicalVocabularies API Version 2017-10-26 119 Amazon Transcribe API Reference Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^[0-9a-zA-Z._-]+ Required: No NextToken If your ListMedicalVocabularies request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ Required: No StateEquals Returns only custom medical vocabularies with the specified state. Custom vocabularies are ordered by creation date, with the newest vocabulary first. If you do not include StateEquals, all custom medical vocabularies are returned. Type: String Valid Values: PENDING | READY | FAILED Required: No Response Syntax { "NextToken": "string", "Status": "string", "Vocabularies": [ { "LanguageCode": "string", "LastModifiedTime": number, "VocabularyName": "string", ListMedicalVocabularies API Version 2017-10-26 120 Amazon Transcribe API Reference "VocabularyState": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results. Type: String Length Constraints: Maximum length of 8192. Pattern: .+ Status Lists all custom medical vocabularies that have the status specified in your request. Custom vocabularies are ordered by creation date, with the newest vocabulary first. Type: String Valid Values: PENDING | READY | FAILED Vocabularies Provides information about the custom medical vocabularies that match the criteria specified in your request. Type: Array of VocabularyInfo objects Errors For information about the errors that are common to all actions, see Common Errors. ListMedicalVocabularies API Version 2017-10-26 121 Amazon Transcribe BadRequestException API Reference Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information. HTTP Status Code: 400 InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again. HTTP Status Code: 500 LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.