aws_sdk_gamelift/client/list_fleet_deployments.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 [`ListFleetDeployments`](crate::operation::list_fleet_deployments::builders::ListFleetDeploymentsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_fleet_deployments::builders::ListFleetDeploymentsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`fleet_id(impl Into<String>)`](crate::operation::list_fleet_deployments::builders::ListFleetDeploymentsFluentBuilder::fleet_id) / [`set_fleet_id(Option<String>)`](crate::operation::list_fleet_deployments::builders::ListFleetDeploymentsFluentBuilder::set_fleet_id):<br>required: **false**<br><p>A unique identifier for the container fleet. You can use either the fleet ID or ARN value.</p><br>
8 /// - [`limit(i32)`](crate::operation::list_fleet_deployments::builders::ListFleetDeploymentsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::list_fleet_deployments::builders::ListFleetDeploymentsFluentBuilder::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_fleet_deployments::builders::ListFleetDeploymentsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_fleet_deployments::builders::ListFleetDeploymentsFluentBuilder::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 [`ListFleetDeploymentsOutput`](crate::operation::list_fleet_deployments::ListFleetDeploymentsOutput) with field(s):
11 /// - [`fleet_deployments(Option<Vec::<FleetDeployment>>)`](crate::operation::list_fleet_deployments::ListFleetDeploymentsOutput::fleet_deployments): <p>The requested deployment information.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_fleet_deployments::ListFleetDeploymentsOutput::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<ListFleetDeploymentsError>`](crate::operation::list_fleet_deployments::ListFleetDeploymentsError)
14 pub fn list_fleet_deployments(&self) -> crate::operation::list_fleet_deployments::builders::ListFleetDeploymentsFluentBuilder {
15 crate::operation::list_fleet_deployments::builders::ListFleetDeploymentsFluentBuilder::new(self.handle.clone())
16 }
17}