View Source AWS.Tnb (aws-elixir v1.0.0)

Amazon Web Services Telco Network Builder (TNB) is a network automation service that helps you deploy and manage telecom networks.

AWS TNB helps you with the lifecycle management of your telecommunication network functions throughout planning, deployment, and post-deployment activities.

Summary

Functions

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

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

Gets a function package descriptor in a function package.

Gets the details of the network instance.

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

Gets the details of a network package.

Gets the content of the network service descriptor.

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

Updates the operational state of function package.

Updates the operational state of a network package.

Functions

Link to this function

cancel_sol_network_operation(client, ns_lcm_op_occ_id, input, options \\ [])

View Source

Cancels a network operation.

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

Link to this function

create_sol_function_package(client, input, options \\ [])

View Source

Creates a function package.

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. For more information, see Function packages in the Amazon Web Services Telco Network Builder User Guide.

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

Link to this function

create_sol_network_instance(client, input, options \\ [])

View Source

Creates a network instance.

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Creating a network instance is the third step after creating a network package. For more information about network instances, Network instances in the Amazon Web Services Telco Network Builder User Guide.

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

Link to this function

create_sol_network_package(client, input, options \\ [])

View Source

Creates a network package.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. For more information, see Network instances in the Amazon Web Services Telco Network Builder User Guide.

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

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

Link to this function

delete_sol_function_package(client, vnf_pkg_id, input, options \\ [])

View Source

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.

Link to this function

delete_sol_network_instance(client, ns_instance_id, input, options \\ [])

View Source

Deletes a network instance.

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

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

Link to this function

delete_sol_network_package(client, nsd_info_id, input, options \\ [])

View Source

Deletes network package.

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

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

Link to this function

get_sol_function_instance(client, vnf_instance_id, options \\ [])

View Source

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

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

Link to this function

get_sol_function_package(client, vnf_pkg_id, options \\ [])

View Source

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

Link to this function

get_sol_function_package_content(client, vnf_pkg_id, accept, options \\ [])

View Source

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.

Link to this function

get_sol_function_package_descriptor(client, vnf_pkg_id, accept, options \\ [])

View Source

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.

Link to this function

get_sol_network_instance(client, ns_instance_id, options \\ [])

View Source

Gets the details of the network instance.

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

Link to this function

get_sol_network_operation(client, ns_lcm_op_occ_id, options \\ [])

View Source

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.

Link to this function

get_sol_network_package(client, nsd_info_id, options \\ [])

View Source

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 Amazon Web Services infrastructure you want to deploy them on.

Link to this function

get_sol_network_package_content(client, nsd_info_id, accept, options \\ [])

View Source

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 Amazon Web Services infrastructure you want to deploy them on.

Link to this function

get_sol_network_package_descriptor(client, nsd_info_id, options \\ [])

View Source

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 Amazon Web Services infrastructure you want to deploy the network functions on.

Link to this function

instantiate_sol_network_instance(client, ns_instance_id, input, options \\ [])

View Source

Instantiates a network instance.

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

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

Link to this function

list_sol_function_instances(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists network function instances.

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

Link to this function

list_sol_function_packages(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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.

Link to this function

list_sol_network_instances(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists your network instances.

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

Link to this function

list_sol_network_operations(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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.

Link to this function

list_sol_network_packages(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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 Amazon Web Services infrastructure you want to deploy them on.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists tags for AWS TNB resources.

Link to this function

put_sol_function_package_content(client, vnf_pkg_id, input, options \\ [])

View Source

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.

Link to this function

put_sol_network_package_content(client, nsd_info_id, input, options \\ [])

View Source

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 Amazon Web Services infrastructure you want to deploy them on.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Tags an AWS TNB resource.

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

Link to this function

terminate_sol_network_instance(client, ns_instance_id, input, options \\ [])

View Source

Terminates a network instance.

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

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

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Untags an AWS TNB resource.

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

Link to this function

update_sol_function_package(client, vnf_pkg_id, input, options \\ [])

View Source

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.

Link to this function

update_sol_network_instance(client, ns_instance_id, input, options \\ [])

View Source

Update a network instance.

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

Link to this function

update_sol_network_package(client, nsd_info_id, input, options \\ [])

View Source

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 Amazon Web Services 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 Amazon Web Services infrastructure you want to deploy the network functions on.

Link to this function

validate_sol_function_package_content(client, vnf_pkg_id, input, options \\ [])

View Source

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.

Link to this function

validate_sol_network_package_content(client, nsd_info_id, input, options \\ [])

View Source

Validates network package content.

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

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.