WickrAdminAPI / Client / update_data_retention

update_data_retention

WickrAdminAPI.Client.update_data_retention(**kwargs)

Updates the data retention bot settings, allowing you to enable or disable the data retention service, or acknowledge the public key message.

See also: AWS API Documentation

Request Syntax

response = client.update_data_retention(
    networkId='string',
    actionType='ENABLE'|'DISABLE'|'PUBKEY_MSG_ACK'
)
Parameters:

  • networkId (string) –

    [REQUIRED]

    The ID of the Wickr network containing the data retention bot.

  • actionType (string) –

    [REQUIRED]

    The action to perform. Valid values are ‘ENABLE’ (to enable the data retention service), ‘DISABLE’ (to disable the service), or ‘PUBKEY_MSG_ACK’ (to acknowledge the public key message).

Return type:

dict

Returns:

Response Syntax

{
    'message': 'string'
}

Response Structure

  • (dict) –

    • message (string) –

      A message indicating the result of the update operation.

Exceptions