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

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



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

  

  Retrieves detailed information about a workflow, including its configuration, status, and metadata.

  

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


  **Request Syntax**
  ::

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

    The Amazon Resource Name (ARN) of the workflow you want to retrieve.

    

  
  :type WorkflowVersion: string
  :param WorkflowVersion: 

    Optional. The specific version of the workflow to retrieve. If not specified, the latest version is returned.

    

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

    
    ::

      {
          'WorkflowArn': 'string',
          'WorkflowVersion': 'string',
          'Name': 'string',
          'Description': 'string',
          'CreatedAt': datetime(2015, 1, 1),
          'ModifiedAt': datetime(2015, 1, 1),
          'EncryptionConfiguration': {
              'Type': 'AWS_MANAGED_KEY'|'CUSTOMER_MANAGED_KEY',
              'KmsKeyId': 'string'
          },
          'LoggingConfiguration': {
              'LogGroupName': 'string'
          },
          'EngineVersion': 123,
          'WorkflowStatus': 'READY'|'DELETING',
          'DefinitionS3Location': {
              'Bucket': 'string',
              'ObjectKey': 'string',
              'VersionId': 'string'
          },
          'ScheduleConfiguration': {
              'CronExpression': 'string'
          },
          'RoleArn': 'string',
          'NetworkConfiguration': {
              'SecurityGroupIds': [
                  'string',
              ],
              'SubnetIds': [
                  'string',
              ]
          },
          'TriggerMode': 'string',
          'WorkflowDefinition': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The Amazon Resource Name (ARN) of the workflow.

        
      

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

        The version identifier of the workflow.

        
      

      - **Name** *(string) --* 

        The name of the workflow.

        
      

      - **Description** *(string) --* 

        The description of the workflow.

        
      

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

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

        
      

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

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

        
      

      - **EncryptionConfiguration** *(dict) --* 

        The encryption configuration for the workflow.

        
        

        - **Type** *(string) --* 

          The type of encryption to use. Values are ``AWS_MANAGED_KEY`` (Amazon Web Services manages the encryption key) or ``CUSTOMER_MANAGED_KEY`` (you provide a KMS key).

          
        

        - **KmsKeyId** *(string) --* 

          The ID or ARN of the Amazon Web Services KMS key to use for encryption. Required when ``Type`` is ``CUSTOMER_MANAGED_KEY``.

          
    
      

      - **LoggingConfiguration** *(dict) --* 

        The logging configuration for the workflow.

        
        

        - **LogGroupName** *(string) --* 

          The name of the CloudWatch log group where workflow execution logs are stored.

          
    
      

      - **EngineVersion** *(integer) --* 

        The version of the Amazon Managed Workflows for Apache Airflow Serverless engine that this workflow uses.

        
      

      - **WorkflowStatus** *(string) --* 

        The current status of the workflow.

        
      

      - **DefinitionS3Location** *(dict) --* 

        The Amazon S3 location of the workflow definition file.

        
        

        - **Bucket** *(string) --* 

          The name of the Amazon S3 bucket that contains the workflow definition file.

          
        

        - **ObjectKey** *(string) --* 

          The key (name) of the workflow definition file within the S3 bucket.

          
        

        - **VersionId** *(string) --* 

          Optional. The version ID of the workflow definition file in Amazon S3. If not specified, the latest version is used.

          
    
      

      - **ScheduleConfiguration** *(dict) --* 

        The schedule configuration for the workflow, including cron expressions for automated execution. Amazon Managed Workflows for Apache Airflow Serverless uses EventBridge Scheduler for cost-effective, timezone-aware scheduling. When a workflow includes schedule information in its YAML definition, the service automatically configures the appropriate triggers for automated execution. Only one version of a workflow can have an active schedule at any given time.

        
        

        - **CronExpression** *(string) --* 

          A cron expression that defines when the workflow is automatically executed. Uses standard cron syntax.

          
    
      

      - **RoleArn** *(string) --* 

        The Amazon Resource Name (ARN) of the IAM role used for workflow execution.

        
      

      - **NetworkConfiguration** *(dict) --* 

        The network configuration for the workflow execution environment.

        
        

        - **SecurityGroupIds** *(list) --* 

          A list of VPC security group IDs to associate with the workflow execution environment.

          
          

          - *(string) --* 
      
        

        - **SubnetIds** *(list) --* 

          A list of VPC subnet IDs where the workflow execution environment is deployed.

          
          

          - *(string) --* 
      
    
      

      - **TriggerMode** *(string) --* 

        The trigger mode for the workflow execution.

        
      

      - **WorkflowDefinition** *(string) --* 

        The workflow definition content.

        
  
  **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`

  