:doc:`Kinesis <../../kinesis>` / Client / decrease_stream_retention_period

********************************
decrease_stream_retention_period
********************************



.. py:method:: Kinesis.Client.decrease_stream_retention_period(**kwargs)

  

  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.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DecreaseStreamRetentionPeriod>`_  


  **Request Syntax**
  ::

    response = client.decrease_stream_retention_period(
        StreamName='string',
        RetentionPeriodHours=123,
        StreamARN='string',
        StreamId='string'
    )
    
  :type StreamName: string
  :param StreamName: 

    The name of the stream to modify.

    

  
  :type RetentionPeriodHours: integer
  :param RetentionPeriodHours: **[REQUIRED]** 

    The new retention period of the stream, in hours. Must be less than the current retention period.

    

  
  :type StreamARN: string
  :param StreamARN: 

    The ARN of the stream.

    

  
  :type StreamId: string
  :param StreamId: 

    Not Implemented. Reserved for future use.

    

  
  
  :returns: None
  **Exceptions**
  
  *   :py:class:`Kinesis.Client.exceptions.ResourceInUseException`

  
  *   :py:class:`Kinesis.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Kinesis.Client.exceptions.LimitExceededException`

  
  *   :py:class:`Kinesis.Client.exceptions.InvalidArgumentException`

  
  *   :py:class:`Kinesis.Client.exceptions.AccessDeniedException`

  