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

*******************************
put_data_set_refresh_properties
*******************************



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

  

  Creates or updates the dataset refresh properties for the dataset.

  

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


  **Request Syntax**
  ::

    response = client.put_data_set_refresh_properties(
        AwsAccountId='string',
        DataSetId='string',
        DataSetRefreshProperties={
            'RefreshConfiguration': {
                'IncrementalRefresh': {
                    'LookbackWindow': {
                        'ColumnName': 'string',
                        'Size': 123,
                        'SizeUnit': 'HOUR'|'DAY'|'WEEK'
                    }
                }
            },
            'FailureConfiguration': {
                'EmailAlert': {
                    'AlertStatus': 'ENABLED'|'DISABLED'
                }
            }
        }
    )
    
  :type AwsAccountId: string
  :param AwsAccountId: **[REQUIRED]** 

    The Amazon Web Services account ID.

    

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

    The ID of the dataset.

    

  
  :type DataSetRefreshProperties: dict
  :param DataSetRefreshProperties: **[REQUIRED]** 

    The dataset refresh properties.

    

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

      The refresh configuration for a dataset.

      

    
      - **IncrementalRefresh** *(dict) --* **[REQUIRED]** 

        The incremental refresh for the dataset.

        

      
        - **LookbackWindow** *(dict) --* **[REQUIRED]** 

          The lookback window setup for an incremental refresh configuration.

          

        
          - **ColumnName** *(string) --* **[REQUIRED]** 

            The name of the lookback window column.

            

          
          - **Size** *(integer) --* **[REQUIRED]** 

            The lookback window column size.

            

          
          - **SizeUnit** *(string) --* **[REQUIRED]** 

            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.

          

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

    
    ::

      {
          'RequestId': 'string',
          'Status': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The Amazon Web Services request ID for this operation.

        
      

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

        The HTTP status of the request.

        
  
  **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.ConflictException`

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

  