:doc:`ConfigService <../../config>` / Client / describe_retention_configurations

*********************************
describe_retention_configurations
*********************************



.. py:method:: ConfigService.Client.describe_retention_configurations(**kwargs)

  

  Returns the details of one or more retention configurations. If the retention configuration name is not specified, this operation returns the details for all the retention configurations for that account.

   

  .. note::

    

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

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/DescribeRetentionConfigurations>`_  


  **Request Syntax**
  ::

    response = client.describe_retention_configurations(
        RetentionConfigurationNames=[
            'string',
        ],
        NextToken='string'
    )
    
  :type RetentionConfigurationNames: list
  :param RetentionConfigurationNames: 

    A list of names of retention configurations for which you want details. If you do not specify a name, Config returns details for all the retention configurations for that account.

     

    .. note::

      

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

      

    

  
    - *(string) --* 

    

  :type NextToken: string
  :param NextToken: 

    The ``nextToken`` string returned on a previous page that you use to get the next page of results in a paginated response.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'RetentionConfigurations': [
              {
                  'Name': 'string',
                  'RetentionPeriodInDays': 123
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **RetentionConfigurations** *(list) --* 

        Returns a retention configuration object.

        
        

        - *(dict) --* 

          An object with the name of the retention configuration and the retention period in days. The object stores the configuration for data retention in Config.

          
          

          - **Name** *(string) --* 

            The name of the retention configuration object.

            
          

          - **RetentionPeriodInDays** *(integer) --* 

            Number of days Config stores your historical information.

             

            .. note::

              

              Currently, only applicable to the configuration item history.

              

            
      
    
      

      - **NextToken** *(string) --* 

        The ``nextToken`` string returned on a previous page that you use to get the next page of results in a paginated response.

        
  
  **Exceptions**
  
  *   :py:class:`ConfigService.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`ConfigService.Client.exceptions.NoSuchRetentionConfigurationException`

  
  *   :py:class:`ConfigService.Client.exceptions.InvalidNextTokenException`

  