PutRetentionSettings - Amazon Chime

PutRetentionSettings

Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.

To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.

Request Syntax

PUT /accounts/accountId/retention-settings HTTP/1.1 Content-type: application/json { "RetentionSettings": { "ConversationRetentionSettings": { "RetentionDays": number }, "RoomRetentionSettings": { "RetentionDays": number } } }

URI Request Parameters

The request uses the following URI parameters.

accountId

The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

RetentionSettings

The retention settings.

Type: RetentionSettings object

Required: Yes

Response Syntax

HTTP/1.1 204 Content-type: application/json { "InitiateDeletionTimestamp": number, "RetentionSettings": { "ConversationRetentionSettings": { "RetentionDays": number }, "RoomRetentionSettings": { "RetentionDays": number } } }

Response Elements

If the action is successful, the service sends back an HTTP 204 response.

The following data is returned in JSON format by the service.

InitiateDeletionTimestamp

The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.

Type: Timestamp

RetentionSettings

The retention settings.

Type: RetentionSettings object

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported Region.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: