[ aws . chime-sdk-identity ]

put-app-instance-retention-settings

Description

Sets the amount of time in days that a given AppInstance retains data.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-app-instance-retention-settings
--app-instance-arn <value>
--app-instance-retention-settings <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--app-instance-arn (string)

The ARN of the AppInstance .

--app-instance-retention-settings (structure)

The time in days to retain data. Data type: number.

ChannelRetentionSettings -> (structure)

The length of time in days to retain the messages in a channel.

RetentionDays -> (integer)

The time in days to retain the messages in a channel.

Shorthand Syntax:

ChannelRetentionSettings={RetentionDays=integer}

JSON Syntax:

{
  "ChannelRetentionSettings": {
    "RetentionDays": integer
  }
}

--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

AppInstanceRetentionSettings -> (structure)

The time in days to retain data. Data type: number.

ChannelRetentionSettings -> (structure)

The length of time in days to retain the messages in a channel.

RetentionDays -> (integer)

The time in days to retain the messages in a channel.

InitiateDeletionTimestamp -> (timestamp)

The time at which the API deletes data.