WickrAdminAPI / Client / update_network

update_network

WickrAdminAPI.Client.update_network(**kwargs)

Updates the properties of an existing Wickr network, such as its name or encryption key configuration.

See also: AWS API Documentation

Request Syntax

response = client.update_network(
    networkId='string',
    networkName='string',
    clientToken='string',
    encryptionKeyArn='string'
)
Parameters:

  • networkId (string) –

    [REQUIRED]

    The ID of the Wickr network to update.

  • networkName (string) –

    [REQUIRED]

    The new name for the network. Must be between 1 and 20 characters.

  • clientToken (string) –

    A unique identifier for this request to ensure idempotency.

    This field is autopopulated if not provided.

  • 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

{
    'message': 'string'
}

Response Structure

  • (dict) –

    • message (string) –

      A message indicating that the network was updated successfully.

Exceptions