TelcoNetworkBuilder / Client / get_sol_function_instance



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 .

See also: AWS API Documentation

Request Syntax

response = client.get_sol_function_instance(

vnfInstanceId (string) –


ID of the network function.

Return type:



Response Syntax

    'arn': 'string',
    'id': 'string',
    'instantiatedVnfInfo': {
        'vnfState': 'STARTED'|'STOPPED',
        'vnfcResourceInfo': [
                'metadata': {
                    'cluster': 'string',
                    'helmChart': 'string',
                    'nodeGroup': 'string'
    'instantiationState': 'INSTANTIATED'|'NOT_INSTANTIATED',
    'metadata': {
        'createdAt': datetime(2015, 1, 1),
        'lastModified': datetime(2015, 1, 1)
    'nsInstanceId': 'string',
    'tags': {
        'string': 'string'
    'vnfPkgId': 'string',
    'vnfProductName': 'string',
    'vnfProvider': 'string',
    'vnfdId': 'string',
    'vnfdVersion': 'string'

Response Structure

  • (dict) –

    • arn (string) –

      Network function instance ARN.

    • id (string) –

      Network function instance ID.

    • instantiatedVnfInfo (dict) –

      Information about the network function.

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

      • vnfState (string) –

        State of the network function instance.

      • vnfcResourceInfo (list) –

        Compute info used by the network function instance.

        • (dict) –

          Details of resource associated with a network function.

          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.

          • metadata (dict) –

            The metadata of the network function compute.

            • cluster (string) –

              Information about the cluster.

            • helmChart (string) –

              Information about the helm chart.

            • nodeGroup (string) –

              Information about the node group.

    • instantiationState (string) –

      Network function instantiation state.

    • metadata (dict) –

      The metadata of a network function instance.

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

      • createdAt (datetime) –

        The date that the resource was created.

      • lastModified (datetime) –

        The date that the resource was last modified.

    • nsInstanceId (string) –

      Network instance ID.

    • tags (dict) –

      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.

      • (string) –

        • (string) –

    • vnfPkgId (string) –

      Function package ID.

    • vnfProductName (string) –

      Network function product name.

    • vnfProvider (string) –

      Network function provider.

    • vnfdId (string) –

      Function package descriptor ID.

    • vnfdVersion (string) –

      Function package descriptor version.