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.
409 410 411 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 409 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.
435 436 437 438 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 435 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.
497 498 499 500 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 497 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.
566 567 568 569 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 566 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.
632 633 634 635 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 632 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.
667 668 669 670 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 667 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.
701 702 703 704 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 701 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.
734 735 736 737 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 734 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 .
794 795 796 797 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 794 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..
854 855 856 857 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 854 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.
895 896 897 898 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 895 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.
940 941 942 943 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 940 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.
992 993 994 995 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 992 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.
1051 1052 1053 1054 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1051 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.
1109 1110 1111 1112 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1109 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.
1148 1149 1150 1151 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1148 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.
1183 1184 1185 1186 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1183 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.
1253 1254 1255 1256 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1253 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.
1300 1301 1302 1303 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1300 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.
1353 1354 1355 1356 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1353 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.
1402 1403 1404 1405 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1402 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.
1451 1452 1453 1454 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1451 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.
1505 1506 1507 1508 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1505 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.
1534 1535 1536 1537 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1534 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.
1588 1589 1590 1591 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1588 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.
1643 1644 1645 1646 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1643 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.
1679 1680 1681 1682 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1679 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.
1726 1727 1728 1729 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1726 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.
1757 1758 1759 1760 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1757 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.
1795 1796 1797 1798 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1795 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.
1853 1854 1855 1856 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1853 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.
1895 1896 1897 1898 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1895 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.
1955 1956 1957 1958 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1955 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.
2016 2017 2018 2019 |
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 2016 def validate_sol_network_package_content(params = {}, = {}) req = build_request(:validate_sol_network_package_content, params) req.send_request() end |