aws_sdk_appmesh/client/list_meshes.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 [`ListMeshes`](crate::operation::list_meshes::builders::ListMeshesFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_meshes::builders::ListMeshesFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`next_token(impl Into<String>)`](crate::operation::list_meshes::builders::ListMeshesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_meshes::builders::ListMeshesFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code>nextToken</code> value returned from a previous paginated <code>ListMeshes</code> request where <code>limit</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p><note> <p>This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.</p> </note><br>
8 /// - [`limit(i32)`](crate::operation::list_meshes::builders::ListMeshesFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::list_meshes::builders::ListMeshesFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of results returned by <code>ListMeshes</code> in paginated output. When you use this parameter, <code>ListMeshes</code> returns only <code>limit</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListMeshes</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, <code>ListMeshes</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p><br>
9 /// - On success, responds with [`ListMeshesOutput`](crate::operation::list_meshes::ListMeshesOutput) with field(s):
10 /// - [`meshes(Vec::<MeshRef>)`](crate::operation::list_meshes::ListMeshesOutput::meshes): <p>The list of existing service meshes.</p>
11 /// - [`next_token(Option<String>)`](crate::operation::list_meshes::ListMeshesOutput::next_token): <p>The <code>nextToken</code> value to include in a future <code>ListMeshes</code> request. When the results of a <code>ListMeshes</code> request exceed <code>limit</code>, you can use this value to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
12 /// - On failure, responds with [`SdkError<ListMeshesError>`](crate::operation::list_meshes::ListMeshesError)
13 pub fn list_meshes(&self) -> crate::operation::list_meshes::builders::ListMeshesFluentBuilder {
14 crate::operation::list_meshes::builders::ListMeshesFluentBuilder::new(self.handle.clone())
15 }
16}