# DecreaseStreamRetentionPeriod
<a name="API_DecreaseStreamRetentionPeriod"></a>

Decreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours.

**Note**  
When invoking this API, you must use either the `StreamARN` or the `StreamName` parameter, or both. It is recommended that you use the `StreamARN` input parameter when you invoke this API.

This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.

## Request Syntax
<a name="API_DecreaseStreamRetentionPeriod_RequestSyntax"></a>

```
{
   "RetentionPeriodHours": number,
   "StreamARN": "string",
   "StreamId": "string",
   "StreamName": "string"
}
```

## Request Parameters
<a name="API_DecreaseStreamRetentionPeriod_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [RetentionPeriodHours](#API_DecreaseStreamRetentionPeriod_RequestSyntax) **   <a name="Streams-DecreaseStreamRetentionPeriod-request-RetentionPeriodHours"></a>
The new retention period of the stream, in hours. Must be less than the current retention period.  
Type: Integer  
Required: Yes

 ** [StreamARN](#API_DecreaseStreamRetentionPeriod_RequestSyntax) **   <a name="Streams-DecreaseStreamRetentionPeriod-request-StreamARN"></a>
The ARN of the stream.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:aws.*:kinesis:.*:\d{12}:stream/\S+`   
Required: No

 ** [StreamId](#API_DecreaseStreamRetentionPeriod_RequestSyntax) **   <a name="Streams-DecreaseStreamRetentionPeriod-request-StreamId"></a>
Not Implemented. Reserved for future use.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 24.  
Pattern: `[a-z0-9]{20}-[a-z0-9]{3}`   
Required: No

 ** [StreamName](#API_DecreaseStreamRetentionPeriod_RequestSyntax) **   <a name="Streams-DecreaseStreamRetentionPeriod-request-StreamName"></a>
The name of the stream to modify.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: No

## Response Elements
<a name="API_DecreaseStreamRetentionPeriod_ResponseElements"></a>

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

## Errors
<a name="API_DecreaseStreamRetentionPeriod_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
Specifies that you do not have the permissions required to perform this operation.  
HTTP Status Code: 400

 ** InvalidArgumentException **   
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.    
 ** message **   
A message that provides information about the error.
HTTP Status Code: 400

 ** LimitExceededException **   
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.     
 ** message **   
A message that provides information about the error.
HTTP Status Code: 400

 ** ResourceInUseException **   
The resource is not available for this operation. For successful operation, the resource must be in the `ACTIVE` state.    
 ** message **   
A message that provides information about the error.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource could not be found. The stream might not be specified correctly.    
 ** message **   
A message that provides information about the error.
HTTP Status Code: 400

## Examples
<a name="API_DecreaseStreamRetentionPeriod_Examples"></a>

### To decrease stream retention period
<a name="API_DecreaseStreamRetentionPeriod_Example_1"></a>

The following JSON example decreases a stream's retention period.

#### Sample Request
<a name="API_DecreaseStreamRetentionPeriod_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: kinesis.<region>.<domain>
Content-Length: <PayloadSizeBytes>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Authorization: <AuthParams>
Connection: Keep-Alive 
X-Amz-Date: <Date>
X-Amz-Target: Kinesis_20131202.DecreaseStreamRetentionPeriod
{
    "RetentionPeriodInHours": "24",
    "StreamName": "examplestream"
}
```

#### Sample Response
<a name="API_DecreaseStreamRetentionPeriod_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
```

## See Also
<a name="API_DecreaseStreamRetentionPeriod_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesis-2013-12-02/DecreaseStreamRetentionPeriod) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-2013-12-02/DecreaseStreamRetentionPeriod) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-2013-12-02/DecreaseStreamRetentionPeriod) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-2013-12-02/DecreaseStreamRetentionPeriod) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-2013-12-02/DecreaseStreamRetentionPeriod) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-2013-12-02/DecreaseStreamRetentionPeriod) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-2013-12-02/DecreaseStreamRetentionPeriod) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-2013-12-02/DecreaseStreamRetentionPeriod) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesis-2013-12-02/DecreaseStreamRetentionPeriod) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-2013-12-02/DecreaseStreamRetentionPeriod)