telconetworkbuilder function

AWS Telco Network Builder

AWS Telco Network Builder

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.

telconetworkbuilder( config = list(), credentials = list(), endpoint = NULL, region = NULL )

Arguments

  • config: Optional configuration of credentials, endpoint, and/or region.

    • credentials :

      • creds :

        • access_key_id : AWS access key ID
        • secret_access_key : AWS secret access key
        • session_token : AWS temporary session token
      • profile : The name of a profile to use. If not given, then the default profile is used.

      • anonymous : Set anonymous credentials.

    • endpoint : The complete URL to use for the constructed client.

    • region : The AWS Region used in instantiating the client.

    • close_connection : Immediately close all HTTP connections.

    • timeout : The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

    • s3_force_path_style : Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

    • sts_regional_endpoint : Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

  • credentials: Optional credentials shorthand for the config parameter

    • creds :

      • access_key_id : AWS access key ID
      • secret_access_key : AWS secret access key
      • session_token : AWS temporary session token
    • profile : The name of a profile to use. If not given, then the default profile is used.

    • anonymous : Set anonymous credentials.

  • endpoint: Optional shorthand for complete URL to use for the constructed client.

  • region: Optional shorthand for AWS Region used in instantiating the client.

Returns

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- telconetworkbuilder(
  config = list(
    credentials = list(
 creds = list(
   access_key_id = "string",
   secret_access_key = "string",
   session_token = "string"
 ),
 profile = "string",
 anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
 access_key_id = "string",
 secret_access_key = "string",
 session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

cancel_sol_network_operationCancels a network operation
create_sol_function_packageCreates a function package
create_sol_network_instanceCreates a network instance
create_sol_network_packageCreates a network package
delete_sol_function_packageDeletes a function package
delete_sol_network_instanceDeletes a network instance
delete_sol_network_packageDeletes network package
get_sol_function_instanceGets the details of a network function instance, including the instantiation state and metadata from the function package descriptor in the network function package
get_sol_function_packageGets the details of an individual function package, such as the operational state and whether the package is in use
get_sol_function_package_contentGets the contents of a function package
get_sol_function_package_descriptorGets a function package descriptor in a function package
get_sol_network_instanceGets the details of the network instance
get_sol_network_operationGets the details of a network operation, including the tasks involved in the network operation and the status of the tasks
get_sol_network_packageGets the details of a network package
get_sol_network_package_contentGets the contents of a network package
get_sol_network_package_descriptorGets the content of the network service descriptor
instantiate_sol_network_instanceInstantiates a network instance
list_sol_function_instancesLists network function instances
list_sol_function_packagesLists information about function packages
list_sol_network_instancesLists your network instances
list_sol_network_operationsLists details for a network operation, including when the operation started and the status of the operation
list_sol_network_packagesLists network packages
list_tags_for_resourceLists tags for AWS TNB resources
put_sol_function_package_contentUploads the contents of a function package
put_sol_network_package_contentUploads the contents of a network package
tag_resourceTags an AWS TNB resource
terminate_sol_network_instanceTerminates a network instance
untag_resourceUntags an AWS TNB resource
update_sol_function_packageUpdates the operational state of function package
update_sol_network_instanceUpdate a network instance
update_sol_network_packageUpdates the operational state of a network package
validate_sol_function_package_contentValidates function package content
validate_sol_network_package_contentValidates network package content

Examples

## Not run: svc <- telconetworkbuilder() svc$cancel_sol_network_operation( Foo = 123 ) ## End(Not run)
  • Maintainer: Dyfan Jones
  • License: Apache License (>= 2.0)
  • Last published: 2025-03-17