aws_sdk_bedrockagent/client/

create_flow.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateFlow`](crate::operation::create_flow::builders::CreateFlowFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::create_flow::builders::CreateFlowFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_flow::builders::CreateFlowFluentBuilder::set_name):<br>required: **true**<br><p>A name for the flow.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::create_flow::builders::CreateFlowFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_flow::builders::CreateFlowFluentBuilder::set_description):<br>required: **false**<br><p>A description for the flow.</p><br>
    ///   - [`execution_role_arn(impl Into<String>)`](crate::operation::create_flow::builders::CreateFlowFluentBuilder::execution_role_arn) / [`set_execution_role_arn(Option<String>)`](crate::operation::create_flow::builders::CreateFlowFluentBuilder::set_execution_role_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service role for flows in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p><br>
    ///   - [`customer_encryption_key_arn(impl Into<String>)`](crate::operation::create_flow::builders::CreateFlowFluentBuilder::customer_encryption_key_arn) / [`set_customer_encryption_key_arn(Option<String>)`](crate::operation::create_flow::builders::CreateFlowFluentBuilder::set_customer_encryption_key_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.</p><br>
    ///   - [`definition(FlowDefinition)`](crate::operation::create_flow::builders::CreateFlowFluentBuilder::definition) / [`set_definition(Option<FlowDefinition>)`](crate::operation::create_flow::builders::CreateFlowFluentBuilder::set_definition):<br>required: **false**<br><p>A definition of the nodes and connections between nodes in the flow.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::create_flow::builders::CreateFlowFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_flow::builders::CreateFlowFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_flow::builders::CreateFlowFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_flow::builders::CreateFlowFluentBuilder::set_tags):<br>required: **false**<br><p>Any tags that you want to attach to the flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html">Tagging resources in Amazon Bedrock</a>.</p><br>
    /// - On success, responds with [`CreateFlowOutput`](crate::operation::create_flow::CreateFlowOutput) with field(s):
    ///   - [`name(String)`](crate::operation::create_flow::CreateFlowOutput::name): <p>The name of the flow.</p>
    ///   - [`description(Option<String>)`](crate::operation::create_flow::CreateFlowOutput::description): <p>The description of the flow.</p>
    ///   - [`execution_role_arn(String)`](crate::operation::create_flow::CreateFlowOutput::execution_role_arn): <p>The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service role for flows in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
    ///   - [`customer_encryption_key_arn(Option<String>)`](crate::operation::create_flow::CreateFlowOutput::customer_encryption_key_arn): <p>The Amazon Resource Name (ARN) of the KMS key that you encrypted the flow with.</p>
    ///   - [`id(String)`](crate::operation::create_flow::CreateFlowOutput::id): <p>The unique identifier of the flow.</p>
    ///   - [`arn(String)`](crate::operation::create_flow::CreateFlowOutput::arn): <p>The Amazon Resource Name (ARN) of the flow.</p>
    ///   - [`status(FlowStatus)`](crate::operation::create_flow::CreateFlowOutput::status): <p>The status of the flow. When you submit this request, the status will be <code>NotPrepared</code>. If creation fails, the status becomes <code>Failed</code>.</p>
    ///   - [`created_at(DateTime)`](crate::operation::create_flow::CreateFlowOutput::created_at): <p>The time at which the flow was created.</p>
    ///   - [`updated_at(DateTime)`](crate::operation::create_flow::CreateFlowOutput::updated_at): <p>The time at which the flow was last updated.</p>
    ///   - [`version(String)`](crate::operation::create_flow::CreateFlowOutput::version): <p>The version of the flow. When you create a flow, the version created is the <code>DRAFT</code> version.</p>
    ///   - [`definition(Option<FlowDefinition>)`](crate::operation::create_flow::CreateFlowOutput::definition): <p>A definition of the nodes and connections between nodes in the flow.</p>
    /// - On failure, responds with [`SdkError<CreateFlowError>`](crate::operation::create_flow::CreateFlowError)
    pub fn create_flow(&self) -> crate::operation::create_flow::builders::CreateFlowFluentBuilder {
        crate::operation::create_flow::builders::CreateFlowFluentBuilder::new(self.handle.clone())
    }
}