aws_sdk_bedrockagentruntime/client/
get_execution_flow_snapshot.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 [`GetExecutionFlowSnapshot`](crate::operation::get_execution_flow_snapshot::builders::GetExecutionFlowSnapshotFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`flow_identifier(impl Into<String>)`](crate::operation::get_execution_flow_snapshot::builders::GetExecutionFlowSnapshotFluentBuilder::flow_identifier) / [`set_flow_identifier(Option<String>)`](crate::operation::get_execution_flow_snapshot::builders::GetExecutionFlowSnapshotFluentBuilder::set_flow_identifier):<br>required: **true**<br><p>The unique identifier of the flow.</p><br>
7    ///   - [`flow_alias_identifier(impl Into<String>)`](crate::operation::get_execution_flow_snapshot::builders::GetExecutionFlowSnapshotFluentBuilder::flow_alias_identifier) / [`set_flow_alias_identifier(Option<String>)`](crate::operation::get_execution_flow_snapshot::builders::GetExecutionFlowSnapshotFluentBuilder::set_flow_alias_identifier):<br>required: **true**<br><p>The unique identifier of the flow alias used for the flow execution.</p><br>
8    ///   - [`execution_identifier(impl Into<String>)`](crate::operation::get_execution_flow_snapshot::builders::GetExecutionFlowSnapshotFluentBuilder::execution_identifier) / [`set_execution_identifier(Option<String>)`](crate::operation::get_execution_flow_snapshot::builders::GetExecutionFlowSnapshotFluentBuilder::set_execution_identifier):<br>required: **true**<br><p>The unique identifier of the flow execution.</p><br>
9    /// - On success, responds with [`GetExecutionFlowSnapshotOutput`](crate::operation::get_execution_flow_snapshot::GetExecutionFlowSnapshotOutput) with field(s):
10    ///   - [`flow_identifier(String)`](crate::operation::get_execution_flow_snapshot::GetExecutionFlowSnapshotOutput::flow_identifier): <p>The unique identifier of the flow.</p>
11    ///   - [`flow_alias_identifier(String)`](crate::operation::get_execution_flow_snapshot::GetExecutionFlowSnapshotOutput::flow_alias_identifier): <p>The unique identifier of the flow alias used for the flow execution.</p>
12    ///   - [`flow_version(String)`](crate::operation::get_execution_flow_snapshot::GetExecutionFlowSnapshotOutput::flow_version): <p>The version of the flow used for the flow execution.</p>
13    ///   - [`execution_role_arn(String)`](crate::operation::get_execution_flow_snapshot::GetExecutionFlowSnapshotOutput::execution_role_arn): <p>The Amazon Resource Name (ARN) of the IAM service role that's used by the flow execution.</p>
14    ///   - [`definition(String)`](crate::operation::get_execution_flow_snapshot::GetExecutionFlowSnapshotOutput::definition): <p>The flow definition used for the flow execution, including the nodes, connections, and configuration at the time when the execution started.</p> <p>The definition returns as a string that follows the structure of a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_FlowDefinition.html">FlowDefinition</a> object.</p>
15    ///   - [`customer_encryption_key_arn(Option<String>)`](crate::operation::get_execution_flow_snapshot::GetExecutionFlowSnapshotOutput::customer_encryption_key_arn): <p>The Amazon Resource Name (ARN) of the customer managed KMS key that's used to encrypt the flow snapshot.</p>
16    /// - On failure, responds with [`SdkError<GetExecutionFlowSnapshotError>`](crate::operation::get_execution_flow_snapshot::GetExecutionFlowSnapshotError)
17    pub fn get_execution_flow_snapshot(&self) -> crate::operation::get_execution_flow_snapshot::builders::GetExecutionFlowSnapshotFluentBuilder {
18        crate::operation::get_execution_flow_snapshot::builders::GetExecutionFlowSnapshotFluentBuilder::new(self.handle.clone())
19    }
20}