get_network

Private5G.Client.get_network(**kwargs)

Gets the specified network.

See also: AWS API Documentation

Request Syntax

response = client.get_network(
    networkArn='string'
)
Parameters
networkArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the network.

Return type
dict
Returns
Response Syntax
{
    'network': {
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'networkArn': 'string',
        'networkName': 'string',
        'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
        'statusReason': 'string'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • network (dict) --

      Information about the 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.

    • tags (dict) --

      The network tags.

      • (string) --
        • (string) --

Exceptions

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