Skip to content

UpdateFlowRequest

Source code in docs_src/capo_appflow/types/update_flow_request.py
class UpdateFlowRequest(TypedDict, closed=True):
    flow_name: "capo_appflow.types.flow_name.FlowName"
    """<p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. </p>"""
    description: NotRequired["capo_appflow.types.flow_description.FlowDescription"]
    """<p> A description of the flow. </p>"""
    trigger_config: "capo_appflow.types.trigger_config.TriggerConfig"
    """<p> The trigger settings that determine how and when the flow runs. </p>"""
    source_flow_config: "capo_appflow.types.source_flow_config.SourceFlowConfig"
    destination_flow_config_list: (
        "capo_appflow.types.destination_flow_config_list.DestinationFlowConfigList"
    )
    """<p> The configuration that controls how Amazon AppFlow transfers data to the destination connector. </p>"""
    tasks: "capo_appflow.types.tasks.Tasks"
    """<p> A list of tasks that Amazon AppFlow performs while transferring the data in the flow run. </p>"""
    metadata_catalog_config: NotRequired[
        "capo_appflow.types.metadata_catalog_config.MetadataCatalogConfig"
    ]
    """<p>Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.</p>"""
    client_token: NotRequired["capo_appflow.types.client_token.ClientToken"]
    """<p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your <code>UpdateFlow</code> request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same <code>clientToken</code> parameter value.</p> <p>If you omit a <code>clientToken</code> value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.</p> <p>If you specify input parameters that differ from your first request, an error occurs. If you use a different value for <code>clientToken</code>, Amazon AppFlow considers it a new call to <code>UpdateFlow</code>. The token is active for 8 hours.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

The clientToken parameter is an idempotency token. It ensures that your UpdateFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to UpdateFlow. The token is active for 8 hours.

description instance-attribute

description: NotRequired[FlowDescription]

A description of the flow.

destination_flow_config_list instance-attribute

destination_flow_config_list: DestinationFlowConfigList

The configuration that controls how Amazon AppFlow transfers data to the destination connector.

flow_name instance-attribute

flow_name: FlowName

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

metadata_catalog_config instance-attribute

metadata_catalog_config: NotRequired[MetadataCatalogConfig]

Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.

source_flow_config instance-attribute

source_flow_config: SourceFlowConfig

tasks instance-attribute

tasks: Tasks

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

trigger_config instance-attribute

trigger_config: TriggerConfig

The trigger settings that determine how and when the flow runs.