aws_sdk_iottwinmaker/client/
list_sync_jobs.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 [`ListSyncJobs`](crate::operation::list_sync_jobs::builders::ListSyncJobsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_sync_jobs::builders::ListSyncJobsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`workspace_id(impl Into<String>)`](crate::operation::list_sync_jobs::builders::ListSyncJobsFluentBuilder::workspace_id) / [`set_workspace_id(Option<String>)`](crate::operation::list_sync_jobs::builders::ListSyncJobsFluentBuilder::set_workspace_id):<br>required: **true**<br><p>The ID of the workspace that contains the sync job.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_sync_jobs::builders::ListSyncJobsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_sync_jobs::builders::ListSyncJobsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return at one time. The default is 50.</p> <p>Valid Range: Minimum value of 0. Maximum value of 200.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_sync_jobs::builders::ListSyncJobsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_sync_jobs::builders::ListSyncJobsFluentBuilder::set_next_token):<br>required: **false**<br><p>The string that specifies the next page of results.</p><br>
10    /// - On success, responds with [`ListSyncJobsOutput`](crate::operation::list_sync_jobs::ListSyncJobsOutput) with field(s):
11    ///   - [`sync_job_summaries(Option<Vec::<SyncJobSummary>>)`](crate::operation::list_sync_jobs::ListSyncJobsOutput::sync_job_summaries): <p>The listed SyncJob summaries.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_sync_jobs::ListSyncJobsOutput::next_token): <p>The string that specifies the next page of results.</p>
13    /// - On failure, responds with [`SdkError<ListSyncJobsError>`](crate::operation::list_sync_jobs::ListSyncJobsError)
14    pub fn list_sync_jobs(&self) -> crate::operation::list_sync_jobs::builders::ListSyncJobsFluentBuilder {
15        crate::operation::list_sync_jobs::builders::ListSyncJobsFluentBuilder::new(self.handle.clone())
16    }
17}