TelcoNetworkBuilder / Client / list_sol_network_instances

list_sol_network_instances#

TelcoNetworkBuilder.Client.list_sol_network_instances(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_sol_network_instances(
    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

{
    'networkInstances': [
        {
            'arn': 'string',
            'id': 'string',
            'metadata': {
                'createdAt': datetime(2015, 1, 1),
                'lastModified': datetime(2015, 1, 1)
            },
            'nsInstanceDescription': 'string',
            'nsInstanceName': 'string',
            'nsState': 'INSTANTIATED'|'NOT_INSTANTIATED'|'IMPAIRED'|'STOPPED'|'DELETED'|'INSTANTIATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'TERMINATE_IN_PROGRESS',
            'nsdId': 'string',
            'nsdInfoId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • networkInstances (list) –

      Lists network instances.

      • (dict) –

        Info about the specific 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.

        • arn (string) –

          Network instance ARN.

        • id (string) –

          ID of the network instance.

        • metadata (dict) –

          The metadata of the network instance.

          • createdAt (datetime) –

            The date that the resource was created.

          • lastModified (datetime) –

            The date that the resource was last modified.

        • nsInstanceDescription (string) –

          Human-readable description of the network instance.

        • nsInstanceName (string) –

          Human-readable name of the network instance.

        • nsState (string) –

          The state of the network instance.

        • nsdId (string) –

          ID of the network service descriptor in the network package.

        • nsdInfoId (string) –

          ID of the network service descriptor in the network package.

    • 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