aws_sdk_sfn/client/describe_map_run.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 [`DescribeMapRun`](crate::operation::describe_map_run::builders::DescribeMapRunFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`map_run_arn(impl Into<String>)`](crate::operation::describe_map_run::builders::DescribeMapRunFluentBuilder::map_run_arn) / [`set_map_run_arn(Option<String>)`](crate::operation::describe_map_run::builders::DescribeMapRunFluentBuilder::set_map_run_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) that identifies a Map Run.</p><br>
7    /// - On success, responds with [`DescribeMapRunOutput`](crate::operation::describe_map_run::DescribeMapRunOutput) with field(s):
8    ///   - [`map_run_arn(String)`](crate::operation::describe_map_run::DescribeMapRunOutput::map_run_arn): <p>The Amazon Resource Name (ARN) that identifies a Map Run.</p>
9    ///   - [`execution_arn(String)`](crate::operation::describe_map_run::DescribeMapRunOutput::execution_arn): <p>The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.</p>
10    ///   - [`status(MapRunStatus)`](crate::operation::describe_map_run::DescribeMapRunOutput::status): <p>The current status of the Map Run.</p>
11    ///   - [`start_date(DateTime)`](crate::operation::describe_map_run::DescribeMapRunOutput::start_date): <p>The date when the Map Run was started.</p>
12    ///   - [`stop_date(Option<DateTime>)`](crate::operation::describe_map_run::DescribeMapRunOutput::stop_date): <p>The date when the Map Run was stopped.</p>
13    ///   - [`max_concurrency(i32)`](crate::operation::describe_map_run::DescribeMapRunOutput::max_concurrency): <p>The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.</p>
14    ///   - [`tolerated_failure_percentage(f32)`](crate::operation::describe_map_run::DescribeMapRunOutput::tolerated_failure_percentage): <p>The maximum percentage of failed child workflow executions before the Map Run fails.</p>
15    ///   - [`tolerated_failure_count(i64)`](crate::operation::describe_map_run::DescribeMapRunOutput::tolerated_failure_count): <p>The maximum number of failed child workflow executions before the Map Run fails.</p>
16    ///   - [`item_counts(Option<MapRunItemCounts>)`](crate::operation::describe_map_run::DescribeMapRunOutput::item_counts): <p>A JSON object that contains information about the total number of items, and the item count for each processing status, such as <code>pending</code> and <code>failed</code>.</p>
17    ///   - [`execution_counts(Option<MapRunExecutionCounts>)`](crate::operation::describe_map_run::DescribeMapRunOutput::execution_counts): <p>A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as <code>failed</code> and <code>succeeded</code>.</p>
18    ///   - [`redrive_count(Option<i32>)`](crate::operation::describe_map_run::DescribeMapRunOutput::redrive_count): <p>The number of times you've redriven a Map Run. If you have not yet redriven a Map Run, the <code>redriveCount</code> is 0. This count is only updated if you successfully redrive a Map Run.</p>
19    ///   - [`redrive_date(Option<DateTime>)`](crate::operation::describe_map_run::DescribeMapRunOutput::redrive_date): <p>The date a Map Run was last redriven. If you have not yet redriven a Map Run, the <code>redriveDate</code> is null.</p>
20    /// - On failure, responds with [`SdkError<DescribeMapRunError>`](crate::operation::describe_map_run::DescribeMapRunError)
21    pub fn describe_map_run(&self) -> crate::operation::describe_map_run::builders::DescribeMapRunFluentBuilder {
22        crate::operation::describe_map_run::builders::DescribeMapRunFluentBuilder::new(self.handle.clone())
23    }
24}