1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeDashboardSnapshotJobResult`](crate::operation::describe_dashboard_snapshot_job_result::builders::DescribeDashboardSnapshotJobResultFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::describe_dashboard_snapshot_job_result::builders::DescribeDashboardSnapshotJobResultFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::describe_dashboard_snapshot_job_result::builders::DescribeDashboardSnapshotJobResultFluentBuilder::set_aws_account_id):<br>required: **true**<br><p>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</p><br>
    ///   - [`dashboard_id(impl Into<String>)`](crate::operation::describe_dashboard_snapshot_job_result::builders::DescribeDashboardSnapshotJobResultFluentBuilder::dashboard_id) / [`set_dashboard_id(Option<String>)`](crate::operation::describe_dashboard_snapshot_job_result::builders::DescribeDashboardSnapshotJobResultFluentBuilder::set_dashboard_id):<br>required: **true**<br><p>The ID of the dashboard that you have started a snapshot job for.</p><br>
    ///   - [`snapshot_job_id(impl Into<String>)`](crate::operation::describe_dashboard_snapshot_job_result::builders::DescribeDashboardSnapshotJobResultFluentBuilder::snapshot_job_id) / [`set_snapshot_job_id(Option<String>)`](crate::operation::describe_dashboard_snapshot_job_result::builders::DescribeDashboardSnapshotJobResultFluentBuilder::set_snapshot_job_id):<br>required: **true**<br><p>The ID of the job to be described. The job ID is set when you start a new job with a <code>StartDashboardSnapshotJob</code> API call.</p><br>
    /// - On success, responds with [`DescribeDashboardSnapshotJobResultOutput`](crate::operation::describe_dashboard_snapshot_job_result::DescribeDashboardSnapshotJobResultOutput) with field(s):
    ///   - [`arn(Option<String>)`](crate::operation::describe_dashboard_snapshot_job_result::DescribeDashboardSnapshotJobResultOutput::arn): <p>The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a <code>StartDashboardSnapshotJob</code> API call.</p>
    ///   - [`job_status(Option<SnapshotJobStatus>)`](crate::operation::describe_dashboard_snapshot_job_result::DescribeDashboardSnapshotJobResultOutput::job_status): <p>Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a <code>COMPLETED</code> or <code>FAILED</code> status.</p>
    ///   - [`created_time(Option<DateTime>)`](crate::operation::describe_dashboard_snapshot_job_result::DescribeDashboardSnapshotJobResultOutput::created_time): <p>The time that a snapshot job was created.</p>
    ///   - [`last_updated_time(Option<DateTime>)`](crate::operation::describe_dashboard_snapshot_job_result::DescribeDashboardSnapshotJobResultOutput::last_updated_time): <p>The time that a snapshot job status was last updated.</p>
    ///   - [`result(Option<SnapshotJobResult>)`](crate::operation::describe_dashboard_snapshot_job_result::DescribeDashboardSnapshotJobResultOutput::result): <p>The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.</p>
    ///   - [`error_info(Option<SnapshotJobErrorInfo>)`](crate::operation::describe_dashboard_snapshot_job_result::DescribeDashboardSnapshotJobResultOutput::error_info): <p>Displays information for the error that caused a job to fail.</p>
    ///   - [`request_id(Option<String>)`](crate::operation::describe_dashboard_snapshot_job_result::DescribeDashboardSnapshotJobResultOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
    ///   - [`status(i32)`](crate::operation::describe_dashboard_snapshot_job_result::DescribeDashboardSnapshotJobResultOutput::status): <p>The HTTP status of the request</p>
    /// - On failure, responds with [`SdkError<DescribeDashboardSnapshotJobResultError>`](crate::operation::describe_dashboard_snapshot_job_result::DescribeDashboardSnapshotJobResultError)
    pub fn describe_dashboard_snapshot_job_result(
        &self,
    ) -> crate::operation::describe_dashboard_snapshot_job_result::builders::DescribeDashboardSnapshotJobResultFluentBuilder {
        crate::operation::describe_dashboard_snapshot_job_result::builders::DescribeDashboardSnapshotJobResultFluentBuilder::new(self.handle.clone())
    }
}