TelcoNetworkBuilder / Client / get_sol_function_package

get_sol_function_package#

TelcoNetworkBuilder.Client.get_sol_function_package(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.get_sol_function_package(
    vnfPkgId='string'
)
Parameters:

vnfPkgId (string) –

[REQUIRED]

ID of the function package.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'metadata': {
        'createdAt': datetime(2015, 1, 1),
        'lastModified': datetime(2015, 1, 1),
        'vnfd': {
            'overrides': [
                {
                    'defaultValue': 'string',
                    'name': 'string'
                },
            ]
        }
    },
    'onboardingState': 'CREATED'|'ONBOARDED'|'ERROR',
    'operationalState': 'ENABLED'|'DISABLED',
    'tags': {
        'string': 'string'
    },
    'usageState': 'IN_USE'|'NOT_IN_USE',
    'vnfProductName': 'string',
    'vnfProvider': 'string',
    'vnfdId': 'string',
    'vnfdVersion': 'string'
}

Response Structure

  • (dict) –

    • arn (string) –

      Function package ARN.

    • id (string) –

      Function package ID.

    • metadata (dict) –

      Metadata related to the 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.

      • createdAt (datetime) –

        The date that the resource was created.

      • lastModified (datetime) –

        The date that the resource was last modified.

      • vnfd (dict) –

        Metadata related to the function package descriptor of the function package.

        • overrides (list) –

          Lists of function package overrides.

          • (dict) –

            Overrides of the TOSCA node.

            • defaultValue (string) –

              Default value for the override.

            • name (string) –

              Name of the TOSCA override.

    • onboardingState (string) –

      Function package onboarding state.

    • operationalState (string) –

      Function package operational state.

    • 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) –

    • usageState (string) –

      Function package usage state.

    • vnfProductName (string) –

      Network function product name.

    • vnfProvider (string) –

      Network function provider.

    • vnfdId (string) –

      Function package descriptor ID.

    • vnfdVersion (string) –

      Function package descriptor version.

Exceptions