Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

PutAppInstanceRetentionSettings

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

Important

This API is no longer supported and will not be updated. We recommend using the latest version, PutAppInstanceRetentionSettings, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Request Syntax


PUT /app-instances/appInstanceArn/retention-settings HTTP/1.1
Content-type: application/json

{
   "AppInstanceRetentionSettings": { 
      "ChannelRetentionSettings": { 
         "RetentionDays": number
      }
   }
}

URI Request Parameters

The request uses the following URI parameters.

appInstanceArn

The ARN of the AppInstance.

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: Yes

Request Body

The request accepts the following data in JSON format.

AppInstanceRetentionSettings

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

Type: AppInstanceRetentionSettings object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AppInstanceRetentionSettings": { 
      "ChannelRetentionSettings": { 
         "RetentionDays": number
      }
   },
   "InitiateDeletionTimestamp": number
}

Response Elements

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

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

AppInstanceRetentionSettings

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

Type: AppInstanceRetentionSettings object

InitiateDeletionTimestamp

The time at which the API deletes data.

Type: Timestamp

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.

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