aws_sdk_proton/client/
list_service_instances.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 [`ListServiceInstances`](crate::operation::list_service_instances::builders::ListServiceInstancesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_service_instances::builders::ListServiceInstancesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`service_name(impl Into<String>)`](crate::operation::list_service_instances::builders::ListServiceInstancesFluentBuilder::service_name) / [`set_service_name(Option<String>)`](crate::operation::list_service_instances::builders::ListServiceInstancesFluentBuilder::set_service_name):<br>required: **false**<br><p>The name of the service that the service instance belongs to.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_service_instances::builders::ListServiceInstancesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_service_instances::builders::ListServiceInstancesFluentBuilder::set_next_token):<br>required: **false**<br><p>A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_service_instances::builders::ListServiceInstancesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_service_instances::builders::ListServiceInstancesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of service instances to list.</p><br>
10    ///   - [`filters(ListServiceInstancesFilter)`](crate::operation::list_service_instances::builders::ListServiceInstancesFluentBuilder::filters) / [`set_filters(Option<Vec::<ListServiceInstancesFilter>>)`](crate::operation::list_service_instances::builders::ListServiceInstancesFluentBuilder::set_filters):<br>required: **false**<br><p>An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.</p><br>
11    ///   - [`sort_by(ListServiceInstancesSortBy)`](crate::operation::list_service_instances::builders::ListServiceInstancesFluentBuilder::sort_by) / [`set_sort_by(Option<ListServiceInstancesSortBy>)`](crate::operation::list_service_instances::builders::ListServiceInstancesFluentBuilder::set_sort_by):<br>required: **false**<br><p>The field that the result list is sorted by.</p> <p>When you choose to sort by <code>serviceName</code>, service instances within each service are sorted by service instance name.</p> <p>Default: <code>serviceName</code></p><br>
12    ///   - [`sort_order(SortOrder)`](crate::operation::list_service_instances::builders::ListServiceInstancesFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_service_instances::builders::ListServiceInstancesFluentBuilder::set_sort_order):<br>required: **false**<br><p>Result list sort order.</p> <p>Default: <code>ASCENDING</code></p><br>
13    /// - On success, responds with [`ListServiceInstancesOutput`](crate::operation::list_service_instances::ListServiceInstancesOutput) with field(s):
14    ///   - [`next_token(Option<String>)`](crate::operation::list_service_instances::ListServiceInstancesOutput::next_token): <p>A token that indicates the location of the next service instance in the array of service instances, after the current requested list of service instances.</p>
15    ///   - [`service_instances(Vec::<ServiceInstanceSummary>)`](crate::operation::list_service_instances::ListServiceInstancesOutput::service_instances): <p>An array of service instances with summary data.</p>
16    /// - On failure, responds with [`SdkError<ListServiceInstancesError>`](crate::operation::list_service_instances::ListServiceInstancesError)
17    pub fn list_service_instances(&self) -> crate::operation::list_service_instances::builders::ListServiceInstancesFluentBuilder {
18        crate::operation::list_service_instances::builders::ListServiceInstancesFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_proton/client/list_service_instances.rs

aws_sdk_proton/client/
list_service_instances.rs
