aws_sdk_gamelift/client/
list_container_fleets.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 [`ListContainerFleets`](crate::operation::list_container_fleets::builders::ListContainerFleetsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_container_fleets::builders::ListContainerFleetsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`container_group_definition_name(impl Into<String>)`](crate::operation::list_container_fleets::builders::ListContainerFleetsFluentBuilder::container_group_definition_name) / [`set_container_group_definition_name(Option<String>)`](crate::operation::list_container_fleets::builders::ListContainerFleetsFluentBuilder::set_container_group_definition_name):<br>required: **false**<br><p>The container group definition to filter the list on. Use this parameter to retrieve only those fleets that use the specified container group definition. You can specify the container group definition's name to get fleets with the latest versions. Alternatively, provide an ARN value to get fleets with a specific version number.</p><br>
8    ///   - [`limit(i32)`](crate::operation::list_container_fleets::builders::ListContainerFleetsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::list_container_fleets::builders::ListContainerFleetsFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_container_fleets::builders::ListContainerFleetsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_container_fleets::builders::ListContainerFleetsFluentBuilder::set_next_token):<br>required: **false**<br><p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.</p><br>
10    /// - On success, responds with [`ListContainerFleetsOutput`](crate::operation::list_container_fleets::ListContainerFleetsOutput) with field(s):
11    ///   - [`container_fleets(Option<Vec::<ContainerFleet>>)`](crate::operation::list_container_fleets::ListContainerFleetsOutput::container_fleets): <p>A collection of container fleet objects for all fleets that match the request criteria.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_container_fleets::ListContainerFleetsOutput::next_token): <p>A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.</p>
13    /// - On failure, responds with [`SdkError<ListContainerFleetsError>`](crate::operation::list_container_fleets::ListContainerFleetsError)
14    pub fn list_container_fleets(&self) -> crate::operation::list_container_fleets::builders::ListContainerFleetsFluentBuilder {
15        crate::operation::list_container_fleets::builders::ListContainerFleetsFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_gamelift/client/list_container_fleets.rs

aws_sdk_gamelift/client/
list_container_fleets.rs
