aws_sdk_appflow/client/

describe_flow.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeFlow`](crate::operation::describe_flow::builders::DescribeFlowFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`flow_name(impl Into<String>)`](crate::operation::describe_flow::builders::DescribeFlowFluentBuilder::flow_name) / [`set_flow_name(Option<String>)`](crate::operation::describe_flow::builders::DescribeFlowFluentBuilder::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>
    /// - On success, responds with [`DescribeFlowOutput`](crate::operation::describe_flow::DescribeFlowOutput) with field(s):
    ///   - [`flow_arn(Option<String>)`](crate::operation::describe_flow::DescribeFlowOutput::flow_arn): <p>The flow's Amazon Resource Name (ARN).</p>
    ///   - [`description(Option<String>)`](crate::operation::describe_flow::DescribeFlowOutput::description): <p>A description of the flow.</p>
    ///   - [`flow_name(Option<String>)`](crate::operation::describe_flow::DescribeFlowOutput::flow_name): <p>The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.</p>
    ///   - [`kms_arn(Option<String>)`](crate::operation::describe_flow::DescribeFlowOutput::kms_arn): <p>The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.</p>
    ///   - [`flow_status(Option<FlowStatus>)`](crate::operation::describe_flow::DescribeFlowOutput::flow_status): <p>Indicates the current status of the flow.</p>
    ///   - [`flow_status_message(Option<String>)`](crate::operation::describe_flow::DescribeFlowOutput::flow_status_message): <p>Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows.</p>
    ///   - [`source_flow_config(Option<SourceFlowConfig>)`](crate::operation::describe_flow::DescribeFlowOutput::source_flow_config): <p>The configuration that controls how Amazon AppFlow retrieves data from the source connector.</p>
    ///   - [`destination_flow_config_list(Option<Vec::<DestinationFlowConfig>>)`](crate::operation::describe_flow::DescribeFlowOutput::destination_flow_config_list): <p>The configuration that controls how Amazon AppFlow transfers data to the destination connector.</p>
    ///   - [`last_run_execution_details(Option<ExecutionDetails>)`](crate::operation::describe_flow::DescribeFlowOutput::last_run_execution_details): <p>Describes the details of the most recent flow run.</p>
    ///   - [`trigger_config(Option<TriggerConfig>)`](crate::operation::describe_flow::DescribeFlowOutput::trigger_config): <p>The trigger settings that determine how and when the flow runs.</p>
    ///   - [`tasks(Option<Vec::<Task>>)`](crate::operation::describe_flow::DescribeFlowOutput::tasks): <p>A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.</p>
    ///   - [`created_at(Option<DateTime>)`](crate::operation::describe_flow::DescribeFlowOutput::created_at): <p>Specifies when the flow was created.</p>
    ///   - [`last_updated_at(Option<DateTime>)`](crate::operation::describe_flow::DescribeFlowOutput::last_updated_at): <p>Specifies when the flow was last updated.</p>
    ///   - [`created_by(Option<String>)`](crate::operation::describe_flow::DescribeFlowOutput::created_by): <p>The ARN of the user who created the flow.</p>
    ///   - [`last_updated_by(Option<String>)`](crate::operation::describe_flow::DescribeFlowOutput::last_updated_by): <p>Specifies the user name of the account that performed the most recent update.</p>
    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::describe_flow::DescribeFlowOutput::tags): <p>The tags used to organize, track, or control access for your flow.</p>
    ///   - [`metadata_catalog_config(Option<MetadataCatalogConfig>)`](crate::operation::describe_flow::DescribeFlowOutput::metadata_catalog_config): <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>
    ///   - [`last_run_metadata_catalog_details(Option<Vec::<MetadataCatalogDetail>>)`](crate::operation::describe_flow::DescribeFlowOutput::last_run_metadata_catalog_details): <p>Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.</p>
    ///   - [`schema_version(Option<i64>)`](crate::operation::describe_flow::DescribeFlowOutput::schema_version): <p>The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:</p> <ul>  <li>   <p>Source-to-destination field mappings</p></li>  <li>   <p>Field data types</p></li>  <li>   <p>Partition keys</p></li> </ul>
    /// - On failure, responds with [`SdkError<DescribeFlowError>`](crate::operation::describe_flow::DescribeFlowError)
    pub fn describe_flow(&self) -> crate::operation::describe_flow::builders::DescribeFlowFluentBuilder {
        crate::operation::describe_flow::builders::DescribeFlowFluentBuilder::new(self.handle.clone())
    }
}