aws_sdk_iottwinmaker/client/
list_sync_resources.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 [`ListSyncResources`](crate::operation::list_sync_resources::builders::ListSyncResourcesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_sync_resources::builders::ListSyncResourcesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`workspace_id(impl Into<String>)`](crate::operation::list_sync_resources::builders::ListSyncResourcesFluentBuilder::workspace_id) / [`set_workspace_id(Option<String>)`](crate::operation::list_sync_resources::builders::ListSyncResourcesFluentBuilder::set_workspace_id):<br>required: **true**<br><p>The ID of the workspace that contains the sync job.</p><br>
8    ///   - [`sync_source(impl Into<String>)`](crate::operation::list_sync_resources::builders::ListSyncResourcesFluentBuilder::sync_source) / [`set_sync_source(Option<String>)`](crate::operation::list_sync_resources::builders::ListSyncResourcesFluentBuilder::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>
9    ///   - [`filters(SyncResourceFilter)`](crate::operation::list_sync_resources::builders::ListSyncResourcesFluentBuilder::filters) / [`set_filters(Option<Vec::<SyncResourceFilter>>)`](crate::operation::list_sync_resources::builders::ListSyncResourcesFluentBuilder::set_filters):<br>required: **false**<br><p>A list of objects that filter the request.</p> <p>The following filter combinations are supported:</p> <ul>  <li>   <p>Filter with state</p></li>  <li>   <p>Filter with ResourceType and ResourceId</p></li>  <li>   <p>Filter with ResourceType and ExternalId</p></li> </ul><br>
10    ///   - [`max_results(i32)`](crate::operation::list_sync_resources::builders::ListSyncResourcesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_sync_resources::builders::ListSyncResourcesFluentBuilder::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>
11    ///   - [`next_token(impl Into<String>)`](crate::operation::list_sync_resources::builders::ListSyncResourcesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_sync_resources::builders::ListSyncResourcesFluentBuilder::set_next_token):<br>required: **false**<br><p>The string that specifies the next page of results.</p><br>
12    /// - On success, responds with [`ListSyncResourcesOutput`](crate::operation::list_sync_resources::ListSyncResourcesOutput) with field(s):
13    ///   - [`sync_resources(Option<Vec::<SyncResourceSummary>>)`](crate::operation::list_sync_resources::ListSyncResourcesOutput::sync_resources): <p>The sync resources.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_sync_resources::ListSyncResourcesOutput::next_token): <p>The string that specifies the next page of results.</p>
15    /// - On failure, responds with [`SdkError<ListSyncResourcesError>`](crate::operation::list_sync_resources::ListSyncResourcesError)
16    pub fn list_sync_resources(&self) -> crate::operation::list_sync_resources::builders::ListSyncResourcesFluentBuilder {
17        crate::operation::list_sync_resources::builders::ListSyncResourcesFluentBuilder::new(self.handle.clone())
18    }
19}