Private5G / Client / delete_network

delete_network#

Private5G.Client.delete_network(**kwargs)#

Deletes the specified network. You must delete network sites before you delete the network. For more information, see DeleteNetworkSite in the API Reference for Amazon Web Services Private 5G.

Request Syntax

response = client.delete_network(
    clientToken='string',
    networkArn='string'
)

Parameters:

clientToken (string) – Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
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'
    }
}

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.

Exceptions

Private5G.Client.exceptions.ResourceNotFoundException
Private5G.Client.exceptions.AccessDeniedException
Private5G.Client.exceptions.ValidationException
Private5G.Client.exceptions.InternalServerException