Class: Aws::Tnb::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Tnb::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb
Overview
An API client for Tnb. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Tnb::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#cancel_sol_network_operation(params = {}) ⇒ Struct
Cancels a network operation.
-
#create_sol_function_package(params = {}) ⇒ Types::CreateSolFunctionPackageOutput
Creates a function package.
-
#create_sol_network_instance(params = {}) ⇒ Types::CreateSolNetworkInstanceOutput
Creates a network instance.
-
#create_sol_network_package(params = {}) ⇒ Types::CreateSolNetworkPackageOutput
Creates a network package.
-
#delete_sol_function_package(params = {}) ⇒ Struct
Deletes a function package.
-
#delete_sol_network_instance(params = {}) ⇒ Struct
Deletes a network instance.
-
#delete_sol_network_package(params = {}) ⇒ Struct
Deletes network package.
-
#get_sol_function_instance(params = {}) ⇒ Types::GetSolFunctionInstanceOutput
Gets the details of a network function instance, including the instantation state and metadata from the function package descriptor in the network function package.
-
#get_sol_function_package(params = {}) ⇒ Types::GetSolFunctionPackageOutput
Gets the details of an individual function package, such as the operational state and whether the package is in use.
-
#get_sol_function_package_content(params = {}) ⇒ Types::GetSolFunctionPackageContentOutput
Gets the contents of a function package.
-
#get_sol_function_package_descriptor(params = {}) ⇒ Types::GetSolFunctionPackageDescriptorOutput
Gets a function package descriptor in a function package.
-
#get_sol_network_instance(params = {}) ⇒ Types::GetSolNetworkInstanceOutput
Gets the details of the network instance.
-
#get_sol_network_operation(params = {}) ⇒ Types::GetSolNetworkOperationOutput
Gets the details of a network operation, including the tasks involved in the network operation and the status of the tasks.
-
#get_sol_network_package(params = {}) ⇒ Types::GetSolNetworkPackageOutput
Gets the details of a network package.
-
#get_sol_network_package_content(params = {}) ⇒ Types::GetSolNetworkPackageContentOutput
Gets the contents of a network package.
-
#get_sol_network_package_descriptor(params = {}) ⇒ Types::GetSolNetworkPackageDescriptorOutput
Gets the content of the network service descriptor.
-
#instantiate_sol_network_instance(params = {}) ⇒ Types::InstantiateSolNetworkInstanceOutput
Instantiates a network instance.
-
#list_sol_function_instances(params = {}) ⇒ Types::ListSolFunctionInstancesOutput
Lists network function instances.
-
#list_sol_function_packages(params = {}) ⇒ Types::ListSolFunctionPackagesOutput
Lists information about function packages.
-
#list_sol_network_instances(params = {}) ⇒ Types::ListSolNetworkInstancesOutput
Lists your network instances.
-
#list_sol_network_operations(params = {}) ⇒ Types::ListSolNetworkOperationsOutput
Lists details for a network operation, including when the operation started and the status of the operation.
-
#list_sol_network_packages(params = {}) ⇒ Types::ListSolNetworkPackagesOutput
Lists network packages.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists tags for AWS TNB resources.
-
#put_sol_function_package_content(params = {}) ⇒ Types::PutSolFunctionPackageContentOutput
Uploads the contents of a function package.
-
#put_sol_network_package_content(params = {}) ⇒ Types::PutSolNetworkPackageContentOutput
Uploads the contents of a network package.
-
#tag_resource(params = {}) ⇒ Struct
Tags an AWS TNB resource.
-
#terminate_sol_network_instance(params = {}) ⇒ Types::TerminateSolNetworkInstanceOutput
Terminates a network instance.
-
#untag_resource(params = {}) ⇒ Struct
Untags an AWS TNB resource.
-
#update_sol_function_package(params = {}) ⇒ Types::UpdateSolFunctionPackageOutput
Updates the operational state of function package.
-
#update_sol_network_instance(params = {}) ⇒ Types::UpdateSolNetworkInstanceOutput
Update a network instance.
-
#update_sol_network_package(params = {}) ⇒ Types::UpdateSolNetworkPackageOutput
Updates the operational state of a network package.
-
#validate_sol_function_package_content(params = {}) ⇒ Types::ValidateSolFunctionPackageContentOutput
Validates function package content.
-
#validate_sol_network_package_content(params = {}) ⇒ Types::ValidateSolNetworkPackageContentOutput
Validates network package content.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#cancel_sol_network_operation(params = {}) ⇒ Struct
Cancels a network operation.
A network operation is any operation that is done to your network, such as network instance instantiation or termination.
436 437 438 439 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 436 def cancel_sol_network_operation(params = {}, = {}) req = build_request(:cancel_sol_network_operation, params) req.send_request() end |
#create_sol_function_package(params = {}) ⇒ Types::CreateSolFunctionPackageOutput
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.
498 499 500 501 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 498 def create_sol_function_package(params = {}, = {}) req = build_request(:create_sol_function_package, params) req.send_request() end |
#create_sol_network_instance(params = {}) ⇒ Types::CreateSolNetworkInstanceOutput
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.
567 568 569 570 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 567 def create_sol_network_instance(params = {}, = {}) req = build_request(:create_sol_network_instance, params) req.send_request() end |
#create_sol_network_package(params = {}) ⇒ Types::CreateSolNetworkPackageOutput
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.
633 634 635 636 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 633 def create_sol_network_package(params = {}, = {}) req = build_request(:create_sol_network_package, params) req.send_request() end |
#delete_sol_function_package(params = {}) ⇒ Struct
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.
668 669 670 671 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 668 def delete_sol_function_package(params = {}, = {}) req = build_request(:delete_sol_function_package, params) req.send_request() end |
#delete_sol_network_instance(params = {}) ⇒ Struct
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.
702 703 704 705 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 702 def delete_sol_network_instance(params = {}, = {}) req = build_request(:delete_sol_network_instance, params) req.send_request() end |
#delete_sol_network_package(params = {}) ⇒ Struct
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.
735 736 737 738 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 735 def delete_sol_network_package(params = {}, = {}) req = build_request(:delete_sol_network_package, params) req.send_request() end |
#get_sol_function_instance(params = {}) ⇒ Types::GetSolFunctionInstanceOutput
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 .
795 796 797 798 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 795 def get_sol_function_instance(params = {}, = {}) req = build_request(:get_sol_function_instance, params) req.send_request() end |
#get_sol_function_package(params = {}) ⇒ Types::GetSolFunctionPackageOutput
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..
855 856 857 858 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 855 def get_sol_function_package(params = {}, = {}) req = build_request(:get_sol_function_package, params) req.send_request() end |
#get_sol_function_package_content(params = {}) ⇒ Types::GetSolFunctionPackageContentOutput
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.
896 897 898 899 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 896 def get_sol_function_package_content(params = {}, = {}) req = build_request(:get_sol_function_package_content, params) req.send_request() end |
#get_sol_function_package_descriptor(params = {}) ⇒ Types::GetSolFunctionPackageDescriptorOutput
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.
941 942 943 944 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 941 def get_sol_function_package_descriptor(params = {}, = {}) req = build_request(:get_sol_function_package_descriptor, params) req.send_request() end |
#get_sol_network_instance(params = {}) ⇒ Types::GetSolNetworkInstanceOutput
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.
993 994 995 996 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 993 def get_sol_network_instance(params = {}, = {}) req = build_request(:get_sol_network_instance, params) req.send_request() end |
#get_sol_network_operation(params = {}) ⇒ Types::GetSolNetworkOperationOutput
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.
1052 1053 1054 1055 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1052 def get_sol_network_operation(params = {}, = {}) req = build_request(:get_sol_network_operation, params) req.send_request() end |
#get_sol_network_package(params = {}) ⇒ Types::GetSolNetworkPackageOutput
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.
1110 1111 1112 1113 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1110 def get_sol_network_package(params = {}, = {}) req = build_request(:get_sol_network_package, params) req.send_request() end |
#get_sol_network_package_content(params = {}) ⇒ Types::GetSolNetworkPackageContentOutput
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.
1149 1150 1151 1152 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1149 def get_sol_network_package_content(params = {}, = {}) req = build_request(:get_sol_network_package_content, params) req.send_request() end |
#get_sol_network_package_descriptor(params = {}) ⇒ Types::GetSolNetworkPackageDescriptorOutput
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.
1184 1185 1186 1187 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1184 def get_sol_network_package_descriptor(params = {}, = {}) req = build_request(:get_sol_network_package_descriptor, params) req.send_request() end |
#instantiate_sol_network_instance(params = {}) ⇒ Types::InstantiateSolNetworkInstanceOutput
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.
1254 1255 1256 1257 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1254 def instantiate_sol_network_instance(params = {}, = {}) req = build_request(:instantiate_sol_network_instance, params) req.send_request() end |
#list_sol_function_instances(params = {}) ⇒ Types::ListSolFunctionInstancesOutput
Lists network function instances.
A network function instance is a function in a function package .
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1301 1302 1303 1304 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1301 def list_sol_function_instances(params = {}, = {}) req = build_request(:list_sol_function_instances, params) req.send_request() end |
#list_sol_function_packages(params = {}) ⇒ Types::ListSolFunctionPackagesOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1354 1355 1356 1357 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1354 def list_sol_function_packages(params = {}, = {}) req = build_request(:list_sol_function_packages, params) req.send_request() end |
#list_sol_network_instances(params = {}) ⇒ Types::ListSolNetworkInstancesOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1403 1404 1405 1406 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1403 def list_sol_network_instances(params = {}, = {}) req = build_request(:list_sol_network_instances, params) req.send_request() end |
#list_sol_network_operations(params = {}) ⇒ Types::ListSolNetworkOperationsOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1452 1453 1454 1455 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1452 def list_sol_network_operations(params = {}, = {}) req = build_request(:list_sol_network_operations, params) req.send_request() end |
#list_sol_network_packages(params = {}) ⇒ Types::ListSolNetworkPackagesOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1506 1507 1508 1509 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1506 def list_sol_network_packages(params = {}, = {}) req = build_request(:list_sol_network_packages, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists tags for AWS TNB resources.
1535 1536 1537 1538 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1535 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_sol_function_package_content(params = {}) ⇒ Types::PutSolFunctionPackageContentOutput
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.
1589 1590 1591 1592 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1589 def put_sol_function_package_content(params = {}, = {}) req = build_request(:put_sol_function_package_content, params) req.send_request() end |
#put_sol_network_package_content(params = {}) ⇒ Types::PutSolNetworkPackageContentOutput
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.
1644 1645 1646 1647 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1644 def put_sol_network_package_content(params = {}, = {}) req = build_request(:put_sol_network_package_content, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
1680 1681 1682 1683 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1680 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#terminate_sol_network_instance(params = {}) ⇒ Types::TerminateSolNetworkInstanceOutput
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.
1727 1728 1729 1730 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1727 def terminate_sol_network_instance(params = {}, = {}) req = build_request(:terminate_sol_network_instance, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
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.
1758 1759 1760 1761 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1758 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_sol_function_package(params = {}) ⇒ Types::UpdateSolFunctionPackageOutput
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.
1796 1797 1798 1799 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1796 def update_sol_function_package(params = {}, = {}) req = build_request(:update_sol_function_package, params) req.send_request() end |
#update_sol_network_instance(params = {}) ⇒ Types::UpdateSolNetworkInstanceOutput
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.
1854 1855 1856 1857 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1854 def update_sol_network_instance(params = {}, = {}) req = build_request(:update_sol_network_instance, params) req.send_request() end |
#update_sol_network_package(params = {}) ⇒ Types::UpdateSolNetworkPackageOutput
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.
1896 1897 1898 1899 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1896 def update_sol_network_package(params = {}, = {}) req = build_request(:update_sol_network_package, params) req.send_request() end |
#validate_sol_function_package_content(params = {}) ⇒ Types::ValidateSolFunctionPackageContentOutput
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.
1956 1957 1958 1959 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1956 def validate_sol_function_package_content(params = {}, = {}) req = build_request(:validate_sol_function_package_content, params) req.send_request() end |
#validate_sol_network_package_content(params = {}) ⇒ Types::ValidateSolNetworkPackageContentOutput
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.
2017 2018 2019 2020 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 2017 def validate_sol_network_package_content(params = {}, = {}) req = build_request(:validate_sol_network_package_content, params) req.send_request() end |