1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeDashboardSnapshotJob`](crate::operation::describe_dashboard_snapshot_job::builders::DescribeDashboardSnapshotJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::describe_dashboard_snapshot_job::builders::DescribeDashboardSnapshotJobFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::describe_dashboard_snapshot_job::builders::DescribeDashboardSnapshotJobFluentBuilder::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::builders::DescribeDashboardSnapshotJobFluentBuilder::dashboard_id) / [`set_dashboard_id(Option<String>)`](crate::operation::describe_dashboard_snapshot_job::builders::DescribeDashboardSnapshotJobFluentBuilder::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::builders::DescribeDashboardSnapshotJobFluentBuilder::snapshot_job_id) / [`set_snapshot_job_id(Option<String>)`](crate::operation::describe_dashboard_snapshot_job::builders::DescribeDashboardSnapshotJobFluentBuilder::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 [`DescribeDashboardSnapshotJobOutput`](crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobOutput) with field(s):
    ///   - [`aws_account_id(Option<String>)`](crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobOutput::aws_account_id): <p> The ID of the Amazon Web Services account that the dashboard snapshot job is executed in. </p>
    ///   - [`dashboard_id(Option<String>)`](crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobOutput::dashboard_id): <p>The ID of the dashboard that you have started a snapshot job for.</p>
    ///   - [`snapshot_job_id(Option<String>)`](crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobOutput::snapshot_job_id): <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>
    ///   - [`user_configuration(Option<SnapshotUserConfigurationRedacted>)`](crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobOutput::user_configuration): <p>The user configuration for the snapshot job. This information is provided when you make a <code>StartDashboardSnapshotJob</code> API call.</p>
    ///   - [`snapshot_configuration(Option<SnapshotConfiguration>)`](crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobOutput::snapshot_configuration): <p>The snapshot configuration of the job. This information is provided when you make a <code>StartDashboardSnapshotJob</code> API call.</p>
    ///   - [`arn(Option<String>)`](crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobOutput::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::DescribeDashboardSnapshotJobOutput::job_status): <p>Indicates the status of a job. The status updates as the job executes. This shows one of the following values.</p>  <ul>   <li> <p> <code>COMPLETED</code> - The job was completed successfully.</p> </li>   <li> <p> <code>FAILED</code> - The job failed to execute.</p> </li>   <li> <p> <code>QUEUED</code> - The job is queued and hasn't started yet.</p> </li>   <li> <p> <code>RUNNING</code> - The job is still running.</p> </li>  </ul>
    ///   - [`created_time(Option<DateTime>)`](crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobOutput::created_time): <p> The time that the snapshot job was created. </p>
    ///   - [`last_updated_time(Option<DateTime>)`](crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobOutput::last_updated_time): <p> The time that the snapshot job status was last updated. </p>
    ///   - [`request_id(Option<String>)`](crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobOutput::request_id): <p> The Amazon Web Services request ID for this operation. </p>
    ///   - [`status(i32)`](crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobOutput::status): <p>The HTTP status of the request</p>
    /// - On failure, responds with [`SdkError<DescribeDashboardSnapshotJobError>`](crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobError)
    pub fn describe_dashboard_snapshot_job(
        &self,
    ) -> crate::operation::describe_dashboard_snapshot_job::builders::DescribeDashboardSnapshotJobFluentBuilder {
        crate::operation::describe_dashboard_snapshot_job::builders::DescribeDashboardSnapshotJobFluentBuilder::new(self.handle.clone())
    }
}