aws_sdk_customerprofiles/client/
get_workflow.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetWorkflow`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_name(impl Into<String>)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::set_domain_name):<br>required: **true**<br><p>The unique name of the domain.</p><br>
    ///   - [`workflow_id(impl Into<String>)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::workflow_id) / [`set_workflow_id(Option<String>)`](crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::set_workflow_id):<br>required: **true**<br><p>Unique identifier for the workflow.</p><br>
    /// - On success, responds with [`GetWorkflowOutput`](crate::operation::get_workflow::GetWorkflowOutput) with field(s):
    ///   - [`workflow_id(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::workflow_id): <p>Unique identifier for the workflow.</p>
    ///   - [`workflow_type(Option<WorkflowType>)`](crate::operation::get_workflow::GetWorkflowOutput::workflow_type): <p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>
    ///   - [`status(Option<Status>)`](crate::operation::get_workflow::GetWorkflowOutput::status): <p>Status of workflow execution.</p>
    ///   - [`error_description(Option<String>)`](crate::operation::get_workflow::GetWorkflowOutput::error_description): <p>Workflow error messages during execution (if any).</p>
    ///   - [`start_date(Option<DateTime>)`](crate::operation::get_workflow::GetWorkflowOutput::start_date): <p>The timestamp that represents when workflow execution started.</p>
    ///   - [`last_updated_at(Option<DateTime>)`](crate::operation::get_workflow::GetWorkflowOutput::last_updated_at): <p>The timestamp that represents when workflow execution last updated.</p>
    ///   - [`attributes(Option<WorkflowAttributes>)`](crate::operation::get_workflow::GetWorkflowOutput::attributes): <p>Attributes provided for workflow execution.</p>
    ///   - [`metrics(Option<WorkflowMetrics>)`](crate::operation::get_workflow::GetWorkflowOutput::metrics): <p>Workflow specific execution metrics.</p>
    /// - On failure, responds with [`SdkError<GetWorkflowError>`](crate::operation::get_workflow::GetWorkflowError)
    pub fn get_workflow(&self) -> crate::operation::get_workflow::builders::GetWorkflowFluentBuilder {
        crate::operation::get_workflow::builders::GetWorkflowFluentBuilder::new(self.handle.clone())
    }
}