WickrAdminAPI / Client / create_network

create_network¶

WickrAdminAPI.Client.create_network(**kwargs)¶

Creates a new Wickr network with specified access level and configuration. This operation provisions a new communication network for your organization.

Request Syntax

response = client.create_network(
    networkName='string',
    accessLevel='STANDARD'|'PREMIUM',
    enablePremiumFreeTrial=True|False,
    encryptionKeyArn='string'
)

Parameters:

networkName (string) –
[REQUIRED]

The name for the new network. Must be between 1 and 20 characters.
accessLevel (string) –
[REQUIRED]

The access level for the network. Valid values are STANDARD or PREMIUM, which determine the features and capabilities available to network members.
enablePremiumFreeTrial (boolean) – Specifies whether to enable a premium free trial for the network. It is optional and has a default value as false. When set to true, the network starts with premium features for a limited trial period.
encryptionKeyArn (string) – The ARN of the Amazon Web Services KMS customer managed key to use for encrypting sensitive data in the network.

Return type:

dict

Returns:

Response Syntax

{
    'networkId': 'string',
    'networkName': 'string',
    'encryptionKeyArn': 'string'
}

Response Structure

(dict) –
- networkId (string) –
  
  The unique identifier assigned to the newly created network.
- networkName (string) –
  
  The name of the newly created network.
- encryptionKeyArn (string) –
  
  The ARN of the KMS key being used to encrypt sensitive data in the network.

Exceptions

WickrAdminAPI.Client.exceptions.ValidationError
WickrAdminAPI.Client.exceptions.BadRequestError
WickrAdminAPI.Client.exceptions.ResourceNotFoundError
WickrAdminAPI.Client.exceptions.ForbiddenError
WickrAdminAPI.Client.exceptions.UnauthorizedError
WickrAdminAPI.Client.exceptions.InternalServerError
WickrAdminAPI.Client.exceptions.RateLimitError