aws_sdk_appflow/client/

update_flow.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateFlow`](crate::operation::update_flow::builders::UpdateFlowFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`flow_name(impl Into<String>)`](crate::operation::update_flow::builders::UpdateFlowFluentBuilder::flow_name) / [`set_flow_name(Option<String>)`](crate::operation::update_flow::builders::UpdateFlowFluentBuilder::set_flow_name):<br>required: **true**<br><p>The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::update_flow::builders::UpdateFlowFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_flow::builders::UpdateFlowFluentBuilder::set_description):<br>required: **false**<br><p>A description of the flow.</p><br>
    ///   - [`trigger_config(TriggerConfig)`](crate::operation::update_flow::builders::UpdateFlowFluentBuilder::trigger_config) / [`set_trigger_config(Option<TriggerConfig>)`](crate::operation::update_flow::builders::UpdateFlowFluentBuilder::set_trigger_config):<br>required: **true**<br><p>The trigger settings that determine how and when the flow runs.</p><br>
    ///   - [`source_flow_config(SourceFlowConfig)`](crate::operation::update_flow::builders::UpdateFlowFluentBuilder::source_flow_config) / [`set_source_flow_config(Option<SourceFlowConfig>)`](crate::operation::update_flow::builders::UpdateFlowFluentBuilder::set_source_flow_config):<br>required: **true**<br><p>Contains information about the configuration of the source connector used in the flow.</p><br>
    ///   - [`destination_flow_config_list(DestinationFlowConfig)`](crate::operation::update_flow::builders::UpdateFlowFluentBuilder::destination_flow_config_list) / [`set_destination_flow_config_list(Option<Vec::<DestinationFlowConfig>>)`](crate::operation::update_flow::builders::UpdateFlowFluentBuilder::set_destination_flow_config_list):<br>required: **true**<br><p>The configuration that controls how Amazon AppFlow transfers data to the destination connector.</p><br>
    ///   - [`tasks(Task)`](crate::operation::update_flow::builders::UpdateFlowFluentBuilder::tasks) / [`set_tasks(Option<Vec::<Task>>)`](crate::operation::update_flow::builders::UpdateFlowFluentBuilder::set_tasks):<br>required: **true**<br><p>A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.</p><br>
    ///   - [`metadata_catalog_config(MetadataCatalogConfig)`](crate::operation::update_flow::builders::UpdateFlowFluentBuilder::metadata_catalog_config) / [`set_metadata_catalog_config(Option<MetadataCatalogConfig>)`](crate::operation::update_flow::builders::UpdateFlowFluentBuilder::set_metadata_catalog_config):<br>required: **false**<br><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><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::update_flow::builders::UpdateFlowFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::update_flow::builders::UpdateFlowFluentBuilder::set_client_token):<br>required: **false**<br><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><br>
    /// - On success, responds with [`UpdateFlowOutput`](crate::operation::update_flow::UpdateFlowOutput) with field(s):
    ///   - [`flow_status(Option<FlowStatus>)`](crate::operation::update_flow::UpdateFlowOutput::flow_status): <p>Indicates the current status of the flow.</p>
    /// - On failure, responds with [`SdkError<UpdateFlowError>`](crate::operation::update_flow::UpdateFlowError)
    pub fn update_flow(&self) -> crate::operation::update_flow::builders::UpdateFlowFluentBuilder {
        crate::operation::update_flow::builders::UpdateFlowFluentBuilder::new(self.handle.clone())
    }
}