TelcoNetworkBuilder / Client / list_sol_function_packages

list_sol_function_packages#

TelcoNetworkBuilder.Client.list_sol_function_packages(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_sol_function_packages(
    maxResults=123,
    nextToken='string'
)

Parameters:

maxResults (integer) – The maximum number of results to include in the response.
nextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- functionPackages (list) –
  
  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.
  - (dict) –
    
    Information about 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.
    - arn (string) –
      
      Function package ARN.
    - id (string) –
      
      ID of the function package.
    - metadata (dict) –
      
      The metadata of the function package.
      - createdAt (datetime) –
        
        The date that the resource was created.
      - lastModified (datetime) –
        
        The date that the resource was last modified.
    - onboardingState (string) –
      
      Onboarding state of the function package.
    - operationalState (string) –
      
      Operational state of the function package.
    - usageState (string) –
      
      Usage state of the function package.
    - vnfProductName (string) –
      
      The product name for the network function.
    - vnfProvider (string) –
      
      Provider of the function package and the function package descriptor.
    - vnfdId (string) –
      
      Identifies the function package and the function package descriptor.
    - vnfdVersion (string) –
      
      Identifies the version of the function package descriptor.
- nextToken (string) –
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

TelcoNetworkBuilder.Client.exceptions.InternalServerException
TelcoNetworkBuilder.Client.exceptions.ThrottlingException
TelcoNetworkBuilder.Client.exceptions.ValidationException
TelcoNetworkBuilder.Client.exceptions.AccessDeniedException