:doc:`MWAAServerless <../../mwaa-serverless>` / Client / get_workflow_run

****************
get_workflow_run
****************



.. py:method:: MWAAServerless.Client.get_workflow_run(**kwargs)

  

  Retrieves detailed information about a specific workflow run, including its status, execution details, and task instances.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mwaa-serverless-2024-07-26/GetWorkflowRun>`_  


  **Request Syntax**
  ::

    response = client.get_workflow_run(
        WorkflowArn='string',
        RunId='string'
    )
    
  :type WorkflowArn: string
  :param WorkflowArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the workflow that contains the run.

    

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

    The unique identifier of the workflow run to retrieve.

    

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

    
    ::

      {
          'WorkflowArn': 'string',
          'WorkflowVersion': 'string',
          'RunId': 'string',
          'RunType': 'ON_DEMAND'|'SCHEDULED',
          'OverrideParameters': {
              'string': {...}|[...]|123|123.4|'string'|True|None
          },
          'RunDetail': {
              'WorkflowArn': 'string',
              'WorkflowVersion': 'string',
              'RunId': 'string',
              'RunType': 'ON_DEMAND'|'SCHEDULED',
              'StartedOn': datetime(2015, 1, 1),
              'CreatedAt': datetime(2015, 1, 1),
              'CompletedOn': datetime(2015, 1, 1),
              'ModifiedAt': datetime(2015, 1, 1),
              'Duration': 123,
              'ErrorMessage': 'string',
              'TaskInstances': [
                  'string',
              ],
              'RunState': 'STARTING'|'QUEUED'|'RUNNING'|'SUCCESS'|'FAILED'|'TIMEOUT'|'STOPPING'|'STOPPED'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **WorkflowArn** *(string) --* 

        The Amazon Resource Name (ARN) of the workflow that contains this run.

        
      

      - **WorkflowVersion** *(string) --* 

        The version of the workflow that is used for this run.

        
      

      - **RunId** *(string) --* 

        The unique identifier of this workflow run.

        
      

      - **RunType** *(string) --* 

        The type of workflow run. Values are ``ON_DEMAND`` (manually triggered) or ``SCHEDULED`` (automatically triggered by schedule).

        
      

      - **OverrideParameters** *(dict) --* 

        Parameters that were overridden for this specific workflow run.

        
        

        - *(string) --* 
          

          - (:ref:`document<document>`) -- 
    
  
      

      - **RunDetail** *(dict) --* 

        Detailed information about the workflow run execution, including timing, status, and task instances.

        
        

        - **WorkflowArn** *(string) --* 

          The Amazon Resource Name (ARN) of the workflow that contains this run.

          
        

        - **WorkflowVersion** *(string) --* 

          The version of the workflow used for this run.

          
        

        - **RunId** *(string) --* 

          The unique identifier of this workflow run.

          
        

        - **RunType** *(string) --* 

          The type of workflow run.

          
        

        - **StartedOn** *(datetime) --* 

          The timestamp when the workflow run started execution, in ISO 8601 date-time format.

          
        

        - **CreatedAt** *(datetime) --* 

          The timestamp when the workflow run was created, in ISO 8601 date-time format.

          
        

        - **CompletedOn** *(datetime) --* 

          The timestamp when the workflow run completed execution, in ISO 8601 date-time format. This value is null if the run is not complete.

          
        

        - **ModifiedAt** *(datetime) --* 

          The timestamp when the workflow run was last modified, in ISO 8601 date-time format.

          
        

        - **Duration** *(integer) --* 

          The total duration of the workflow run execution in seconds. This value is null if the run is not complete.

          
        

        - **ErrorMessage** *(string) --* 

          The error message if the workflow run failed. This value is null if the run completed successfully.

          
        

        - **TaskInstances** *(list) --* 

          A list of task instance IDs that are part of this workflow run.

          
          

          - *(string) --* 
      
        

        - **RunState** *(string) --* 

          The current execution state of the workflow run.

          
    
  
  **Exceptions**
  
  *   :py:class:`MWAAServerless.Client.exceptions.ThrottlingException`

  
  *   :py:class:`MWAAServerless.Client.exceptions.ValidationException`

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

  
  *   :py:class:`MWAAServerless.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`MWAAServerless.Client.exceptions.InternalServerException`

  
  *   :py:class:`MWAAServerless.Client.exceptions.OperationTimeoutException`

  