aws_sdk_gamelift/client/delete_fleet_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 [`DeleteFleetLocations`](crate::operation::delete_fleet_locations::builders::DeleteFleetLocationsFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`fleet_id(impl Into<String>)`](crate::operation::delete_fleet_locations::builders::DeleteFleetLocationsFluentBuilder::fleet_id) / [`set_fleet_id(Option<String>)`](crate::operation::delete_fleet_locations::builders::DeleteFleetLocationsFluentBuilder::set_fleet_id):<br>required: **true**<br><p>A unique identifier for the fleet to delete locations for. You can use either the fleet ID or ARN value.</p><br>
7 /// - [`locations(impl Into<String>)`](crate::operation::delete_fleet_locations::builders::DeleteFleetLocationsFluentBuilder::locations) / [`set_locations(Option<Vec::<String>>)`](crate::operation::delete_fleet_locations::builders::DeleteFleetLocationsFluentBuilder::set_locations):<br>required: **true**<br><p>The list of fleet locations to delete. Specify locations in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p><br>
8 /// - On success, responds with [`DeleteFleetLocationsOutput`](crate::operation::delete_fleet_locations::DeleteFleetLocationsOutput) with field(s):
9 /// - [`fleet_id(Option<String>)`](crate::operation::delete_fleet_locations::DeleteFleetLocationsOutput::fleet_id): <p>A unique identifier for the fleet that location attributes are being deleted for.</p>
10 /// - [`fleet_arn(Option<String>)`](crate::operation::delete_fleet_locations::DeleteFleetLocationsOutput::fleet_arn): <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region> ::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 </region></code>.</p>
11 /// - [`location_states(Option<Vec::<LocationState>>)`](crate::operation::delete_fleet_locations::DeleteFleetLocationsOutput::location_states): <p>The remote locations that are being deleted, with each location status set to <code>DELETING</code>.</p>
12 /// - On failure, responds with [`SdkError<DeleteFleetLocationsError>`](crate::operation::delete_fleet_locations::DeleteFleetLocationsError)
13 pub fn delete_fleet_locations(&self) -> crate::operation::delete_fleet_locations::builders::DeleteFleetLocationsFluentBuilder {
14 crate::operation::delete_fleet_locations::builders::DeleteFleetLocationsFluentBuilder::new(self.handle.clone())
15 }
16}