aws-sdk-quicksight 1.130.0

AWS SDK for Amazon QuickSight
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeAutomationJob`](crate::operation::describe_automation_job::builders::DescribeAutomationJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::describe_automation_job::builders::DescribeAutomationJobFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::describe_automation_job::builders::DescribeAutomationJobFluentBuilder::set_aws_account_id):<br>required: **true**<br><p>The ID of the Amazon Web Services account that contains the automation job.</p><br>
    ///   - [`automation_group_id(impl Into<String>)`](crate::operation::describe_automation_job::builders::DescribeAutomationJobFluentBuilder::automation_group_id) / [`set_automation_group_id(Option<String>)`](crate::operation::describe_automation_job::builders::DescribeAutomationJobFluentBuilder::set_automation_group_id):<br>required: **true**<br><p>The ID of the automation group that contains the automation.</p><br>
    ///   - [`automation_id(impl Into<String>)`](crate::operation::describe_automation_job::builders::DescribeAutomationJobFluentBuilder::automation_id) / [`set_automation_id(Option<String>)`](crate::operation::describe_automation_job::builders::DescribeAutomationJobFluentBuilder::set_automation_id):<br>required: **true**<br><p>The ID of the automation that the job belongs to.</p><br>
    ///   - [`include_input_payload(bool)`](crate::operation::describe_automation_job::builders::DescribeAutomationJobFluentBuilder::include_input_payload) / [`set_include_input_payload(Option<bool>)`](crate::operation::describe_automation_job::builders::DescribeAutomationJobFluentBuilder::set_include_input_payload):<br>required: **false**<br><p>A Boolean value that indicates whether to include the input payload in the response. If set to <code>true</code>, the input payload will be included. If set to <code>false</code>, the input payload will be returned as <code>null</code>.</p><br>
    ///   - [`include_output_payload(bool)`](crate::operation::describe_automation_job::builders::DescribeAutomationJobFluentBuilder::include_output_payload) / [`set_include_output_payload(Option<bool>)`](crate::operation::describe_automation_job::builders::DescribeAutomationJobFluentBuilder::set_include_output_payload):<br>required: **false**<br><p>A Boolean value that indicates whether to include the output payload in the response. If set to <code>true</code>, the output payload will be included. If set to <code>false</code>, the output payload will be returned as <code>null</code>.</p><br>
    ///   - [`job_id(impl Into<String>)`](crate::operation::describe_automation_job::builders::DescribeAutomationJobFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::describe_automation_job::builders::DescribeAutomationJobFluentBuilder::set_job_id):<br>required: **true**<br><p>The ID of the automation job to describe.</p><br>
    /// - On success, responds with [`DescribeAutomationJobOutput`](crate::operation::describe_automation_job::DescribeAutomationJobOutput) with field(s):
    ///   - [`arn(String)`](crate::operation::describe_automation_job::DescribeAutomationJobOutput::arn): <p>The Amazon Resource Name (ARN) of the automation job.</p>
    ///   - [`created_at(Option<DateTime>)`](crate::operation::describe_automation_job::DescribeAutomationJobOutput::created_at): <p>The time that the automation job was created.</p>
    ///   - [`started_at(Option<DateTime>)`](crate::operation::describe_automation_job::DescribeAutomationJobOutput::started_at): <p>The time that the automation job started running.</p>
    ///   - [`ended_at(Option<DateTime>)`](crate::operation::describe_automation_job::DescribeAutomationJobOutput::ended_at): <p>The time that the automation job finished running.</p>
    ///   - [`job_status(AutomationJobStatus)`](crate::operation::describe_automation_job::DescribeAutomationJobOutput::job_status): <p>The current status of the automation job.</p>
    ///   - [`input_payload(Option<String>)`](crate::operation::describe_automation_job::DescribeAutomationJobOutput::input_payload): <p>The input payload that was provided when the automation job was started. This field is only included when <code>IncludeInputPayload</code> is set to <code>true</code> in the request.</p>
    ///   - [`output_payload(Option<String>)`](crate::operation::describe_automation_job::DescribeAutomationJobOutput::output_payload): <p>The output payload that was generated by the automation job. This field is only included when <code>IncludeOutputPayload</code> is set to <code>true</code> in the request.</p>
    ///   - [`request_id(Option<String>)`](crate::operation::describe_automation_job::DescribeAutomationJobOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
    /// - On failure, responds with [`SdkError<DescribeAutomationJobError>`](crate::operation::describe_automation_job::DescribeAutomationJobError)
    pub fn describe_automation_job(&self) -> crate::operation::describe_automation_job::builders::DescribeAutomationJobFluentBuilder {
        crate::operation::describe_automation_job::builders::DescribeAutomationJobFluentBuilder::new(self.handle.clone())
    }
}