:doc:`CloudTrail <../../cloudtrail>` / Client / start_dashboard_refresh

***********************
start_dashboard_refresh
***********************



.. py:method:: CloudTrail.Client.start_dashboard_refresh(**kwargs)

  

  Starts a refresh of the specified dashboard.

   

  Each time a dashboard is refreshed, CloudTrail runs queries to populate the dashboard's widgets. CloudTrail must be granted permissions to run the ``StartQuery`` operation on your behalf. To provide permissions, run the ``PutResourcePolicy`` operation to attach a resource-based policy to each event data store. For more information, see `Example\: Allow CloudTrail to run queries to populate a dashboard <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html#security_iam_resource-based-policy-examples-eds-dashboard>`__ in the *CloudTrail User Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StartDashboardRefresh>`_  


  **Request Syntax**
  ::

    response = client.start_dashboard_refresh(
        DashboardId='string',
        QueryParameterValues={
            'string': 'string'
        }
    )
    
  :type DashboardId: string
  :param DashboardId: **[REQUIRED]** 

    The name or ARN of the dashboard.

    

  
  :type QueryParameterValues: dict
  :param QueryParameterValues: 

    The query parameter values for the dashboard

     

    For custom dashboards, the following query parameters are valid: ``$StartTime$``, ``$EndTime$``, and ``$Period$``.

     

    For managed dashboards, the following query parameters are valid: ``$StartTime$``, ``$EndTime$``, ``$Period$``, and ``$EventDataStoreId$``. The ``$EventDataStoreId$`` query parameter is required.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


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

    
    ::

      {
          'RefreshId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **RefreshId** *(string) --* 

        The refresh ID for the dashboard.

        
  
  **Exceptions**
  
  *   :py:class:`CloudTrail.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`CloudTrail.Client.exceptions.EventDataStoreNotFoundException`

  
  *   :py:class:`CloudTrail.Client.exceptions.InactiveEventDataStoreException`

  
  *   :py:class:`CloudTrail.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`CloudTrail.Client.exceptions.UnsupportedOperationException`

  