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.

Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information. The API creates the RetentionConfiguration object and names the object as default. When you have a RetentionConfiguration object named default, calling the API modifies the default object.

Currently, Config supports only one retention configuration per region in your account.

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 BeginPutRetentionConfiguration and EndPutRetentionConfiguration.

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

Syntax

C#
public virtual Task<PutRetentionConfigurationResponse> PutRetentionConfigurationAsync(
         PutRetentionConfigurationRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ConfigService.Model.PutRetentionConfigurationRequest

Container for the necessary parameters to execute the PutRetentionConfiguration 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 PutRetentionConfiguration service method, as returned by ConfigService.

Exceptions

ExceptionCondition
InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
MaxNumberOfRetentionConfigurationsExceededException Failed to add the retention configuration because a retention configuration with that name already exists.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also