AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginPutRetentionSettings and EndPutRetentionSettings.

Namespace: Amazon.Chime
Assembly: AWSSDK.Chime.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<PutRetentionSettingsResponse> PutRetentionSettingsAsync(
         PutRetentionSettingsRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Chime.Model.PutRetentionSettingsRequest

Container for the necessary parameters to execute the PutRetentionSettings service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the PutRetentionSettings service method, as returned by Chime.

Exceptions

ExceptionCondition
BadRequestException The input parameters don't match the service's restrictions.
ConflictException The request could not be processed because of conflict in the current state of the resource.
ForbiddenException The client is permanently forbidden from making the request.
NotFoundException One or more of the resources in the request does not exist in the system.
ServiceFailureException The service encountered an unexpected error.
ServiceUnavailableException The service is currently unavailable.
ThrottledClientException The client exceeded its request rate limit.
UnauthorizedClientException The client is not currently authorized to make the request.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also