Skip to content

GetWorkflowResponse

Source code in docs_src/capo_mwaa_serverless/types/get_workflow_response.py
class GetWorkflowResponse(TypedDict, closed=True):
    workflow_arn: "capo_mwaa_serverless.types.workflow_arn.WorkflowArn"
    """<p>The Amazon Resource Name (ARN) of the workflow.</p>"""
    workflow_version: NotRequired[
        "capo_mwaa_serverless.types.workflow_version.WorkflowVersion"
    ]
    """<p>The version identifier of the workflow.</p>"""
    name: NotRequired["capo_mwaa_serverless.types.name_string.NameString"]
    """<p>The name of the workflow.</p>"""
    description: NotRequired[
        "capo_mwaa_serverless.types.description_string.DescriptionString"
    ]
    """<p>The description of the workflow.</p>"""
    created_at: NotRequired["capo_mwaa_serverless.types.timestamp_value.TimestampValue"]
    """<p>The timestamp when the workflow was created, in ISO 8601 date-time format.</p>"""
    modified_at: NotRequired[
        "capo_mwaa_serverless.types.timestamp_value.TimestampValue"
    ]
    """<p>The timestamp when the workflow was last modified, in ISO 8601 date-time format.</p>"""
    encryption_configuration: NotRequired[
        "capo_mwaa_serverless.types.encryption_configuration.EncryptionConfiguration"
    ]
    """<p>The encryption configuration for the workflow.</p>"""
    logging_configuration: NotRequired[
        "capo_mwaa_serverless.types.logging_configuration.LoggingConfiguration"
    ]
    """<p>The logging configuration for the workflow.</p>"""
    engine_version: NotRequired[
        "capo_mwaa_serverless.types.engine_version.EngineVersion"
    ]
    """<p>The version of the Amazon Managed Workflows for Apache Airflow Serverless engine that this workflow uses.</p>"""
    workflow_status: NotRequired[
        "capo_mwaa_serverless.types.workflow_status.WorkflowStatus"
    ]
    """<p>The current status of the workflow.</p>"""
    definition_s3_location: NotRequired[
        "capo_mwaa_serverless.types.definition_s3_location.DefinitionS3Location"
    ]
    """<p>The Amazon S3 location of the workflow definition file.</p>"""
    code: NotRequired["capo_mwaa_serverless.types.code.Code"]
    """<p>The Amazon S3 location of the code artifacts provided during workflow creation or update.</p>"""
    code_snapshotted_at: NotRequired[
        "capo_mwaa_serverless.types.timestamp_value.TimestampValue"
    ]
    """<p>The time at which the code artifacts were copied for this workflow, in ISO 8601 date-time format.</p>"""
    schedule_configuration: NotRequired[
        "capo_mwaa_serverless.types.schedule_configuration.ScheduleConfiguration"
    ]
    """<p>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.</p>"""
    role_arn: NotRequired["capo_mwaa_serverless.types.role_arn.RoleARN"]
    """<p>The Amazon Resource Name (ARN) of the IAM role used for workflow execution.</p>"""
    network_configuration: NotRequired[
        "capo_mwaa_serverless.types.network_configuration.NetworkConfiguration"
    ]
    """<p>The network configuration for the workflow execution environment.</p>"""
    trigger_mode: NotRequired["capo_mwaa_serverless.types.generic_string.GenericString"]
    """<p>The trigger mode for the workflow execution.</p>"""
    workflow_definition: NotRequired[
        "capo_mwaa_serverless.types.generic_string.GenericString"
    ]
    """<p>The workflow definition content.</p>"""

code instance-attribute

code: NotRequired[Code]

The Amazon S3 location of the code artifacts provided during workflow creation or update.

code_snapshotted_at instance-attribute

code_snapshotted_at: NotRequired[TimestampValue]

The time at which the code artifacts were copied for this workflow, in ISO 8601 date-time format.

created_at instance-attribute

created_at: NotRequired[TimestampValue]

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

definition_s3_location instance-attribute

definition_s3_location: NotRequired[DefinitionS3Location]

The Amazon S3 location of the workflow definition file.

description instance-attribute

description: NotRequired[DescriptionString]

The description of the workflow.

encryption_configuration instance-attribute

encryption_configuration: NotRequired[EncryptionConfiguration]

The encryption configuration for the workflow.

engine_version instance-attribute

engine_version: NotRequired[EngineVersion]

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

logging_configuration instance-attribute

logging_configuration: NotRequired[LoggingConfiguration]

The logging configuration for the workflow.

modified_at instance-attribute

modified_at: NotRequired[TimestampValue]

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

name instance-attribute

name: NotRequired[NameString]

The name of the workflow.

network_configuration instance-attribute

network_configuration: NotRequired[NetworkConfiguration]

The network configuration for the workflow execution environment.

role_arn instance-attribute

role_arn: NotRequired[RoleARN]

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

schedule_configuration instance-attribute

schedule_configuration: NotRequired[ScheduleConfiguration]

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.

trigger_mode instance-attribute

trigger_mode: NotRequired[GenericString]

The trigger mode for the workflow execution.

workflow_arn instance-attribute

workflow_arn: WorkflowArn

The Amazon Resource Name (ARN) of the workflow.

workflow_definition instance-attribute

workflow_definition: NotRequired[GenericString]

The workflow definition content.

workflow_status instance-attribute

workflow_status: NotRequired[WorkflowStatus]

The current status of the workflow.

workflow_version instance-attribute

workflow_version: NotRequired[WorkflowVersion]

The version identifier of the workflow.