:doc:`QuickSight <../../quicksight>` / Client / describe_data_set_refresh_properties

************************************
describe_data_set_refresh_properties
************************************



.. py:method:: QuickSight.Client.describe_data_set_refresh_properties(**kwargs)

  

  Describes the refresh properties of a dataset.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetRefreshProperties>`_  


  **Request Syntax**
  ::

    response = client.describe_data_set_refresh_properties(
        AwsAccountId='string',
        DataSetId='string'
    )
    
  :type AwsAccountId: string
  :param AwsAccountId: **[REQUIRED]** 

    The Amazon Web Services account ID.

    

  
  :type DataSetId: string
  :param DataSetId: **[REQUIRED]** 

    The ID of the dataset.

    

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

    
    ::

      {
          'RequestId': 'string',
          'Status': 123,
          'DataSetRefreshProperties': {
              'RefreshConfiguration': {
                  'IncrementalRefresh': {
                      'LookbackWindow': {
                          'ColumnName': 'string',
                          'Size': 123,
                          'SizeUnit': 'HOUR'|'DAY'|'WEEK'
                      }
                  }
              },
              'FailureConfiguration': {
                  'EmailAlert': {
                      'AlertStatus': 'ENABLED'|'DISABLED'
                  }
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **RequestId** *(string) --* 

        The Amazon Web Services request ID for this operation.

        
      

      - **Status** *(integer) --* 

        The HTTP status of the request.

        
      

      - **DataSetRefreshProperties** *(dict) --* 

        The dataset refresh properties.

        
        

        - **RefreshConfiguration** *(dict) --* 

          The refresh configuration for a dataset.

          
          

          - **IncrementalRefresh** *(dict) --* 

            The incremental refresh for the dataset.

            
            

            - **LookbackWindow** *(dict) --* 

              The lookback window setup for an incremental refresh configuration.

              
              

              - **ColumnName** *(string) --* 

                The name of the lookback window column.

                
              

              - **Size** *(integer) --* 

                The lookback window column size.

                
              

              - **SizeUnit** *(string) --* 

                The size unit that is used for the lookback window column. Valid values for this structure are ``HOUR``, ``DAY``, and ``WEEK``.

                
          
        
      
        

        - **FailureConfiguration** *(dict) --* 

          The failure configuration for a dataset.

          
          

          - **EmailAlert** *(dict) --* 

            The email alert configuration for a dataset refresh failure.

            
            

            - **AlertStatus** *(string) --* 

              The status value that determines if email alerts are sent.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`QuickSight.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`QuickSight.Client.exceptions.InvalidParameterValueException`

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

  
  *   :py:class:`QuickSight.Client.exceptions.ThrottlingException`

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

  
  *   :py:class:`QuickSight.Client.exceptions.PreconditionNotMetException`

  
  *   :py:class:`QuickSight.Client.exceptions.InternalFailureException`

  