aws_sdk_mwaaserverless/client/get_workflow.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 [`GetWorkflow`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`workflow_arn(impl Into<String>)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::workflow_arn) / [`set_workflow_arn(Option<String>)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::set_workflow_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the workflow you want to retrieve.</p><br>
7 /// - [`workflow_version(impl Into<String>)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::workflow_version) / [`set_workflow_version(Option<String>)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::set_workflow_version):<br>required: **false**<br><p>Optional. The specific version of the workflow to retrieve. If not specified, the latest version is returned.</p><br>
8 /// - On success, responds with [`GetWorkflowOutput`](crate::operation::get_workflow::GetWorkflowOutput) with field(s):
9 /// - [`workflow_arn(String)`](crate::operation::get_workflow::GetWorkflowOutput::workflow_arn): <p>The Amazon Resource Name (ARN) of the workflow.</p>
10 /// - [`workflow_version(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::workflow_version): <p>The version identifier of the workflow.</p>
11 /// - [`name(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::name): <p>The name of the workflow.</p>
12 /// - [`description(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::description): <p>The description of the workflow.</p>
13 /// - [`created_at(Option<DateTime>)`](crate::operation::get_workflow::GetWorkflowOutput::created_at): <p>The timestamp when the workflow was created, in ISO 8601 date-time format.</p>
14 /// - [`modified_at(Option<DateTime>)`](crate::operation::get_workflow::GetWorkflowOutput::modified_at): <p>The timestamp when the workflow was last modified, in ISO 8601 date-time format.</p>
15 /// - [`encryption_configuration(Option<EncryptionConfiguration>)`](crate::operation::get_workflow::GetWorkflowOutput::encryption_configuration): <p>The encryption configuration for the workflow.</p>
16 /// - [`logging_configuration(Option<LoggingConfiguration>)`](crate::operation::get_workflow::GetWorkflowOutput::logging_configuration): <p>The logging configuration for the workflow.</p>
17 /// - [`engine_version(Option<i32>)`](crate::operation::get_workflow::GetWorkflowOutput::engine_version): <p>The version of the Amazon Managed Workflows for Apache Airflow Serverless engine that this workflow uses.</p>
18 /// - [`workflow_status(Option<WorkflowStatus>)`](crate::operation::get_workflow::GetWorkflowOutput::workflow_status): <p>The current status of the workflow.</p>
19 /// - [`definition_s3_location(Option<DefinitionS3Location>)`](crate::operation::get_workflow::GetWorkflowOutput::definition_s3_location): <p>The Amazon S3 location of the workflow definition file.</p>
20 /// - [`schedule_configuration(Option<ScheduleConfiguration>)`](crate::operation::get_workflow::GetWorkflowOutput::schedule_configuration): <p>The schedule configuration for the workflow, including cron expressions for automated execution. Amazon Managed Workflows for Apache Airflow Serverless uses EventBridge Scheduler for cost-effective, timezone-aware scheduling. When a workflow includes schedule information in its YAML definition, the service automatically configures the appropriate triggers for automated execution. Only one version of a workflow can have an active schedule at any given time.</p>
21 /// - [`role_arn(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::role_arn): <p>The Amazon Resource Name (ARN) of the IAM role used for workflow execution.</p>
22 /// - [`network_configuration(Option<NetworkConfiguration>)`](crate::operation::get_workflow::GetWorkflowOutput::network_configuration): <p>The network configuration for the workflow execution environment.</p>
23 /// - [`trigger_mode(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::trigger_mode): <p>The trigger mode for the workflow execution.</p>
24 /// - [`workflow_definition(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::workflow_definition): <p>The workflow definition content.</p>
25 /// - On failure, responds with [`SdkError<GetWorkflowError>`](crate::operation::get_workflow::GetWorkflowError)
26 pub fn get_workflow(&self) -> crate::operation::get_workflow::builders::GetWorkflowFluentBuilder {
27 crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::new(self.handle.clone())
28 }
29}