aws_sdk_connect/client/
search_workspace_associations.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 [`SearchWorkspaceAssociations`](crate::operation::search_workspace_associations::builders::SearchWorkspaceAssociationsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::search_workspace_associations::builders::SearchWorkspaceAssociationsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`instance_id(impl Into<String>)`](crate::operation::search_workspace_associations::builders::SearchWorkspaceAssociationsFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::search_workspace_associations::builders::SearchWorkspaceAssociationsFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::search_workspace_associations::builders::SearchWorkspaceAssociationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_workspace_associations::builders::SearchWorkspaceAssociationsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::search_workspace_associations::builders::SearchWorkspaceAssociationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_workspace_associations::builders::SearchWorkspaceAssociationsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page.</p><br>
10    ///   - [`search_filter(WorkspaceAssociationSearchFilter)`](crate::operation::search_workspace_associations::builders::SearchWorkspaceAssociationsFluentBuilder::search_filter) / [`set_search_filter(Option<WorkspaceAssociationSearchFilter>)`](crate::operation::search_workspace_associations::builders::SearchWorkspaceAssociationsFluentBuilder::set_search_filter):<br>required: **false**<br><p>Filters to apply to the search, such as tag-based filters.</p><br>
11    ///   - [`search_criteria(WorkspaceAssociationSearchCriteria)`](crate::operation::search_workspace_associations::builders::SearchWorkspaceAssociationsFluentBuilder::search_criteria) / [`set_search_criteria(Option<WorkspaceAssociationSearchCriteria>)`](crate::operation::search_workspace_associations::builders::SearchWorkspaceAssociationsFluentBuilder::set_search_criteria):<br>required: **false**<br><p>The search criteria, including workspace ID, resource ID, or resource type.</p><br>
12    /// - On success, responds with [`SearchWorkspaceAssociationsOutput`](crate::operation::search_workspace_associations::SearchWorkspaceAssociationsOutput) with field(s):
13    ///   - [`next_token(Option<String>)`](crate::operation::search_workspace_associations::SearchWorkspaceAssociationsOutput::next_token): <p>If there are additional results, this is the token for the next set of results.</p>
14    ///   - [`workspace_associations(Option<Vec::<WorkspaceAssociationSearchSummary>>)`](crate::operation::search_workspace_associations::SearchWorkspaceAssociationsOutput::workspace_associations): <p>A list of workspace associations that match the search criteria.</p>
15    ///   - [`approximate_total_count(Option<i64>)`](crate::operation::search_workspace_associations::SearchWorkspaceAssociationsOutput::approximate_total_count): <p>The approximate total number of workspace associations that match the search criteria.</p>
16    /// - On failure, responds with [`SdkError<SearchWorkspaceAssociationsError>`](crate::operation::search_workspace_associations::SearchWorkspaceAssociationsError)
17    pub fn search_workspace_associations(
18        &self,
19    ) -> crate::operation::search_workspace_associations::builders::SearchWorkspaceAssociationsFluentBuilder {
20        crate::operation::search_workspace_associations::builders::SearchWorkspaceAssociationsFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_connect/client/search_workspace_associations.rs

aws_sdk_connect/client/
search_workspace_associations.rs
