list_networks

Private5G.Client.list_networks(**kwargs)

Lists networks. Add filters to your request to return a more specific list of results. Use filters to match the status of the network.

See also: AWS API Documentation

Request Syntax

response = client.list_networks(
    filters={
        'string': [
            'string',
        ]
    },
    maxResults=123,
    startToken='string'
)

Parameters

• filters (dict) --

  The filters.

  • STATUS - The status ( AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING ).

  Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.

  • (string) --
    • (list) --
      • (string) --
• maxResults (integer) -- The maximum number of results to return.
• startToken (string) -- The token for the next page of results.

Return type

dict

Returns

Response Syntax

{
    'networks': [
        {
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'networkArn': 'string',
            'networkName': 'string',
            'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
            'statusReason': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • networks (list) --

    The networks.

    • (dict) --

      Information about a network.

      • createdAt (datetime) --

        The creation time of the network.

      • description (string) --

        The description of the network.

      • networkArn (string) --

        The Amazon Resource Name (ARN) of the network.

      • networkName (string) --

        The name of the network.

      • status (string) --

        The status of the network.

      • statusReason (string) --

        The status reason of the network.

  • nextToken (string) --

    The token for the next page of results.

Exceptions

• Private5G.Client.exceptions.ResourceNotFoundException
• Private5G.Client.exceptions.ValidationException
• Private5G.Client.exceptions.InternalServerException