Skip to content

FlowDefinition

Source code in docs_src/capo_appflow/types/flow_definition.py
class FlowDefinition(TypedDict, closed=True):
    flow_arn: NotRequired["capo_appflow.types.flow_arn.FlowArn"]
    """<p> The flow's Amazon Resource Name (ARN). </p>"""
    description: NotRequired["capo_appflow.types.flow_description.FlowDescription"]
    """<p> A user-entered description of the flow. </p>"""
    flow_name: NotRequired["capo_appflow.types.flow_name.FlowName"]
    """<p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. </p>"""
    flow_status: NotRequired["capo_appflow.types.flow_status.FlowStatus"]
    """<p> Indicates the current status of the flow. </p>"""
    source_connector_type: NotRequired[
        "capo_appflow.types.connector_type.ConnectorType"
    ]
    """<p> Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on. </p>"""
    source_connector_label: NotRequired[
        "capo_appflow.types.connector_label.ConnectorLabel"
    ]
    """<p>The label of the source connector in the flow.</p>"""
    destination_connector_type: NotRequired[
        "capo_appflow.types.connector_type.ConnectorType"
    ]
    """<p> Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on. </p>"""
    destination_connector_label: NotRequired[
        "capo_appflow.types.connector_label.ConnectorLabel"
    ]
    """<p>The label of the destination connector in the flow.</p>"""
    trigger_type: NotRequired["capo_appflow.types.trigger_type.TriggerType"]
    """<p> Specifies the type of flow trigger. This can be <code>OnDemand</code>, <code>Scheduled</code>, or <code>Event</code>. </p>"""
    created_at: NotRequired["capo_appflow.types.date.Date"]
    """<p> Specifies when the flow was created. </p>"""
    last_updated_at: NotRequired["capo_appflow.types.date.Date"]
    """<p> Specifies when the flow was last updated. </p>"""
    created_by: NotRequired["capo_appflow.types.created_by.CreatedBy"]
    """<p> The ARN of the user who created the flow. </p>"""
    last_updated_by: NotRequired["capo_appflow.types.updated_by.UpdatedBy"]
    """<p> Specifies the account user name that most recently updated the flow. </p>"""
    tags: NotRequired["capo_appflow.types.tag_map.TagMap"]
    """<p> The tags used to organize, track, or control access for your flow. </p>"""
    last_run_execution_details: NotRequired[
        "capo_appflow.types.execution_details.ExecutionDetails"
    ]
    """<p> Describes the details of the most recent flow run. </p>"""

created_at instance-attribute

created_at: NotRequired[Date]

Specifies when the flow was created.

created_by instance-attribute

created_by: NotRequired[CreatedBy]

The ARN of the user who created the flow.

description instance-attribute

description: NotRequired[FlowDescription]

A user-entered description of the flow.

destination_connector_label instance-attribute

destination_connector_label: NotRequired[ConnectorLabel]

The label of the destination connector in the flow.

destination_connector_type instance-attribute

destination_connector_type: NotRequired[ConnectorType]

Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

flow_arn instance-attribute

flow_arn: NotRequired[FlowArn]

The flow's Amazon Resource Name (ARN).

flow_name instance-attribute

flow_name: NotRequired[FlowName]

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

flow_status instance-attribute

flow_status: NotRequired[FlowStatus]

Indicates the current status of the flow.

last_run_execution_details instance-attribute

last_run_execution_details: NotRequired[ExecutionDetails]

Describes the details of the most recent flow run.

last_updated_at instance-attribute

last_updated_at: NotRequired[Date]

Specifies when the flow was last updated.

last_updated_by instance-attribute

last_updated_by: NotRequired[UpdatedBy]

Specifies the account user name that most recently updated the flow.

source_connector_label instance-attribute

source_connector_label: NotRequired[ConnectorLabel]

The label of the source connector in the flow.

source_connector_type instance-attribute

source_connector_type: NotRequired[ConnectorType]

Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

tags instance-attribute

tags: NotRequired[TagMap]

The tags used to organize, track, or control access for your flow.

trigger_type instance-attribute

trigger_type: NotRequired[TriggerType]

Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.