aws_sdk_gamelift/client/
list_locations.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 [`ListLocations`](crate::operation::list_locations::builders::ListLocationsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_locations::builders::ListLocationsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`filters(LocationFilter)`](crate::operation::list_locations::builders::ListLocationsFluentBuilder::filters) / [`set_filters(Option<Vec::<LocationFilter>>)`](crate::operation::list_locations::builders::ListLocationsFluentBuilder::set_filters):<br>required: **false**<br><p>Filters the list for <code>AWS</code> or <code>CUSTOM</code> locations. Use this parameter to narrow down results to only Amazon Web Services-managed locations (Amazon EC2 or container) or only your custom locations (such as an Amazon GameLift Servers Anywhere fleet).</p><br>
8    ///   - [`limit(i32)`](crate::operation::list_locations::builders::ListLocationsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::list_locations::builders::ListLocationsFluentBuilder::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_locations::builders::ListLocationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_locations::builders::ListLocationsFluentBuilder::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 [`ListLocationsOutput`](crate::operation::list_locations::ListLocationsOutput) with field(s):
11    ///   - [`locations(Option<Vec::<LocationModel>>)`](crate::operation::list_locations::ListLocationsOutput::locations): <p>A collection of locations, including both Amazon Web Services and custom locations. Each location includes a name and ping beacon information that can be used to measure network latency between player devices and the location.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_locations::ListLocationsOutput::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<ListLocationsError>`](crate::operation::list_locations::ListLocationsError)
14    pub fn list_locations(&self) -> crate::operation::list_locations::builders::ListLocationsFluentBuilder {
15        crate::operation::list_locations::builders::ListLocationsFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_gamelift/client/list_locations.rs

aws_sdk_gamelift/client/
list_locations.rs
