aws_sdk_iottwinmaker/client/
get_sync_job.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 [`GetSyncJob`](crate::operation::get_sync_job::builders::GetSyncJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`sync_source(impl Into<String>)`](crate::operation::get_sync_job::builders::GetSyncJobFluentBuilder::sync_source) / [`set_sync_source(Option<String>)`](crate::operation::get_sync_job::builders::GetSyncJobFluentBuilder::set_sync_source):<br>required: **true**<br><p>The sync source.</p><note>  <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p> </note><br>
7    ///   - [`workspace_id(impl Into<String>)`](crate::operation::get_sync_job::builders::GetSyncJobFluentBuilder::workspace_id) / [`set_workspace_id(Option<String>)`](crate::operation::get_sync_job::builders::GetSyncJobFluentBuilder::set_workspace_id):<br>required: **false**<br><p>The workspace ID.</p><br>
8    /// - On success, responds with [`GetSyncJobOutput`](crate::operation::get_sync_job::GetSyncJobOutput) with field(s):
9    ///   - [`arn(String)`](crate::operation::get_sync_job::GetSyncJobOutput::arn): <p>The sync job ARN.</p>
10    ///   - [`workspace_id(String)`](crate::operation::get_sync_job::GetSyncJobOutput::workspace_id): <p>The ID of the workspace that contains the sync job.</p>
11    ///   - [`sync_source(String)`](crate::operation::get_sync_job::GetSyncJobOutput::sync_source): <p>The sync soucre.</p><note>  <p>Currently the only supported syncSource is <code>SITEWISE </code>.</p> </note>
12    ///   - [`sync_role(String)`](crate::operation::get_sync_job::GetSyncJobOutput::sync_role): <p>The sync IAM role.</p>
13    ///   - [`status(Option<SyncJobStatus>)`](crate::operation::get_sync_job::GetSyncJobOutput::status): <p>The SyncJob response status.</p>
14    ///   - [`creation_date_time(DateTime)`](crate::operation::get_sync_job::GetSyncJobOutput::creation_date_time): <p>The creation date and time.</p>
15    ///   - [`update_date_time(DateTime)`](crate::operation::get_sync_job::GetSyncJobOutput::update_date_time): <p>The update date and time.</p>
16    /// - On failure, responds with [`SdkError<GetSyncJobError>`](crate::operation::get_sync_job::GetSyncJobError)
17    pub fn get_sync_job(&self) -> crate::operation::get_sync_job::builders::GetSyncJobFluentBuilder {
18        crate::operation::get_sync_job::builders::GetSyncJobFluentBuilder::new(self.handle.clone())
19    }
20}