aws_sdk_licensemanagerusersubscriptions/client/
list_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 [`ListInstances`](crate::operation::list_instances::builders::ListInstancesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`max_results(i32)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return from a single request.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::set_next_token):<br>required: **false**<br><p>A token to specify where to start paginating. This is the nextToken from a previously truncated response.</p><br>
9    ///   - [`filters(Filter)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::list_instances::builders::ListInstancesFluentBuilder::set_filters):<br>required: **false**<br><p>You can use the following filters to streamline results:</p> <ul>  <li>   <p>Status</p></li>  <li>   <p>InstanceId</p></li> </ul><br>
10    /// - On success, responds with [`ListInstancesOutput`](crate::operation::list_instances::ListInstancesOutput) with field(s):
11    ///   - [`instance_summaries(Option<Vec::<InstanceSummary>>)`](crate::operation::list_instances::ListInstancesOutput::instance_summaries): <p>An array of <code>InstanceSummary</code> resources that contain details about the instances that provide user-based subscriptions and also meet the request criteria.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_instances::ListInstancesOutput::next_token): <p>The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.</p>
13    /// - On failure, responds with [`SdkError<ListInstancesError>`](crate::operation::list_instances::ListInstancesError)
14    pub fn list_instances(&self) -> crate::operation::list_instances::builders::ListInstancesFluentBuilder {
15        crate::operation::list_instances::builders::ListInstancesFluentBuilder::new(self.handle.clone())
16    }
17}