:doc:`NovaActService <../../nova-act>` / Client / get_workflow_definition

***********************
get_workflow_definition
***********************



.. py:method:: NovaActService.Client.get_workflow_definition(**kwargs)

  

  Retrieves the details and configuration of a specific workflow definition.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/GetWorkflowDefinition>`_  


  **Request Syntax**
  ::

    response = client.get_workflow_definition(
        workflowDefinitionName='string'
    )
    
  :type workflowDefinitionName: string
  :param workflowDefinitionName: **[REQUIRED]** 

    The name of the workflow definition to retrieve.

    

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

    
    ::

      {
          'name': 'string',
          'arn': 'string',
          'createdAt': datetime(2015, 1, 1),
          'description': 'string',
          'exportConfig': {
              's3BucketName': 'string',
              's3KeyPrefix': 'string'
          },
          'status': 'ACTIVE'|'DELETING'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The name of the workflow definition.

        
      

      - **arn** *(string) --* 

        The Amazon Resource Name (ARN) of the workflow definition.

        
      

      - **createdAt** *(datetime) --* 

        The timestamp when the workflow definition was created.

        
      

      - **description** *(string) --* 

        The description of the workflow definition.

        
      

      - **exportConfig** *(dict) --* 

        The export configuration for the workflow definition.

        
        

        - **s3BucketName** *(string) --* 

          The name of your Amazon S3 bucket, that Nova Act uses to export your workflow data. Note that the IAM role used to access Nova Act must also have write permissions to this bucket.

          
        

        - **s3KeyPrefix** *(string) --* 

          An optional prefix for Amazon S3 object keys to organize exported data.

          
    
      

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

        The current status of the workflow definition.

        
  
  **Exceptions**
  
  *   :py:class:`NovaActService.Client.exceptions.AccessDeniedException`

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

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

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

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

  