aws_sdk_sagemaker/client/
describe_flow_definition.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeFlowDefinition`](crate::operation::describe_flow_definition::builders::DescribeFlowDefinitionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`flow_definition_name(impl Into<String>)`](crate::operation::describe_flow_definition::builders::DescribeFlowDefinitionFluentBuilder::flow_definition_name) / [`set_flow_definition_name(Option<String>)`](crate::operation::describe_flow_definition::builders::DescribeFlowDefinitionFluentBuilder::set_flow_definition_name):<br>required: **true**<br><p>The name of the flow definition.</p><br>
7    /// - On success, responds with [`DescribeFlowDefinitionOutput`](crate::operation::describe_flow_definition::DescribeFlowDefinitionOutput) with field(s):
8    ///   - [`flow_definition_arn(Option<String>)`](crate::operation::describe_flow_definition::DescribeFlowDefinitionOutput::flow_definition_arn): <p>The Amazon Resource Name (ARN) of the flow defintion.</p>
9    ///   - [`flow_definition_name(Option<String>)`](crate::operation::describe_flow_definition::DescribeFlowDefinitionOutput::flow_definition_name): <p>The Amazon Resource Name (ARN) of the flow definition.</p>
10    ///   - [`flow_definition_status(Option<FlowDefinitionStatus>)`](crate::operation::describe_flow_definition::DescribeFlowDefinitionOutput::flow_definition_status): <p>The status of the flow definition. Valid values are listed below.</p>
11    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_flow_definition::DescribeFlowDefinitionOutput::creation_time): <p>The timestamp when the flow definition was created.</p>
12    ///   - [`human_loop_request_source(Option<HumanLoopRequestSource>)`](crate::operation::describe_flow_definition::DescribeFlowDefinitionOutput::human_loop_request_source): <p>Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.</p>
13    ///   - [`human_loop_activation_config(Option<HumanLoopActivationConfig>)`](crate::operation::describe_flow_definition::DescribeFlowDefinitionOutput::human_loop_activation_config): <p>An object containing information about what triggers a human review workflow.</p>
14    ///   - [`human_loop_config(Option<HumanLoopConfig>)`](crate::operation::describe_flow_definition::DescribeFlowDefinitionOutput::human_loop_config): <p>An object containing information about who works on the task, the workforce task price, and other task details.</p>
15    ///   - [`output_config(Option<FlowDefinitionOutputConfig>)`](crate::operation::describe_flow_definition::DescribeFlowDefinitionOutput::output_config): <p>An object containing information about the output file.</p>
16    ///   - [`role_arn(Option<String>)`](crate::operation::describe_flow_definition::DescribeFlowDefinitionOutput::role_arn): <p>The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.</p>
17    ///   - [`failure_reason(Option<String>)`](crate::operation::describe_flow_definition::DescribeFlowDefinitionOutput::failure_reason): <p>The reason your flow definition failed.</p>
18    /// - On failure, responds with [`SdkError<DescribeFlowDefinitionError>`](crate::operation::describe_flow_definition::DescribeFlowDefinitionError)
19    pub fn describe_flow_definition(&self) -> crate::operation::describe_flow_definition::builders::DescribeFlowDefinitionFluentBuilder {
20        crate::operation::describe_flow_definition::builders::DescribeFlowDefinitionFluentBuilder::new(self.handle.clone())
21    }
22}