get-retention-settings¶
Description¶
Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-retention-settings
--account-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--account-id (string)
The Amazon Chime account ID.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
RetentionSettings -> (structure)
The retention settings.
RoomRetentionSettings -> (structure)
The chat room retention settings.
RetentionDays -> (integer)
The number of days for which to retain chat-room messages.
ConversationRetentionSettings -> (structure)
The chat conversation retention settings.
RetentionDays -> (integer)
The number of days for which to retain conversation messages.
InitiateDeletionTimestamp -> (timestamp)
The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.