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

*************************************
start_dashboard_snapshot_job_schedule
*************************************



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

  

  Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.

   

  Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a ``202`` HTTP status code.

   

  For more information, see `Scheduling and sending Amazon Quick Sight reports by email <https://docs.aws.amazon.com/quicksight/latest/user/sending-reports.html>`__ and `Configuring email report settings for a Amazon Quick Sight dashboard <https://docs.aws.amazon.com/quicksight/latest/user/email-reports-from-dashboard.html>`__ in the *Amazon Quick Sight User Guide*.

  

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


  **Request Syntax**
  ::

    response = client.start_dashboard_snapshot_job_schedule(
        AwsAccountId='string',
        DashboardId='string',
        ScheduleId='string'
    )
    
  :type AwsAccountId: string
  :param AwsAccountId: **[REQUIRED]** 

    The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

    

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

    The ID of the dashboard that you want to start a snapshot job schedule for.

    

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

    The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the Amazon Quick Sight console in the **Schedules** pane of the dashboard that the schedule is configured for.

    

  
  
  :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.LimitExceededException`

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

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

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

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

  