Class: Aws::Tnb::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Tnb::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Tnb::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



471
472
473
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 471

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.

Examples:

Request syntax with placeholder values


resp = client.cancel_sol_network_operation({
  ns_lcm_op_occ_id: "NsLcmOpOccId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ns_lcm_op_occ_id (required, String) —

    The identifier of the network operation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



497
498
499
500
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 497

def cancel_sol_network_operation(params = {}, options = {})
  req = build_request(:cancel_sol_network_operation, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.create_sol_function_package({
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.onboarding_state #=> String, one of "CREATED", "ONBOARDED", "ERROR"
resp.operational_state #=> String, one of "ENABLED", "DISABLED"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.usage_state #=> String, one of "IN_USE", "NOT_IN_USE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :tags (Hash<String,String>) —

    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.

Returns:

See Also:



559
560
561
562
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 559

def create_sol_function_package(params = {}, options = {})
  req = build_request(:create_sol_function_package, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.create_sol_network_instance({
  ns_description: "CreateSolNetworkInstanceInputNsDescriptionString",
  ns_name: "CreateSolNetworkInstanceInputNsNameString", # required
  nsd_info_id: "NsdInfoId", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.ns_instance_name #=> String
resp.nsd_info_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ns_description (String) —

    Network instance description.

  • :ns_name (required, String) —

    Network instance name.

  • :nsd_info_id (required, String) —

    ID for network service descriptor.

  • :tags (Hash<String,String>) —

    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.

Returns:

See Also:



628
629
630
631
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 628

def create_sol_network_instance(params = {}, options = {})
  req = build_request(:create_sol_network_instance, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.create_sol_network_package({
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.nsd_onboarding_state #=> String, one of "CREATED", "ONBOARDED", "ERROR"
resp.nsd_operational_state #=> String, one of "ENABLED", "DISABLED"
resp.nsd_usage_state #=> String, one of "IN_USE", "NOT_IN_USE"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :tags (Hash<String,String>) —

    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.

Returns:

See Also:



694
695
696
697
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 694

def create_sol_network_package(params = {}, options = {})
  req = build_request(:create_sol_network_package, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_sol_function_package({
  vnf_pkg_id: "VnfPkgId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vnf_pkg_id (required, String) —

    ID of the function package.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



729
730
731
732
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 729

def delete_sol_function_package(params = {}, options = {})
  req = build_request(:delete_sol_function_package, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_sol_network_instance({
  ns_instance_id: "NsInstanceId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ns_instance_id (required, String) —

    Network instance ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



763
764
765
766
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 763

def delete_sol_network_instance(params = {}, options = {})
  req = build_request(:delete_sol_network_instance, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_sol_network_package({
  nsd_info_id: "NsdInfoId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :nsd_info_id (required, String) —

    ID of the network service descriptor in the network package.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



796
797
798
799
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 796

def delete_sol_network_package(params = {}, options = {})
  req = build_request(:delete_sol_network_package, params)
  req.send_request(options)
end

#get_sol_function_instance(params = {}) ⇒ Types::GetSolFunctionInstanceOutput

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 .

Examples:

Request syntax with placeholder values


resp = client.get_sol_function_instance({
  vnf_instance_id: "VnfInstanceId", # required
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.instantiated_vnf_info.vnf_state #=> String, one of "STARTED", "STOPPED"
resp.instantiated_vnf_info.vnfc_resource_info #=> Array
resp.instantiated_vnf_info.vnfc_resource_info[0].metadata.cluster #=> String
resp.instantiated_vnf_info.vnfc_resource_info[0].metadata.helm_chart #=> String
resp.instantiated_vnf_info.vnfc_resource_info[0].metadata.node_group #=> String
resp.instantiation_state #=> String, one of "INSTANTIATED", "NOT_INSTANTIATED"
resp.metadata.created_at #=> Time
resp.metadata.last_modified #=> Time
resp.ns_instance_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.vnf_pkg_id #=> String
resp.vnf_product_name #=> String
resp.vnf_provider #=> String
resp.vnfd_id #=> String
resp.vnfd_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vnf_instance_id (required, String) —

    ID of the network function.

Returns:

See Also:



856
857
858
859
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 856

def get_sol_function_instance(params = {}, options = {})
  req = build_request(:get_sol_function_instance, params)
  req.send_request(options)
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..

Examples:

Request syntax with placeholder values


resp = client.get_sol_function_package({
  vnf_pkg_id: "VnfPkgId", # required
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.metadata.created_at #=> Time
resp.metadata.last_modified #=> Time
resp.metadata.vnfd.overrides #=> Array
resp.metadata.vnfd.overrides[0].default_value #=> String
resp.metadata.vnfd.overrides[0].name #=> String
resp.onboarding_state #=> String, one of "CREATED", "ONBOARDED", "ERROR"
resp.operational_state #=> String, one of "ENABLED", "DISABLED"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.usage_state #=> String, one of "IN_USE", "NOT_IN_USE"
resp.vnf_product_name #=> String
resp.vnf_provider #=> String
resp.vnfd_id #=> String
resp.vnfd_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vnf_pkg_id (required, String) —

    ID of the function package.

Returns:

See Also:



916
917
918
919
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 916

def get_sol_function_package(params = {}, options = {})
  req = build_request(:get_sol_function_package, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.get_sol_function_package_content({
  accept: "application/zip", # required, accepts application/zip
  vnf_pkg_id: "VnfPkgId", # required
})

Response structure


resp.content_type #=> String, one of "application/zip"
resp.package_content #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :accept (required, String) —

    The format of the package that you want to download from the function packages.

  • :vnf_pkg_id (required, String) —

    ID of the function package.

Returns:

See Also:



957
958
959
960
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 957

def get_sol_function_package_content(params = {}, options = {})
  req = build_request(:get_sol_function_package_content, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.get_sol_function_package_descriptor({
  accept: "text/plain", # required, accepts text/plain
  vnf_pkg_id: "VnfPkgId", # required
})

Response structure


resp.content_type #=> String, one of "text/plain"
resp.vnfd #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :accept (required, String) —

    Indicates which content types, expressed as MIME types, the client is able to understand.

  • :vnf_pkg_id (required, String) —

    ID of the function package.

Returns:

See Also:



1002
1003
1004
1005
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1002

def get_sol_function_package_descriptor(params = {}, options = {})
  req = build_request(:get_sol_function_package_descriptor, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.get_sol_network_instance({
  ns_instance_id: "NsInstanceId", # required
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.lcm_op_info.ns_lcm_op_occ_id #=> String
resp.metadata.created_at #=> Time
resp.metadata.last_modified #=> Time
resp.ns_instance_description #=> String
resp.ns_instance_name #=> String
resp.ns_state #=> String, one of "INSTANTIATED", "NOT_INSTANTIATED", "UPDATED", "IMPAIRED", "UPDATE_FAILED", "STOPPED", "DELETED", "INSTANTIATE_IN_PROGRESS", "INTENT_TO_UPDATE_IN_PROGRESS", "UPDATE_IN_PROGRESS", "TERMINATE_IN_PROGRESS"
resp.nsd_id #=> String
resp.nsd_info_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ns_instance_id (required, String) —

    ID of the network instance.

Returns:

See Also:



1054
1055
1056
1057
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1054

def get_sol_network_instance(params = {}, options = {})
  req = build_request(:get_sol_network_instance, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.get_sol_network_operation({
  ns_lcm_op_occ_id: "NsLcmOpOccId", # required
})

Response structure


resp.arn #=> String
resp.error.detail #=> String
resp.error.title #=> String
resp.id #=> String
resp.lcm_operation_type #=> String, one of "INSTANTIATE", "UPDATE", "TERMINATE"
resp.metadata.created_at #=> Time
resp.metadata.instantiate_metadata.nsd_info_id #=> String
resp.metadata.last_modified #=> Time
resp.metadata.modify_vnf_info_metadata.vnf_instance_id #=> String
resp.metadata.update_ns_metadata.nsd_info_id #=> String
resp.ns_instance_id #=> String
resp.operation_state #=> String, one of "PROCESSING", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED"
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.tasks #=> Array
resp.tasks[0].task_context #=> Hash
resp.tasks[0].task_context["String"] #=> String
resp.tasks[0].task_end_time #=> Time
resp.tasks[0].task_error_details.cause #=> String
resp.tasks[0].task_error_details.details #=> String
resp.tasks[0].task_name #=> String
resp.tasks[0].task_start_time #=> Time
resp.tasks[0].task_status #=> String, one of "SCHEDULED", "STARTED", "IN_PROGRESS", "COMPLETED", "ERROR", "SKIPPED", "CANCELLED"
resp.update_type #=> String, one of "MODIFY_VNF_INFORMATION", "UPDATE_NS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ns_lcm_op_occ_id (required, String) —

    The identifier of the network operation.

Returns:

See Also:



1118
1119
1120
1121
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1118

def get_sol_network_operation(params = {}, options = {})
  req = build_request(:get_sol_network_operation, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.get_sol_network_package({
  nsd_info_id: "NsdInfoId", # required
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.metadata.created_at #=> Time
resp.metadata.last_modified #=> Time
resp.metadata.nsd.overrides #=> Array
resp.metadata.nsd.overrides[0].default_value #=> String
resp.metadata.nsd.overrides[0].name #=> String
resp.nsd_id #=> String
resp.nsd_name #=> String
resp.nsd_onboarding_state #=> String, one of "CREATED", "ONBOARDED", "ERROR"
resp.nsd_operational_state #=> String, one of "ENABLED", "DISABLED"
resp.nsd_usage_state #=> String, one of "IN_USE", "NOT_IN_USE"
resp.nsd_version #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.vnf_pkg_ids #=> Array
resp.vnf_pkg_ids[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :nsd_info_id (required, String) —

    ID of the network service descriptor in the network package.

Returns:

See Also:



1176
1177
1178
1179
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1176

def get_sol_network_package(params = {}, options = {})
  req = build_request(:get_sol_network_package, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.get_sol_network_package_content({
  accept: "application/zip", # required, accepts application/zip
  nsd_info_id: "NsdInfoId", # required
})

Response structure


resp.content_type #=> String, one of "application/zip"
resp.nsd_content #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :accept (required, String) —

    The format of the package you want to download from the network package.

  • :nsd_info_id (required, String) —

    ID of the network service descriptor in the network package.

Returns:

See Also:



1215
1216
1217
1218
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1215

def get_sol_network_package_content(params = {}, options = {})
  req = build_request(:get_sol_network_package_content, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.get_sol_network_package_descriptor({
  nsd_info_id: "NsdInfoId", # required
})

Response structure


resp.content_type #=> String, one of "text/plain"
resp.nsd #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :nsd_info_id (required, String) —

    ID of the network service descriptor in the network package.

Returns:

See Also:



1250
1251
1252
1253
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1250

def get_sol_network_package_descriptor(params = {}, options = {})
  req = build_request(:get_sol_network_package_descriptor, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.instantiate_sol_network_instance({
  additional_params_for_ns: {
  },
  dry_run: false,
  ns_instance_id: "NsInstanceId", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.ns_lcm_op_occ_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :additional_params_for_ns (Hash, Array, String, Numeric, Boolean) —

    Provides values for the configurable properties.

    Document type used to carry open content (Hash,Array,String,Numeric,Boolean). A document type value is serialized using the same format as its surroundings and requires no additional encoding or escaping.

  • :dry_run (Boolean) —

    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.

  • :ns_instance_id (required, String) —

    ID of the network instance.

  • :tags (Hash<String,String>) —

    A tag is a label that you assign to an Amazon Web Services 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 Amazon Web Services costs.

Returns:

See Also:



1321
1322
1323
1324
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1321

def instantiate_sol_network_instance(params = {}, options = {})
  req = build_request(:instantiate_sol_network_instance, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_sol_function_instances({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.function_instances #=> Array
resp.function_instances[0].arn #=> String
resp.function_instances[0].id #=> String
resp.function_instances[0].instantiated_vnf_info.vnf_state #=> String, one of "STARTED", "STOPPED"
resp.function_instances[0].instantiation_state #=> String, one of "INSTANTIATED", "NOT_INSTANTIATED"
resp.function_instances[0].metadata.created_at #=> Time
resp.function_instances[0].metadata.last_modified #=> Time
resp.function_instances[0].ns_instance_id #=> String
resp.function_instances[0].vnf_pkg_id #=> String
resp.function_instances[0].vnf_pkg_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to include in the response.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



1368
1369
1370
1371
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1368

def list_sol_function_instances(params = {}, options = {})
  req = build_request(:list_sol_function_instances, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_sol_function_packages({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.function_packages #=> Array
resp.function_packages[0].arn #=> String
resp.function_packages[0].id #=> String
resp.function_packages[0].metadata.created_at #=> Time
resp.function_packages[0].metadata.last_modified #=> Time
resp.function_packages[0].onboarding_state #=> String, one of "CREATED", "ONBOARDED", "ERROR"
resp.function_packages[0].operational_state #=> String, one of "ENABLED", "DISABLED"
resp.function_packages[0].usage_state #=> String, one of "IN_USE", "NOT_IN_USE"
resp.function_packages[0].vnf_product_name #=> String
resp.function_packages[0].vnf_provider #=> String
resp.function_packages[0].vnfd_id #=> String
resp.function_packages[0].vnfd_version #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to include in the response.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



1421
1422
1423
1424
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1421

def list_sol_function_packages(params = {}, options = {})
  req = build_request(:list_sol_function_packages, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_sol_network_instances({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.network_instances #=> Array
resp.network_instances[0].arn #=> String
resp.network_instances[0].id #=> String
resp.network_instances[0].metadata.created_at #=> Time
resp.network_instances[0].metadata.last_modified #=> Time
resp.network_instances[0].ns_instance_description #=> String
resp.network_instances[0].ns_instance_name #=> String
resp.network_instances[0].ns_state #=> String, one of "INSTANTIATED", "NOT_INSTANTIATED", "UPDATED", "IMPAIRED", "UPDATE_FAILED", "STOPPED", "DELETED", "INSTANTIATE_IN_PROGRESS", "INTENT_TO_UPDATE_IN_PROGRESS", "UPDATE_IN_PROGRESS", "TERMINATE_IN_PROGRESS"
resp.network_instances[0].nsd_id #=> String
resp.network_instances[0].nsd_info_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to include in the response.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



1470
1471
1472
1473
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1470

def list_sol_network_instances(params = {}, options = {})
  req = build_request(:list_sol_network_instances, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_sol_network_operations({
  max_results: 1,
  next_token: "PaginationToken",
  ns_instance_id: "NsInstanceId",
})

Response structure


resp.network_operations #=> Array
resp.network_operations[0].arn #=> String
resp.network_operations[0].error.detail #=> String
resp.network_operations[0].error.title #=> String
resp.network_operations[0].id #=> String
resp.network_operations[0].lcm_operation_type #=> String, one of "INSTANTIATE", "UPDATE", "TERMINATE"
resp.network_operations[0].metadata.created_at #=> Time
resp.network_operations[0].metadata.last_modified #=> Time
resp.network_operations[0].metadata.nsd_info_id #=> String
resp.network_operations[0].metadata.vnf_instance_id #=> String
resp.network_operations[0].ns_instance_id #=> String
resp.network_operations[0].operation_state #=> String, one of "PROCESSING", "COMPLETED", "FAILED", "CANCELLING", "CANCELLED"
resp.network_operations[0].update_type #=> String, one of "MODIFY_VNF_INFORMATION", "UPDATE_NS"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to include in the response.

  • :next_token (String) —

    The token for the next page of results.

  • :ns_instance_id (String) —

    Network instance id filter, to retrieve network operations associated to a network instance.

Returns:

See Also:



1527
1528
1529
1530
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1527

def list_sol_network_operations(params = {}, options = {})
  req = build_request(:list_sol_network_operations, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_sol_network_packages({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.network_packages #=> Array
resp.network_packages[0].arn #=> String
resp.network_packages[0].id #=> String
resp.network_packages[0].metadata.created_at #=> Time
resp.network_packages[0].metadata.last_modified #=> Time
resp.network_packages[0].nsd_designer #=> String
resp.network_packages[0].nsd_id #=> String
resp.network_packages[0].nsd_invariant_id #=> String
resp.network_packages[0].nsd_name #=> String
resp.network_packages[0].nsd_onboarding_state #=> String, one of "CREATED", "ONBOARDED", "ERROR"
resp.network_packages[0].nsd_operational_state #=> String, one of "ENABLED", "DISABLED"
resp.network_packages[0].nsd_usage_state #=> String, one of "IN_USE", "NOT_IN_USE"
resp.network_packages[0].nsd_version #=> String
resp.network_packages[0].vnf_pkg_ids #=> Array
resp.network_packages[0].vnf_pkg_ids[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to include in the response.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



1581
1582
1583
1584
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1581

def list_sol_network_packages(params = {}, options = {})
  req = build_request(:list_sol_network_packages, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput

Lists tags for AWS TNB resources.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "TNBResourceArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Resource ARN.

Returns:

See Also:



1610
1611
1612
1613
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1610

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.put_sol_function_package_content({
  content_type: "application/zip", # accepts application/zip
  file: "data", # required
  vnf_pkg_id: "VnfPkgId", # required
})

Response structure


resp.id #=> String
resp.metadata.vnfd.overrides #=> Array
resp.metadata.vnfd.overrides[0].default_value #=> String
resp.metadata.vnfd.overrides[0].name #=> String
resp.vnf_product_name #=> String
resp.vnf_provider #=> String
resp.vnfd_id #=> String
resp.vnfd_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content_type (String) —

    Function package content type.

  • :file (required, String, StringIO, File) —

    Function package file.

  • :vnf_pkg_id (required, String) —

    Function package ID.

Returns:

See Also:



1664
1665
1666
1667
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1664

def put_sol_function_package_content(params = {}, options = {})
  req = build_request(:put_sol_function_package_content, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.put_sol_network_package_content({
  content_type: "application/zip", # accepts application/zip
  file: "data", # required
  nsd_info_id: "NsdInfoId", # required
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.metadata.nsd.overrides #=> Array
resp.metadata.nsd.overrides[0].default_value #=> String
resp.metadata.nsd.overrides[0].name #=> String
resp.nsd_id #=> String
resp.nsd_name #=> String
resp.nsd_version #=> String
resp.vnf_pkg_ids #=> Array
resp.vnf_pkg_ids[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content_type (String) —

    Network package content type.

  • :file (required, String, StringIO, File) —

    Network package file.

  • :nsd_info_id (required, String) —

    Network service descriptor info ID.

Returns:

See Also:



1719
1720
1721
1722
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1719

def put_sol_network_package_content(params = {}, options = {})
  req = build_request(:put_sol_network_package_content, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "TNBResourceArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Resource ARN.

  • :tags (required, Hash<String,String>) —

    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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1755
1756
1757
1758
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1755

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.terminate_sol_network_instance({
  ns_instance_id: "NsInstanceId", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.ns_lcm_op_occ_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ns_instance_id (required, String) —

    ID of the network instance.

  • :tags (Hash<String,String>) —

    A tag is a label that you assign to an Amazon Web Services 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 Amazon Web Services costs.

Returns:

See Also:



1803
1804
1805
1806
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1803

def terminate_sol_network_instance(params = {}, options = {})
  req = build_request(:terminate_sol_network_instance, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "TNBResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Resource ARN.

  • :tag_keys (required, Array<String>) —

    Tag keys.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1834
1835
1836
1837
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1834

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.update_sol_function_package({
  operational_state: "ENABLED", # required, accepts ENABLED, DISABLED
  vnf_pkg_id: "VnfPkgId", # required
})

Response structure


resp.operational_state #=> String, one of "ENABLED", "DISABLED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :operational_state (required, String) —

    Operational state of the function package.

  • :vnf_pkg_id (required, String) —

    ID of the function package.

Returns:

See Also:



1872
1873
1874
1875
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1872

def update_sol_function_package(params = {}, options = {})
  req = build_request(:update_sol_function_package, params)
  req.send_request(options)
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.

Choose the updateType parameter to target the necessary update of the network instance.

Examples:

Request syntax with placeholder values


resp = client.update_sol_network_instance({
  modify_vnf_info_data: {
    vnf_configurable_properties: { # required
    },
    vnf_instance_id: "VnfInstanceId", # required
  },
  ns_instance_id: "NsInstanceId", # required
  tags: {
    "TagKey" => "TagValue",
  },
  update_ns: {
    additional_params_for_ns: {
    },
    nsd_info_id: "NsdInfoId", # required
  },
  update_type: "MODIFY_VNF_INFORMATION", # required, accepts MODIFY_VNF_INFORMATION, UPDATE_NS
})

Response structure


resp.ns_lcm_op_occ_id #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :modify_vnf_info_data (Types::UpdateSolNetworkModify) —

    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.

  • :ns_instance_id (required, String) —

    ID of the network instance.

  • :tags (Hash<String,String>) —

    A tag is a label that you assign to an Amazon Web Services 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 Amazon Web Services costs.

  • :update_ns (Types::UpdateSolNetworkServiceData) —

    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.

  • :update_type (required, String) —

    The type of update.

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

Returns:

See Also:



1954
1955
1956
1957
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1954

def update_sol_network_instance(params = {}, options = {})
  req = build_request(:update_sol_network_instance, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.update_sol_network_package({
  nsd_info_id: "NsdInfoId", # required
  nsd_operational_state: "ENABLED", # required, accepts ENABLED, DISABLED
})

Response structure


resp.nsd_operational_state #=> String, one of "ENABLED", "DISABLED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :nsd_info_id (required, String) —

    ID of the network service descriptor in the network package.

  • :nsd_operational_state (required, String) —

    Operational state of the network service descriptor in the network package.

Returns:

See Also:



1996
1997
1998
1999
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 1996

def update_sol_network_package(params = {}, options = {})
  req = build_request(:update_sol_network_package, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.validate_sol_function_package_content({
  content_type: "application/zip", # accepts application/zip
  file: "data", # required
  vnf_pkg_id: "VnfPkgId", # required
})

Response structure


resp.id #=> String
resp.metadata.vnfd.overrides #=> Array
resp.metadata.vnfd.overrides[0].default_value #=> String
resp.metadata.vnfd.overrides[0].name #=> String
resp.vnf_product_name #=> String
resp.vnf_provider #=> String
resp.vnfd_id #=> String
resp.vnfd_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content_type (String) —

    Function package content type.

  • :file (required, String, StringIO, File) —

    Function package file.

  • :vnf_pkg_id (required, String) —

    Function package ID.

Returns:

See Also:



2056
2057
2058
2059
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 2056

def validate_sol_function_package_content(params = {}, options = {})
  req = build_request(:validate_sol_function_package_content, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.validate_sol_network_package_content({
  content_type: "application/zip", # accepts application/zip
  file: "data", # required
  nsd_info_id: "NsdInfoId", # required
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.metadata.nsd.overrides #=> Array
resp.metadata.nsd.overrides[0].default_value #=> String
resp.metadata.nsd.overrides[0].name #=> String
resp.nsd_id #=> String
resp.nsd_name #=> String
resp.nsd_version #=> String
resp.vnf_pkg_ids #=> Array
resp.vnf_pkg_ids[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content_type (String) —

    Network package content type.

  • :file (required, String, StringIO, File) —

    Network package file.

  • :nsd_info_id (required, String) —

    Network service descriptor file.

Returns:

See Also:



2117
2118
2119
2120
 
# File 'gems/aws-sdk-tnb/lib/aws-sdk-tnb/client.rb', line 2117

def validate_sol_network_package_content(params = {}, options = {})
  req = build_request(:validate_sol_network_package_content, params)
  req.send_request(options)
end