:doc:`CodeCatalyst <../../codecatalyst>` / Client / get_workflow

************
get_workflow
************



.. py:method:: CodeCatalyst.Client.get_workflow(**kwargs)

  

  Returns information about a workflow.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/GetWorkflow>`_  


  **Request Syntax**
  ::

    response = client.get_workflow(
        spaceName='string',
        id='string',
        projectName='string'
    )
    
  :type spaceName: string
  :param spaceName: **[REQUIRED]** 

    The name of the space.

    

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

    The ID of the workflow. To rerieve a list of workflow IDs, use  ListWorkflows.

    

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

    The name of the project in the space.

    

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

    
    ::

      {
          'spaceName': 'string',
          'projectName': 'string',
          'id': 'string',
          'name': 'string',
          'sourceRepositoryName': 'string',
          'sourceBranchName': 'string',
          'definition': {
              'path': 'string'
          },
          'createdTime': datetime(2015, 1, 1),
          'lastUpdatedTime': datetime(2015, 1, 1),
          'runMode': 'QUEUED'|'PARALLEL'|'SUPERSEDED',
          'status': 'INVALID'|'ACTIVE'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **spaceName** *(string) --* 

        The name of the space.

        
      

      - **projectName** *(string) --* 

        The name of the project in the space.

        
      

      - **id** *(string) --* 

        The ID of the workflow.

        
      

      - **name** *(string) --* 

        The name of the workflow.

        
      

      - **sourceRepositoryName** *(string) --* 

        The name of the source repository where the workflow YAML is stored.

        
      

      - **sourceBranchName** *(string) --* 

        The name of the branch that contains the workflow YAML.

        
      

      - **definition** *(dict) --* 

        Information about the workflow definition file for the workflow.

        
        

        - **path** *(string) --* 

          The path to the workflow definition file stored in the source repository for the project, including the file name.

          
    
      

      - **createdTime** *(datetime) --* 

        The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in `RFC 3339 <https://www.rfc-editor.org/rfc/rfc3339#section-5.6>`__

        
      

      - **lastUpdatedTime** *(datetime) --* 

        The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in `RFC 3339 <https://www.rfc-editor.org/rfc/rfc3339#section-5.6>`__

        
      

      - **runMode** *(string) --* 

        The behavior to use when multiple workflows occur at the same time. For more information, see `https\://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html <https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html>`__ in the Amazon CodeCatalyst User Guide.

        
      

      - **status** *(string) --* 

        The status of the workflow.

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

  
  *   :py:class:`CodeCatalyst.Client.exceptions.ConflictException`

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

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

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

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

  