// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[derive(Debug)]
pub(crate) struct Handle {
pub(crate) client: aws_smithy_client::Client<
aws_smithy_client::erase::DynConnector,
aws_smithy_client::erase::DynMiddleware<aws_smithy_client::erase::DynConnector>,
>,
pub(crate) conf: crate::Config,
}
/// Client for Amazon GameLift
///
/// Client for invoking operations on Amazon GameLift. Each operation on Amazon GameLift is a method on this
/// this struct. `.send()` MUST be invoked on the generated operations to dispatch the request to the service.
///
/// # Examples
/// **Constructing a client and invoking an operation**
/// ```rust,no_run
/// # async fn docs() {
/// // create a shared configuration. This can be used & shared between multiple service clients.
/// let shared_config = aws_config::load_from_env().await;
/// let client = aws_sdk_gamelift::Client::new(&shared_config);
/// // invoke an operation
/// /* let rsp = client
/// .<operation_name>().
/// .<param>("some value")
/// .send().await; */
/// # }
/// ```
/// **Constructing a client with custom configuration**
/// ```rust,no_run
/// use aws_config::retry::RetryConfig;
/// # async fn docs() {
/// let shared_config = aws_config::load_from_env().await;
/// let config = aws_sdk_gamelift::config::Builder::from(&shared_config)
/// .retry_config(RetryConfig::disabled())
/// .build();
/// let client = aws_sdk_gamelift::Client::from_conf(config);
/// # }
#[derive(std::fmt::Debug)]
pub struct Client {
handle: std::sync::Arc<Handle>,
}
impl std::clone::Clone for Client {
fn clone(&self) -> Self {
Self {
handle: self.handle.clone(),
}
}
}
#[doc(inline)]
pub use aws_smithy_client::Builder;
impl
From<
aws_smithy_client::Client<
aws_smithy_client::erase::DynConnector,
aws_smithy_client::erase::DynMiddleware<aws_smithy_client::erase::DynConnector>,
>,
> for Client
{
fn from(
client: aws_smithy_client::Client<
aws_smithy_client::erase::DynConnector,
aws_smithy_client::erase::DynMiddleware<aws_smithy_client::erase::DynConnector>,
>,
) -> Self {
Self::with_config(client, crate::Config::builder().build())
}
}
impl Client {
/// Creates a client with the given service configuration.
pub fn with_config(
client: aws_smithy_client::Client<
aws_smithy_client::erase::DynConnector,
aws_smithy_client::erase::DynMiddleware<aws_smithy_client::erase::DynConnector>,
>,
conf: crate::Config,
) -> Self {
Self {
handle: std::sync::Arc::new(Handle { client, conf }),
}
}
/// Returns the client's configuration.
pub fn conf(&self) -> &crate::Config {
&self.handle.conf
}
}
impl Client {
/// Constructs a fluent builder for the [`AcceptMatch`](crate::client::fluent_builders::AcceptMatch) operation.
///
/// - The fluent builder is configurable:
/// - [`ticket_id(impl Into<String>)`](crate::client::fluent_builders::AcceptMatch::ticket_id) / [`set_ticket_id(Option<String>)`](crate::client::fluent_builders::AcceptMatch::set_ticket_id): <p>A unique identifier for a matchmaking ticket. The ticket must be in status <code>REQUIRES_ACCEPTANCE</code>; otherwise this request will fail.</p>
/// - [`player_ids(Vec<String>)`](crate::client::fluent_builders::AcceptMatch::player_ids) / [`set_player_ids(Option<Vec<String>>)`](crate::client::fluent_builders::AcceptMatch::set_player_ids): <p>A unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.</p>
/// - [`acceptance_type(AcceptanceType)`](crate::client::fluent_builders::AcceptMatch::acceptance_type) / [`set_acceptance_type(Option<AcceptanceType>)`](crate::client::fluent_builders::AcceptMatch::set_acceptance_type): <p>Player response to the proposed match.</p>
/// - On success, responds with [`AcceptMatchOutput`](crate::output::AcceptMatchOutput)
/// - On failure, responds with [`SdkError<AcceptMatchError>`](crate::error::AcceptMatchError)
pub fn accept_match(&self) -> fluent_builders::AcceptMatch {
fluent_builders::AcceptMatch::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ClaimGameServer`](crate::client::fluent_builders::ClaimGameServer) operation.
///
/// - The fluent builder is configurable:
/// - [`game_server_group_name(impl Into<String>)`](crate::client::fluent_builders::ClaimGameServer::game_server_group_name) / [`set_game_server_group_name(Option<String>)`](crate::client::fluent_builders::ClaimGameServer::set_game_server_group_name): <p>A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want GameLift FleetIQ to look for an available game server to claim. </p>
/// - [`game_server_id(impl Into<String>)`](crate::client::fluent_builders::ClaimGameServer::game_server_id) / [`set_game_server_id(Option<String>)`](crate::client::fluent_builders::ClaimGameServer::set_game_server_id): <p>A custom string that uniquely identifies the game server to claim. If this parameter is left empty, GameLift FleetIQ searches for an available game server in the specified game server group.</p>
/// - [`game_server_data(impl Into<String>)`](crate::client::fluent_builders::ClaimGameServer::game_server_data) / [`set_game_server_data(Option<String>)`](crate::client::fluent_builders::ClaimGameServer::set_game_server_data): <p>A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers. </p>
/// - On success, responds with [`ClaimGameServerOutput`](crate::output::ClaimGameServerOutput) with field(s):
/// - [`game_server(Option<GameServer>)`](crate::output::ClaimGameServerOutput::game_server): <p>Object that describes the newly claimed game server.</p>
/// - On failure, responds with [`SdkError<ClaimGameServerError>`](crate::error::ClaimGameServerError)
pub fn claim_game_server(&self) -> fluent_builders::ClaimGameServer {
fluent_builders::ClaimGameServer::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateAlias`](crate::client::fluent_builders::CreateAlias) operation.
///
/// - The fluent builder is configurable:
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::CreateAlias::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::CreateAlias::set_name): <p>A descriptive label that is associated with an alias. Alias names do not need to be unique.</p>
/// - [`description(impl Into<String>)`](crate::client::fluent_builders::CreateAlias::description) / [`set_description(Option<String>)`](crate::client::fluent_builders::CreateAlias::set_description): <p>A human-readable description of the alias.</p>
/// - [`routing_strategy(RoutingStrategy)`](crate::client::fluent_builders::CreateAlias::routing_strategy) / [`set_routing_strategy(Option<RoutingStrategy>)`](crate::client::fluent_builders::CreateAlias::set_routing_strategy): <p>The routing configuration, including routing type and fleet target, for the alias. </p>
/// - [`tags(Vec<Tag>)`](crate::client::fluent_builders::CreateAlias::tags) / [`set_tags(Option<Vec<Tag>>)`](crate::client::fluent_builders::CreateAlias::set_tags): <p>A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
/// - On success, responds with [`CreateAliasOutput`](crate::output::CreateAliasOutput) with field(s):
/// - [`alias(Option<Alias>)`](crate::output::CreateAliasOutput::alias): <p>The newly created alias resource.</p>
/// - On failure, responds with [`SdkError<CreateAliasError>`](crate::error::CreateAliasError)
pub fn create_alias(&self) -> fluent_builders::CreateAlias {
fluent_builders::CreateAlias::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateBuild`](crate::client::fluent_builders::CreateBuild) operation.
///
/// - The fluent builder is configurable:
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::CreateBuild::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::CreateBuild::set_name): <p>A descriptive label associated with a build. Build names do not need to be unique. You can change this value later. </p>
/// - [`version(impl Into<String>)`](crate::client::fluent_builders::CreateBuild::version) / [`set_version(Option<String>)`](crate::client::fluent_builders::CreateBuild::set_version): <p>Version information associated with a build or script. Version strings do not need to be unique. You can change this value later. </p>
/// - [`storage_location(S3Location)`](crate::client::fluent_builders::CreateBuild::storage_location) / [`set_storage_location(Option<S3Location>)`](crate::client::fluent_builders::CreateBuild::set_storage_location): <p>Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.</p> <p>If a <code>StorageLocation</code> is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift will report a <code>SizeOnDisk</code> of 0. </p>
/// - [`operating_system(OperatingSystem)`](crate::client::fluent_builders::CreateBuild::operating_system) / [`set_operating_system(Option<OperatingSystem>)`](crate::client::fluent_builders::CreateBuild::set_operating_system): <p>The operating system that you built the game server binaries to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.</p>
/// - [`tags(Vec<Tag>)`](crate::client::fluent_builders::CreateBuild::tags) / [`set_tags(Option<Vec<Tag>>)`](crate::client::fluent_builders::CreateBuild::set_tags): <p>A list of labels to assign to the new build resource. Tags are developer defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. Once the resource is created, you can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html">TagResource</a>, <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html">UntagResource</a>, and <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html">ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.</p>
/// - [`server_sdk_version(impl Into<String>)`](crate::client::fluent_builders::CreateBuild::server_sdk_version) / [`set_server_sdk_version(Option<String>)`](crate::client::fluent_builders::CreateBuild::set_server_sdk_version): <p>A server SDK version you used when integrating your game server build with GameLift. For more information see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html">Integrate games with custom game servers</a>.</p>
/// - On success, responds with [`CreateBuildOutput`](crate::output::CreateBuildOutput) with field(s):
/// - [`build_value(Option<Build>)`](crate::output::CreateBuildOutput::build_value): <p>The newly created build resource, including a unique build IDs and status. </p>
/// - [`upload_credentials(Option<AwsCredentials>)`](crate::output::CreateBuildOutput::upload_credentials): <p>This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an Amazon S3 bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these credentials, call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_RequestUploadCredentials.html">RequestUploadCredentials</a>. </p>
/// - [`storage_location(Option<S3Location>)`](crate::output::CreateBuildOutput::storage_location): <p>Amazon S3 location for your game build file, including bucket name and key.</p>
/// - On failure, responds with [`SdkError<CreateBuildError>`](crate::error::CreateBuildError)
pub fn create_build(&self) -> fluent_builders::CreateBuild {
fluent_builders::CreateBuild::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateFleet`](crate::client::fluent_builders::CreateFleet) operation.
///
/// - The fluent builder is configurable:
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::CreateFleet::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::CreateFleet::set_name): <p>A descriptive label that is associated with a fleet. Fleet names do not need to be unique.</p>
/// - [`description(impl Into<String>)`](crate::client::fluent_builders::CreateFleet::description) / [`set_description(Option<String>)`](crate::client::fluent_builders::CreateFleet::set_description): <p>A description for the fleet.</p>
/// - [`build_id(impl Into<String>)`](crate::client::fluent_builders::CreateFleet::build_id) / [`set_build_id(Option<String>)`](crate::client::fluent_builders::CreateFleet::set_build_id): <p>The unique identifier for a custom game server build to be deployed on fleet instances. You can use either the build ID or ARN. The build must be uploaded to GameLift and in <code>READY</code> status. This fleet property cannot be changed later.</p>
/// - [`script_id(impl Into<String>)`](crate::client::fluent_builders::CreateFleet::script_id) / [`set_script_id(Option<String>)`](crate::client::fluent_builders::CreateFleet::set_script_id): <p>The unique identifier for a Realtime configuration script to be deployed on fleet instances. You can use either the script ID or ARN. Scripts must be uploaded to GameLift prior to creating the fleet. This fleet property cannot be changed later.</p>
/// - [`server_launch_path(impl Into<String>)`](crate::client::fluent_builders::CreateFleet::server_launch_path) / [`set_server_launch_path(Option<String>)`](crate::client::fluent_builders::CreateFleet::set_server_launch_path): <p> <b>This parameter is no longer used.</b> Specify a server launch path using the <code>RuntimeConfiguration</code> parameter. Requests that use this parameter instead continue to be valid.</p>
/// - [`server_launch_parameters(impl Into<String>)`](crate::client::fluent_builders::CreateFleet::server_launch_parameters) / [`set_server_launch_parameters(Option<String>)`](crate::client::fluent_builders::CreateFleet::set_server_launch_parameters): <p> <b>This parameter is no longer used.</b> Specify server launch parameters using the <code>RuntimeConfiguration</code> parameter. Requests that use this parameter instead continue to be valid.</p>
/// - [`log_paths(Vec<String>)`](crate::client::fluent_builders::CreateFleet::log_paths) / [`set_log_paths(Option<Vec<String>>)`](crate::client::fluent_builders::CreateFleet::set_log_paths): <p> <b>This parameter is no longer used.</b> To specify where GameLift should store log files once a server process shuts down, use the GameLift server API <code>ProcessReady()</code> and specify one or more directory paths in <code>logParameters</code>. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize">Initialize the server process</a> in the <i>GameLift Developer Guide</i>. </p>
/// - [`ec2_instance_type(Ec2InstanceType)`](crate::client::fluent_builders::CreateFleet::ec2_instance_type) / [`set_ec2_instance_type(Option<Ec2InstanceType>)`](crate::client::fluent_builders::CreateFleet::set_ec2_instance_type): <p>The GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See <a href="http://aws.amazon.com/ec2/instance-types/">Amazon Elastic Compute Cloud Instance Types</a> for detailed descriptions of Amazon EC2 instance types.</p>
/// - [`ec2_inbound_permissions(Vec<IpPermission>)`](crate::client::fluent_builders::CreateFleet::ec2_inbound_permissions) / [`set_ec2_inbound_permissions(Option<Vec<IpPermission>>)`](crate::client::fluent_builders::CreateFleet::set_ec2_inbound_permissions): <p>The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, GameLift automatically sets TCP and UDP ranges. </p>
/// - [`new_game_session_protection_policy(ProtectionPolicy)`](crate::client::fluent_builders::CreateFleet::new_game_session_protection_policy) / [`set_new_game_session_protection_policy(Option<ProtectionPolicy>)`](crate::client::fluent_builders::CreateFleet::set_new_game_session_protection_policy): <p>The status of termination protection for active game sessions on the fleet. By default, this property is set to <code>NoProtection</code>. You can also set game session protection for an individual game session by calling <a href="gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a>.</p> <ul> <li> <p> <b>NoProtection</b> - Game sessions can be terminated during active gameplay as a result of a scale-down event. </p> </li> <li> <p> <b>FullProtection</b> - Game sessions in <code>ACTIVE</code> status cannot be terminated during a scale-down event.</p> </li> </ul>
/// - [`runtime_configuration(RuntimeConfiguration)`](crate::client::fluent_builders::CreateFleet::runtime_configuration) / [`set_runtime_configuration(Option<RuntimeConfiguration>)`](crate::client::fluent_builders::CreateFleet::set_runtime_configuration): <p>Instructions for how to launch and maintain server processes on instances in the fleet. The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently. </p> <note> <p>The <code>RuntimeConfiguration</code> parameter is required unless the fleet is being configured using the older parameters <code>ServerLaunchPath</code> and <code>ServerLaunchParameters</code>, which are still supported for backward compatibility.</p> </note>
/// - [`resource_creation_limit_policy(ResourceCreationLimitPolicy)`](crate::client::fluent_builders::CreateFleet::resource_creation_limit_policy) / [`set_resource_creation_limit_policy(Option<ResourceCreationLimitPolicy>)`](crate::client::fluent_builders::CreateFleet::set_resource_creation_limit_policy): <p>A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.</p>
/// - [`metric_groups(Vec<String>)`](crate::client::fluent_builders::CreateFleet::metric_groups) / [`set_metric_groups(Option<Vec<String>>)`](crate::client::fluent_builders::CreateFleet::set_metric_groups): <p>The name of an Amazon Web Services CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time. </p>
/// - [`peer_vpc_aws_account_id(impl Into<String>)`](crate::client::fluent_builders::CreateFleet::peer_vpc_aws_account_id) / [`set_peer_vpc_aws_account_id(Option<String>)`](crate::client::fluent_builders::CreateFleet::set_peer_vpc_aws_account_id): <p>Used when peering your GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account settings. </p>
/// - [`peer_vpc_id(impl Into<String>)`](crate::client::fluent_builders::CreateFleet::peer_vpc_id) / [`set_peer_vpc_id(Option<String>)`](crate::client::fluent_builders::CreateFleet::set_peer_vpc_id): <p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with GameLift Fleets</a>.</p>
/// - [`fleet_type(FleetType)`](crate::client::fluent_builders::CreateFleet::fleet_type) / [`set_fleet_type(Option<FleetType>)`](crate::client::fluent_builders::CreateFleet::set_fleet_type): <p>Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to <code>ON_DEMAND</code>. Learn more about when to use <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot"> On-Demand versus Spot Instances</a>. This property cannot be changed after the fleet is created.</p>
/// - [`instance_role_arn(impl Into<String>)`](crate::client::fluent_builders::CreateFleet::instance_role_arn) / [`set_instance_role_arn(Option<String>)`](crate::client::fluent_builders::CreateFleet::set_instance_role_arn): <p>A unique identifier for an IAM role that manages access to your Amazon Web Services services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the <a href="https://console.aws.amazon.com/iam/">IAM dashboard</a> in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html"> Access external resources from a game server</a>. This property cannot be changed after the fleet is created.</p>
/// - [`certificate_configuration(CertificateConfiguration)`](crate::client::fluent_builders::CreateFleet::certificate_configuration) / [`set_certificate_configuration(Option<CertificateConfiguration>)`](crate::client::fluent_builders::CreateFleet::set_certificate_configuration): <p>Prompts GameLift to generate a TLS/SSL certificate for the fleet. GameLift uses the certificates to encrypt traffic between game clients and the game servers running on GameLift. By default, the <code>CertificateConfiguration</code> is <code>DISABLED</code>. You can't change this property after you create the fleet. </p> <p>Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.</p> <note> <p>ACM isn't available in all Amazon Web Services regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html">Supported Regions</a> in the <i>Certificate Manager User Guide</i>.</p> </note>
/// - [`locations(Vec<LocationConfiguration>)`](crate::client::fluent_builders::CreateFleet::locations) / [`set_locations(Option<Vec<LocationConfiguration>>)`](crate::client::fluent_builders::CreateFleet::set_locations): <p>A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that support multiple locations. You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>. To create a fleet with instances in the home Region only, omit this parameter. </p>
/// - [`tags(Vec<Tag>)`](crate::client::fluent_builders::CreateFleet::tags) / [`set_tags(Option<Vec<Tag>>)`](crate::client::fluent_builders::CreateFleet::set_tags): <p>A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
/// - [`compute_type(ComputeType)`](crate::client::fluent_builders::CreateFleet::compute_type) / [`set_compute_type(Option<ComputeType>)`](crate::client::fluent_builders::CreateFleet::set_compute_type): <p>The type of compute resource used to host your game servers. You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift.</p>
/// - [`anywhere_configuration(AnywhereConfiguration)`](crate::client::fluent_builders::CreateFleet::anywhere_configuration) / [`set_anywhere_configuration(Option<AnywhereConfiguration>)`](crate::client::fluent_builders::CreateFleet::set_anywhere_configuration): <p>GameLift Anywhere configuration options.</p>
/// - On success, responds with [`CreateFleetOutput`](crate::output::CreateFleetOutput) with field(s):
/// - [`fleet_attributes(Option<FleetAttributes>)`](crate::output::CreateFleetOutput::fleet_attributes): <p>The properties for the new fleet, including the current status. All fleets are placed in <code>NEW</code> status on creation. </p>
/// - [`location_states(Option<Vec<LocationState>>)`](crate::output::CreateFleetOutput::location_states): <p>The fleet's locations and life-cycle status of each location. For new fleets, the status of all locations is set to <code>NEW</code>. During fleet creation, GameLift updates each location status as instances are deployed there and prepared for game hosting. This list includes an entry for the fleet's home Region. For fleets with no remote locations, only one entry, representing the home Region, is returned.</p>
/// - On failure, responds with [`SdkError<CreateFleetError>`](crate::error::CreateFleetError)
pub fn create_fleet(&self) -> fluent_builders::CreateFleet {
fluent_builders::CreateFleet::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateFleetLocations`](crate::client::fluent_builders::CreateFleetLocations) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::CreateFleetLocations::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::CreateFleetLocations::set_fleet_id): <p>A unique identifier for the fleet to add locations to. You can use either the fleet ID or ARN value.</p>
/// - [`locations(Vec<LocationConfiguration>)`](crate::client::fluent_builders::CreateFleetLocations::locations) / [`set_locations(Option<Vec<LocationConfiguration>>)`](crate::client::fluent_builders::CreateFleetLocations::set_locations): <p>A list of locations to deploy additional instances to and manage as part of the fleet. You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>. </p>
/// - On success, responds with [`CreateFleetLocationsOutput`](crate::output::CreateFleetLocationsOutput) with field(s):
/// - [`fleet_id(Option<String>)`](crate::output::CreateFleetLocationsOutput::fleet_id): <p>A unique identifier for the fleet that was updated with new locations.</p>
/// - [`fleet_arn(Option<String>)`](crate::output::CreateFleetLocationsOutput::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 GameLift 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>
/// - [`location_states(Option<Vec<LocationState>>)`](crate::output::CreateFleetLocationsOutput::location_states): <p>The remote locations that are being added to the fleet, and the life-cycle status of each location. For new locations, the status is set to <code>NEW</code>. During location creation, GameLift updates each location's status as instances are deployed there and prepared for game hosting. This list does not include the fleet home Region or any remote locations that were already added to the fleet.</p>
/// - On failure, responds with [`SdkError<CreateFleetLocationsError>`](crate::error::CreateFleetLocationsError)
pub fn create_fleet_locations(&self) -> fluent_builders::CreateFleetLocations {
fluent_builders::CreateFleetLocations::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateGameServerGroup`](crate::client::fluent_builders::CreateGameServerGroup) operation.
///
/// - The fluent builder is configurable:
/// - [`game_server_group_name(impl Into<String>)`](crate::client::fluent_builders::CreateGameServerGroup::game_server_group_name) / [`set_game_server_group_name(Option<String>)`](crate::client::fluent_builders::CreateGameServerGroup::set_game_server_group_name): <p>An identifier for the new game server group. This value is used to generate unique ARN identifiers for the Amazon EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per Amazon Web Services account.</p>
/// - [`role_arn(impl Into<String>)`](crate::client::fluent_builders::CreateGameServerGroup::role_arn) / [`set_role_arn(Option<String>)`](crate::client::fluent_builders::CreateGameServerGroup::set_role_arn): <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.</p>
/// - [`min_size(i32)`](crate::client::fluent_builders::CreateGameServerGroup::min_size) / [`set_min_size(Option<i32>)`](crate::client::fluent_builders::CreateGameServerGroup::set_min_size): <p>The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.</p>
/// - [`max_size(i32)`](crate::client::fluent_builders::CreateGameServerGroup::max_size) / [`set_max_size(Option<i32>)`](crate::client::fluent_builders::CreateGameServerGroup::set_max_size): <p>The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.</p>
/// - [`launch_template(LaunchTemplateSpecification)`](crate::client::fluent_builders::CreateGameServerGroup::launch_template) / [`set_launch_template(Option<LaunchTemplateSpecification>)`](crate::client::fluent_builders::CreateGameServerGroup::set_launch_template): <p>The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html">Creating a Launch Template for an Auto Scaling Group</a> in the <i>Amazon Elastic Compute Cloud Auto Scaling User Guide</i>. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.</p> <note> <p>If you specify network interfaces in your launch template, you must explicitly set the property <code>AssociatePublicIpAddress</code> to "true". If no network interface is specified in the launch template, GameLift FleetIQ uses your account's default VPC.</p> </note>
/// - [`instance_definitions(Vec<InstanceDefinition>)`](crate::client::fluent_builders::CreateGameServerGroup::instance_definitions) / [`set_instance_definitions(Option<Vec<InstanceDefinition>>)`](crate::client::fluent_builders::CreateGameServerGroup::set_instance_definitions): <p>The Amazon EC2 instance types and sizes to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">EC2 Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html"> Instance Weighting for Amazon EC2 Auto Scaling</a> in the Amazon EC2 Auto Scaling User Guide.</p>
/// - [`auto_scaling_policy(GameServerGroupAutoScalingPolicy)`](crate::client::fluent_builders::CreateGameServerGroup::auto_scaling_policy) / [`set_auto_scaling_policy(Option<GameServerGroupAutoScalingPolicy>)`](crate::client::fluent_builders::CreateGameServerGroup::set_auto_scaling_policy): <p>Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric <code>"PercentUtilizedGameServers"</code> to maintain a buffer of idle game servers that can immediately accommodate new games and players. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.</p>
/// - [`balancing_strategy(BalancingStrategy)`](crate::client::fluent_builders::CreateGameServerGroup::balancing_strategy) / [`set_balancing_strategy(Option<BalancingStrategy>)`](crate::client::fluent_builders::CreateGameServerGroup::set_balancing_strategy): <p>Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:</p> <ul> <li> <p> <code>SPOT_ONLY</code> - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.</p> </li> <li> <p> <code>SPOT_PREFERRED</code> - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.</p> </li> <li> <p> <code>ON_DEMAND_ONLY</code> - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.</p> </li> </ul>
/// - [`game_server_protection_policy(GameServerProtectionPolicy)`](crate::client::fluent_builders::CreateGameServerGroup::game_server_protection_policy) / [`set_game_server_protection_policy(Option<GameServerProtectionPolicy>)`](crate::client::fluent_builders::CreateGameServerGroup::set_game_server_protection_policy): <p>A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by Amazon Web Services regardless of protection status. This property is set to <code>NO_PROTECTION</code> by default.</p>
/// - [`vpc_subnets(Vec<String>)`](crate::client::fluent_builders::CreateGameServerGroup::vpc_subnets) / [`set_vpc_subnets(Option<Vec<String>>)`](crate::client::fluent_builders::CreateGameServerGroup::set_vpc_subnets): <p>A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all GameLift FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly.</p>
/// - [`tags(Vec<Tag>)`](crate::client::fluent_builders::CreateGameServerGroup::tags) / [`set_tags(Option<Vec<Tag>>)`](crate::client::fluent_builders::CreateGameServerGroup::set_tags): <p>A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management, and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
/// - On success, responds with [`CreateGameServerGroupOutput`](crate::output::CreateGameServerGroupOutput) with field(s):
/// - [`game_server_group(Option<GameServerGroup>)`](crate::output::CreateGameServerGroupOutput::game_server_group): <p>The newly created game server group object, including the new ARN value for the GameLift FleetIQ game server group and the object's status. The Amazon EC2 Auto Scaling group ARN is initially null, since the group has not yet been created. This value is added once the game server group status reaches <code>ACTIVE</code>. </p>
/// - On failure, responds with [`SdkError<CreateGameServerGroupError>`](crate::error::CreateGameServerGroupError)
pub fn create_game_server_group(&self) -> fluent_builders::CreateGameServerGroup {
fluent_builders::CreateGameServerGroup::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateGameSession`](crate::client::fluent_builders::CreateGameSession) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::CreateGameSession::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::CreateGameSession::set_fleet_id): <p>A unique identifier for the fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.</p>
/// - [`alias_id(impl Into<String>)`](crate::client::fluent_builders::CreateGameSession::alias_id) / [`set_alias_id(Option<String>)`](crate::client::fluent_builders::CreateGameSession::set_alias_id): <p>A unique identifier for the alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.</p>
/// - [`maximum_player_session_count(i32)`](crate::client::fluent_builders::CreateGameSession::maximum_player_session_count) / [`set_maximum_player_session_count(Option<i32>)`](crate::client::fluent_builders::CreateGameSession::set_maximum_player_session_count): <p>The maximum number of players that can be connected simultaneously to the game session.</p>
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::CreateGameSession::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::CreateGameSession::set_name): <p>A descriptive label that is associated with a game session. Session names do not need to be unique.</p>
/// - [`game_properties(Vec<GameProperty>)`](crate::client::fluent_builders::CreateGameSession::game_properties) / [`set_game_properties(Option<Vec<GameProperty>>)`](crate::client::fluent_builders::CreateGameSession::set_game_properties): <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</p>
/// - [`creator_id(impl Into<String>)`](crate::client::fluent_builders::CreateGameSession::creator_id) / [`set_creator_id(Option<String>)`](crate::client::fluent_builders::CreateGameSession::set_creator_id): <p>A unique identifier for a player or entity creating the game session. This parameter is required when requesting a new game session on a fleet with a resource creation limit policy. This type of policy limits the number of concurrent active game sessions that one player can create within a certain time span. GameLift uses the CreatorId to evaluate the new request against the policy.</p>
/// - [`game_session_id(impl Into<String>)`](crate::client::fluent_builders::CreateGameSession::game_session_id) / [`set_game_session_id(Option<String>)`](crate::client::fluent_builders::CreateGameSession::set_game_session_id): <p> <i>This parameter is deprecated. Use <code>IdempotencyToken</code> instead.</i> </p> <p>Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID.</p>
/// - [`idempotency_token(impl Into<String>)`](crate::client::fluent_builders::CreateGameSession::idempotency_token) / [`set_idempotency_token(Option<String>)`](crate::client::fluent_builders::CreateGameSession::set_idempotency_token): <p>Custom string that uniquely identifies the new game session request. This is useful for ensuring that game session requests with the same idempotency token are processed only once. Subsequent requests with the same string return the original <code>GameSession</code> object, with an updated status. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. A game session ARN has the following format: <code>arn:aws:gamelift: <region> ::gamesession/ <fleet id> / <custom id string or idempotency token></custom> </fleet> </region></code>. Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.</p>
/// - [`game_session_data(impl Into<String>)`](crate::client::fluent_builders::CreateGameSession::game_session_data) / [`set_game_session_data(Option<String>)`](crate::client::fluent_builders::CreateGameSession::set_game_session_data): <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</p>
/// - [`location(impl Into<String>)`](crate::client::fluent_builders::CreateGameSession::location) / [`set_location(Option<String>)`](crate::client::fluent_builders::CreateGameSession::set_location): <p>A fleet's remote location to place the new game session in. If this parameter is not set, the new game session is placed in the fleet's home Region. Specify a remote location with an Amazon Web Services Region code such as <code>us-west-2</code>. </p>
/// - On success, responds with [`CreateGameSessionOutput`](crate::output::CreateGameSessionOutput) with field(s):
/// - [`game_session(Option<GameSession>)`](crate::output::CreateGameSessionOutput::game_session): <p>Object that describes the newly created game session record.</p>
/// - On failure, responds with [`SdkError<CreateGameSessionError>`](crate::error::CreateGameSessionError)
pub fn create_game_session(&self) -> fluent_builders::CreateGameSession {
fluent_builders::CreateGameSession::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateGameSessionQueue`](crate::client::fluent_builders::CreateGameSessionQueue) operation.
///
/// - The fluent builder is configurable:
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::CreateGameSessionQueue::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::CreateGameSessionQueue::set_name): <p>A descriptive label that is associated with game session queue. Queue names must be unique within each Region.</p>
/// - [`timeout_in_seconds(i32)`](crate::client::fluent_builders::CreateGameSessionQueue::timeout_in_seconds) / [`set_timeout_in_seconds(Option<i32>)`](crate::client::fluent_builders::CreateGameSessionQueue::set_timeout_in_seconds): <p>The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a <code>TIMED_OUT</code> status.</p>
/// - [`player_latency_policies(Vec<PlayerLatencyPolicy>)`](crate::client::fluent_builders::CreateGameSessionQueue::player_latency_policies) / [`set_player_latency_policies(Option<Vec<PlayerLatencyPolicy>>)`](crate::client::fluent_builders::CreateGameSessionQueue::set_player_latency_policies): <p>A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.</p>
/// - [`destinations(Vec<GameSessionQueueDestination>)`](crate::client::fluent_builders::CreateGameSessionQueue::destinations) / [`set_destinations(Option<Vec<GameSessionQueueDestination>>)`](crate::client::fluent_builders::CreateGameSessionQueue::set_destinations): <p>A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.</p>
/// - [`filter_configuration(FilterConfiguration)`](crate::client::fluent_builders::CreateGameSessionQueue::filter_configuration) / [`set_filter_configuration(Option<FilterConfiguration>)`](crate::client::fluent_builders::CreateGameSessionQueue::set_filter_configuration): <p>A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as <code>us-west-2</code>. If this parameter is not set, game sessions can be placed in any queue location. </p>
/// - [`priority_configuration(PriorityConfiguration)`](crate::client::fluent_builders::CreateGameSessionQueue::priority_configuration) / [`set_priority_configuration(Option<PriorityConfiguration>)`](crate::client::fluent_builders::CreateGameSessionQueue::set_priority_configuration): <p>Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. </p>
/// - [`custom_event_data(impl Into<String>)`](crate::client::fluent_builders::CreateGameSessionQueue::custom_event_data) / [`set_custom_event_data(Option<String>)`](crate::client::fluent_builders::CreateGameSessionQueue::set_custom_event_data): <p>Information to be added to all events that are related to this game session queue.</p>
/// - [`notification_target(impl Into<String>)`](crate::client::fluent_builders::CreateGameSessionQueue::notification_target) / [`set_notification_target(Option<String>)`](crate::client::fluent_builders::CreateGameSessionQueue::set_notification_target): <p>An SNS topic ARN that is set up to receive game session placement notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html"> Setting up notifications for game session placement</a>.</p>
/// - [`tags(Vec<Tag>)`](crate::client::fluent_builders::CreateGameSessionQueue::tags) / [`set_tags(Option<Vec<Tag>>)`](crate::client::fluent_builders::CreateGameSessionQueue::set_tags): <p>A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
/// - On success, responds with [`CreateGameSessionQueueOutput`](crate::output::CreateGameSessionQueueOutput) with field(s):
/// - [`game_session_queue(Option<GameSessionQueue>)`](crate::output::CreateGameSessionQueueOutput::game_session_queue): <p>An object that describes the newly created game session queue.</p>
/// - On failure, responds with [`SdkError<CreateGameSessionQueueError>`](crate::error::CreateGameSessionQueueError)
pub fn create_game_session_queue(&self) -> fluent_builders::CreateGameSessionQueue {
fluent_builders::CreateGameSessionQueue::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateLocation`](crate::client::fluent_builders::CreateLocation) operation.
///
/// - The fluent builder is configurable:
/// - [`location_name(impl Into<String>)`](crate::client::fluent_builders::CreateLocation::location_name) / [`set_location_name(Option<String>)`](crate::client::fluent_builders::CreateLocation::set_location_name): <p>A descriptive name for the custom location.</p>
/// - [`tags(Vec<Tag>)`](crate::client::fluent_builders::CreateLocation::tags) / [`set_tags(Option<Vec<Tag>>)`](crate::client::fluent_builders::CreateLocation::set_tags): <p>A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Rareference</i>.</p>
/// - On success, responds with [`CreateLocationOutput`](crate::output::CreateLocationOutput) with field(s):
/// - [`location(Option<LocationModel>)`](crate::output::CreateLocationOutput::location): <p>The details of the custom location you created.</p>
/// - On failure, responds with [`SdkError<CreateLocationError>`](crate::error::CreateLocationError)
pub fn create_location(&self) -> fluent_builders::CreateLocation {
fluent_builders::CreateLocation::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateMatchmakingConfiguration`](crate::client::fluent_builders::CreateMatchmakingConfiguration) operation.
///
/// - The fluent builder is configurable:
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::set_name): <p>A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.</p>
/// - [`description(impl Into<String>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::description) / [`set_description(Option<String>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::set_description): <p>A human-readable description of the matchmaking configuration. </p>
/// - [`game_session_queue_arns(Vec<String>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::game_session_queue_arns) / [`set_game_session_queue_arns(Option<Vec<String>>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::set_game_session_queue_arns): <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 GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift: <region> ::gamesessionqueue/ <queue name></queue> </region></code>. Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If <code>FlexMatchMode</code> is set to <code>STANDALONE</code>, do not set this parameter. </p>
/// - [`request_timeout_seconds(i32)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::request_timeout_seconds) / [`set_request_timeout_seconds(Option<i32>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::set_request_timeout_seconds): <p>The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.</p>
/// - [`acceptance_timeout_seconds(i32)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::acceptance_timeout_seconds) / [`set_acceptance_timeout_seconds(Option<i32>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::set_acceptance_timeout_seconds): <p>The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. </p>
/// - [`acceptance_required(bool)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::acceptance_required) / [`set_acceptance_required(Option<bool>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::set_acceptance_required): <p>A flag that determines whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to <code>TRUE</code>. With this option enabled, matchmaking tickets use the status <code>REQUIRES_ACCEPTANCE</code> to indicate when a completed potential match is waiting for player acceptance. </p>
/// - [`rule_set_name(impl Into<String>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::rule_set_name) / [`set_rule_set_name(Option<String>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::set_rule_set_name): <p>A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.</p>
/// - [`notification_target(impl Into<String>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::notification_target) / [`set_notification_target(Option<String>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::set_notification_target): <p>An SNS topic ARN that is set up to receive matchmaking notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Setting up notifications for matchmaking</a> for more information.</p>
/// - [`additional_player_count(i32)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::additional_player_count) / [`set_additional_player_count(Option<i32>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::set_additional_player_count): <p>The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
/// - [`custom_event_data(impl Into<String>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::custom_event_data) / [`set_custom_event_data(Option<String>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::set_custom_event_data): <p>Information to be added to all events related to this matchmaking configuration. </p>
/// - [`game_properties(Vec<GameProperty>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::game_properties) / [`set_game_properties(Option<Vec<GameProperty>>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::set_game_properties): <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the new <code>GameSession</code> object that is created for a successful match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
/// - [`game_session_data(impl Into<String>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::game_session_data) / [`set_game_session_data(Option<String>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::set_game_session_data): <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the new <code>GameSession</code> object that is created for a successful match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
/// - [`backfill_mode(BackfillMode)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::backfill_mode) / [`set_backfill_mode(Option<BackfillMode>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::set_backfill_mode): <p>The method used to backfill game sessions that are created with this matchmaking configuration. Specify <code>MANUAL</code> when your game manages backfill requests manually or does not use the match backfill feature. Specify <code>AUTOMATIC</code> to have GameLift create a backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html"> Backfill Existing Games with FlexMatch</a>. Automatic backfill is not available when <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
/// - [`flex_match_mode(FlexMatchMode)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::flex_match_mode) / [`set_flex_match_mode(Option<FlexMatchMode>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::set_flex_match_mode): <p>Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution. </p> <ul> <li> <p> <b>STANDALONE</b> - FlexMatch forms matches and returns match information, including players and team assignments, in a <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded"> MatchmakingSucceeded</a> event.</p> </li> <li> <p> <b>WITH_QUEUE</b> - FlexMatch forms matches and uses the specified GameLift queue to start a game session for the match. </p> </li> </ul>
/// - [`tags(Vec<Tag>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::tags) / [`set_tags(Option<Vec<Tag>>)`](crate::client::fluent_builders::CreateMatchmakingConfiguration::set_tags): <p>A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
/// - On success, responds with [`CreateMatchmakingConfigurationOutput`](crate::output::CreateMatchmakingConfigurationOutput) with field(s):
/// - [`configuration(Option<MatchmakingConfiguration>)`](crate::output::CreateMatchmakingConfigurationOutput::configuration): <p>Object that describes the newly created matchmaking configuration.</p>
/// - On failure, responds with [`SdkError<CreateMatchmakingConfigurationError>`](crate::error::CreateMatchmakingConfigurationError)
pub fn create_matchmaking_configuration(
&self,
) -> fluent_builders::CreateMatchmakingConfiguration {
fluent_builders::CreateMatchmakingConfiguration::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateMatchmakingRuleSet`](crate::client::fluent_builders::CreateMatchmakingRuleSet) operation.
///
/// - The fluent builder is configurable:
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::CreateMatchmakingRuleSet::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::CreateMatchmakingRuleSet::set_name): <p>A unique identifier for the matchmaking rule set. A matchmaking configuration identifies the rule set it uses by this name value. Note that the rule set name is different from the optional <code>name</code> field in the rule set body.</p>
/// - [`rule_set_body(impl Into<String>)`](crate::client::fluent_builders::CreateMatchmakingRuleSet::rule_set_body) / [`set_rule_set_body(Option<String>)`](crate::client::fluent_builders::CreateMatchmakingRuleSet::set_rule_set_body): <p>A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.</p>
/// - [`tags(Vec<Tag>)`](crate::client::fluent_builders::CreateMatchmakingRuleSet::tags) / [`set_tags(Option<Vec<Tag>>)`](crate::client::fluent_builders::CreateMatchmakingRuleSet::set_tags): <p>A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
/// - On success, responds with [`CreateMatchmakingRuleSetOutput`](crate::output::CreateMatchmakingRuleSetOutput) with field(s):
/// - [`rule_set(Option<MatchmakingRuleSet>)`](crate::output::CreateMatchmakingRuleSetOutput::rule_set): <p>The newly created matchmaking rule set.</p>
/// - On failure, responds with [`SdkError<CreateMatchmakingRuleSetError>`](crate::error::CreateMatchmakingRuleSetError)
pub fn create_matchmaking_rule_set(&self) -> fluent_builders::CreateMatchmakingRuleSet {
fluent_builders::CreateMatchmakingRuleSet::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreatePlayerSession`](crate::client::fluent_builders::CreatePlayerSession) operation.
///
/// - The fluent builder is configurable:
/// - [`game_session_id(impl Into<String>)`](crate::client::fluent_builders::CreatePlayerSession::game_session_id) / [`set_game_session_id(Option<String>)`](crate::client::fluent_builders::CreatePlayerSession::set_game_session_id): <p>A unique identifier for the game session to add a player to.</p>
/// - [`player_id(impl Into<String>)`](crate::client::fluent_builders::CreatePlayerSession::player_id) / [`set_player_id(Option<String>)`](crate::client::fluent_builders::CreatePlayerSession::set_player_id): <p>A unique identifier for a player. Player IDs are developer-defined.</p>
/// - [`player_data(impl Into<String>)`](crate::client::fluent_builders::CreatePlayerSession::player_data) / [`set_player_data(Option<String>)`](crate::client::fluent_builders::CreatePlayerSession::set_player_data): <p>Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.</p>
/// - On success, responds with [`CreatePlayerSessionOutput`](crate::output::CreatePlayerSessionOutput) with field(s):
/// - [`player_session(Option<PlayerSession>)`](crate::output::CreatePlayerSessionOutput::player_session): <p>Object that describes the newly created player session record.</p>
/// - On failure, responds with [`SdkError<CreatePlayerSessionError>`](crate::error::CreatePlayerSessionError)
pub fn create_player_session(&self) -> fluent_builders::CreatePlayerSession {
fluent_builders::CreatePlayerSession::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreatePlayerSessions`](crate::client::fluent_builders::CreatePlayerSessions) operation.
///
/// - The fluent builder is configurable:
/// - [`game_session_id(impl Into<String>)`](crate::client::fluent_builders::CreatePlayerSessions::game_session_id) / [`set_game_session_id(Option<String>)`](crate::client::fluent_builders::CreatePlayerSessions::set_game_session_id): <p>A unique identifier for the game session to add players to.</p>
/// - [`player_ids(Vec<String>)`](crate::client::fluent_builders::CreatePlayerSessions::player_ids) / [`set_player_ids(Option<Vec<String>>)`](crate::client::fluent_builders::CreatePlayerSessions::set_player_ids): <p>List of unique identifiers for the players to be added.</p>
/// - [`player_data_map(HashMap<String, String>)`](crate::client::fluent_builders::CreatePlayerSessions::player_data_map) / [`set_player_data_map(Option<HashMap<String, String>>)`](crate::client::fluent_builders::CreatePlayerSessions::set_player_data_map): <p>Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the <code>PlayerIds</code> parameter are ignored. </p>
/// - On success, responds with [`CreatePlayerSessionsOutput`](crate::output::CreatePlayerSessionsOutput) with field(s):
/// - [`player_sessions(Option<Vec<PlayerSession>>)`](crate::output::CreatePlayerSessionsOutput::player_sessions): <p>A collection of player session objects created for the added players.</p>
/// - On failure, responds with [`SdkError<CreatePlayerSessionsError>`](crate::error::CreatePlayerSessionsError)
pub fn create_player_sessions(&self) -> fluent_builders::CreatePlayerSessions {
fluent_builders::CreatePlayerSessions::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateScript`](crate::client::fluent_builders::CreateScript) operation.
///
/// - The fluent builder is configurable:
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::CreateScript::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::CreateScript::set_name): <p>A descriptive label that is associated with a script. Script names do not need to be unique. You can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html">UpdateScript</a> to change this value later. </p>
/// - [`version(impl Into<String>)`](crate::client::fluent_builders::CreateScript::version) / [`set_version(Option<String>)`](crate::client::fluent_builders::CreateScript::set_version): <p>Version information associated with a build or script. Version strings do not need to be unique. You can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html">UpdateScript</a> to change this value later. </p>
/// - [`storage_location(S3Location)`](crate::client::fluent_builders::CreateScript::storage_location) / [`set_storage_location(Option<S3Location>)`](crate::client::fluent_builders::CreateScript::set_storage_location): <p>The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the <code>ObjectVersion</code> parameter to specify an earlier version. </p>
/// - [`zip_file(Blob)`](crate::client::fluent_builders::CreateScript::zip_file) / [`set_zip_file(Option<Blob>)`](crate::client::fluent_builders::CreateScript::set_zip_file): <p>A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.</p> <p>When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: <code>--zip-file fileb://myRealtimeScript.zip</code>.</p>
/// - [`tags(Vec<Tag>)`](crate::client::fluent_builders::CreateScript::tags) / [`set_tags(Option<Vec<Tag>>)`](crate::client::fluent_builders::CreateScript::set_tags): <p>A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. Once the resource is created, you can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html">TagResource</a>, <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html">UntagResource</a>, and <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html">ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.</p>
/// - On success, responds with [`CreateScriptOutput`](crate::output::CreateScriptOutput) with field(s):
/// - [`script(Option<Script>)`](crate::output::CreateScriptOutput::script): <p>The newly created script record with a unique script ID and ARN. The new script's storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket under your account, the storage location reflects the information that was provided in the <i>CreateScript</i> request; (2) If the script file was uploaded from a local zip file, the storage location reflects an S3 location controls by the Amazon GameLift service.</p>
/// - On failure, responds with [`SdkError<CreateScriptError>`](crate::error::CreateScriptError)
pub fn create_script(&self) -> fluent_builders::CreateScript {
fluent_builders::CreateScript::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateVpcPeeringAuthorization`](crate::client::fluent_builders::CreateVpcPeeringAuthorization) operation.
///
/// - The fluent builder is configurable:
/// - [`game_lift_aws_account_id(impl Into<String>)`](crate::client::fluent_builders::CreateVpcPeeringAuthorization::game_lift_aws_account_id) / [`set_game_lift_aws_account_id(Option<String>)`](crate::client::fluent_builders::CreateVpcPeeringAuthorization::set_game_lift_aws_account_id): <p>A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.</p>
/// - [`peer_vpc_id(impl Into<String>)`](crate::client::fluent_builders::CreateVpcPeeringAuthorization::peer_vpc_id) / [`set_peer_vpc_id(Option<String>)`](crate::client::fluent_builders::CreateVpcPeeringAuthorization::set_peer_vpc_id): <p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with GameLift Fleets</a>.</p>
/// - On success, responds with [`CreateVpcPeeringAuthorizationOutput`](crate::output::CreateVpcPeeringAuthorizationOutput) with field(s):
/// - [`vpc_peering_authorization(Option<VpcPeeringAuthorization>)`](crate::output::CreateVpcPeeringAuthorizationOutput::vpc_peering_authorization): <p>Details on the requested VPC peering authorization, including expiration.</p>
/// - On failure, responds with [`SdkError<CreateVpcPeeringAuthorizationError>`](crate::error::CreateVpcPeeringAuthorizationError)
pub fn create_vpc_peering_authorization(
&self,
) -> fluent_builders::CreateVpcPeeringAuthorization {
fluent_builders::CreateVpcPeeringAuthorization::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`CreateVpcPeeringConnection`](crate::client::fluent_builders::CreateVpcPeeringConnection) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::CreateVpcPeeringConnection::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::CreateVpcPeeringConnection::set_fleet_id): <p>A unique identifier for the fleet. You can use either the fleet ID or ARN value. This tells Amazon GameLift which GameLift VPC to peer with. </p>
/// - [`peer_vpc_aws_account_id(impl Into<String>)`](crate::client::fluent_builders::CreateVpcPeeringConnection::peer_vpc_aws_account_id) / [`set_peer_vpc_aws_account_id(Option<String>)`](crate::client::fluent_builders::CreateVpcPeeringConnection::set_peer_vpc_aws_account_id): <p>A unique identifier for the Amazon Web Services account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the Amazon Web Services Management Console under account settings.</p>
/// - [`peer_vpc_id(impl Into<String>)`](crate::client::fluent_builders::CreateVpcPeeringConnection::peer_vpc_id) / [`set_peer_vpc_id(Option<String>)`](crate::client::fluent_builders::CreateVpcPeeringConnection::set_peer_vpc_id): <p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with GameLift Fleets</a>.</p>
/// - On success, responds with [`CreateVpcPeeringConnectionOutput`](crate::output::CreateVpcPeeringConnectionOutput)
/// - On failure, responds with [`SdkError<CreateVpcPeeringConnectionError>`](crate::error::CreateVpcPeeringConnectionError)
pub fn create_vpc_peering_connection(&self) -> fluent_builders::CreateVpcPeeringConnection {
fluent_builders::CreateVpcPeeringConnection::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteAlias`](crate::client::fluent_builders::DeleteAlias) operation.
///
/// - The fluent builder is configurable:
/// - [`alias_id(impl Into<String>)`](crate::client::fluent_builders::DeleteAlias::alias_id) / [`set_alias_id(Option<String>)`](crate::client::fluent_builders::DeleteAlias::set_alias_id): <p>A unique identifier of the alias that you want to delete. You can use either the alias ID or ARN value.</p>
/// - On success, responds with [`DeleteAliasOutput`](crate::output::DeleteAliasOutput)
/// - On failure, responds with [`SdkError<DeleteAliasError>`](crate::error::DeleteAliasError)
pub fn delete_alias(&self) -> fluent_builders::DeleteAlias {
fluent_builders::DeleteAlias::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteBuild`](crate::client::fluent_builders::DeleteBuild) operation.
///
/// - The fluent builder is configurable:
/// - [`build_id(impl Into<String>)`](crate::client::fluent_builders::DeleteBuild::build_id) / [`set_build_id(Option<String>)`](crate::client::fluent_builders::DeleteBuild::set_build_id): <p>A unique identifier for the build to delete. You can use either the build ID or ARN value. </p>
/// - On success, responds with [`DeleteBuildOutput`](crate::output::DeleteBuildOutput)
/// - On failure, responds with [`SdkError<DeleteBuildError>`](crate::error::DeleteBuildError)
pub fn delete_build(&self) -> fluent_builders::DeleteBuild {
fluent_builders::DeleteBuild::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteFleet`](crate::client::fluent_builders::DeleteFleet) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::DeleteFleet::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::DeleteFleet::set_fleet_id): <p>A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value.</p>
/// - On success, responds with [`DeleteFleetOutput`](crate::output::DeleteFleetOutput)
/// - On failure, responds with [`SdkError<DeleteFleetError>`](crate::error::DeleteFleetError)
pub fn delete_fleet(&self) -> fluent_builders::DeleteFleet {
fluent_builders::DeleteFleet::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteFleetLocations`](crate::client::fluent_builders::DeleteFleetLocations) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::DeleteFleetLocations::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::DeleteFleetLocations::set_fleet_id): <p>A unique identifier for the fleet to delete locations for. You can use either the fleet ID or ARN value.</p>
/// - [`locations(Vec<String>)`](crate::client::fluent_builders::DeleteFleetLocations::locations) / [`set_locations(Option<Vec<String>>)`](crate::client::fluent_builders::DeleteFleetLocations::set_locations): <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>
/// - On success, responds with [`DeleteFleetLocationsOutput`](crate::output::DeleteFleetLocationsOutput) with field(s):
/// - [`fleet_id(Option<String>)`](crate::output::DeleteFleetLocationsOutput::fleet_id): <p>A unique identifier for the fleet that location attributes are being deleted for.</p>
/// - [`fleet_arn(Option<String>)`](crate::output::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 GameLift 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>
/// - [`location_states(Option<Vec<LocationState>>)`](crate::output::DeleteFleetLocationsOutput::location_states): <p>The remote locations that are being deleted, with each location status set to <code>DELETING</code>.</p>
/// - On failure, responds with [`SdkError<DeleteFleetLocationsError>`](crate::error::DeleteFleetLocationsError)
pub fn delete_fleet_locations(&self) -> fluent_builders::DeleteFleetLocations {
fluent_builders::DeleteFleetLocations::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteGameServerGroup`](crate::client::fluent_builders::DeleteGameServerGroup) operation.
///
/// - The fluent builder is configurable:
/// - [`game_server_group_name(impl Into<String>)`](crate::client::fluent_builders::DeleteGameServerGroup::game_server_group_name) / [`set_game_server_group_name(Option<String>)`](crate::client::fluent_builders::DeleteGameServerGroup::set_game_server_group_name): <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
/// - [`delete_option(GameServerGroupDeleteOption)`](crate::client::fluent_builders::DeleteGameServerGroup::delete_option) / [`set_delete_option(Option<GameServerGroupDeleteOption>)`](crate::client::fluent_builders::DeleteGameServerGroup::set_delete_option): <p>The type of delete to perform. Options include the following:</p> <ul> <li> <p> <code>SAFE_DELETE</code> – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in <code>UTILIZED</code> status.</p> </li> <li> <p> <code>FORCE_DELETE</code> – Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group. </p> </li> <li> <p> <code>RETAIN</code> – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is.</p> </li> </ul>
/// - On success, responds with [`DeleteGameServerGroupOutput`](crate::output::DeleteGameServerGroupOutput) with field(s):
/// - [`game_server_group(Option<GameServerGroup>)`](crate::output::DeleteGameServerGroupOutput::game_server_group): <p>An object that describes the deleted game server group resource, with status updated to <code>DELETE_SCHEDULED</code>. </p>
/// - On failure, responds with [`SdkError<DeleteGameServerGroupError>`](crate::error::DeleteGameServerGroupError)
pub fn delete_game_server_group(&self) -> fluent_builders::DeleteGameServerGroup {
fluent_builders::DeleteGameServerGroup::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteGameSessionQueue`](crate::client::fluent_builders::DeleteGameSessionQueue) operation.
///
/// - The fluent builder is configurable:
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::DeleteGameSessionQueue::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::DeleteGameSessionQueue::set_name): <p>A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value. </p>
/// - On success, responds with [`DeleteGameSessionQueueOutput`](crate::output::DeleteGameSessionQueueOutput)
/// - On failure, responds with [`SdkError<DeleteGameSessionQueueError>`](crate::error::DeleteGameSessionQueueError)
pub fn delete_game_session_queue(&self) -> fluent_builders::DeleteGameSessionQueue {
fluent_builders::DeleteGameSessionQueue::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteLocation`](crate::client::fluent_builders::DeleteLocation) operation.
///
/// - The fluent builder is configurable:
/// - [`location_name(impl Into<String>)`](crate::client::fluent_builders::DeleteLocation::location_name) / [`set_location_name(Option<String>)`](crate::client::fluent_builders::DeleteLocation::set_location_name): <p>The location name of the custom location to be deleted.</p>
/// - On success, responds with [`DeleteLocationOutput`](crate::output::DeleteLocationOutput)
/// - On failure, responds with [`SdkError<DeleteLocationError>`](crate::error::DeleteLocationError)
pub fn delete_location(&self) -> fluent_builders::DeleteLocation {
fluent_builders::DeleteLocation::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteMatchmakingConfiguration`](crate::client::fluent_builders::DeleteMatchmakingConfiguration) operation.
///
/// - The fluent builder is configurable:
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::DeleteMatchmakingConfiguration::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::DeleteMatchmakingConfiguration::set_name): <p>A unique identifier for the matchmaking configuration. You can use either the configuration name or ARN value.</p>
/// - On success, responds with [`DeleteMatchmakingConfigurationOutput`](crate::output::DeleteMatchmakingConfigurationOutput)
/// - On failure, responds with [`SdkError<DeleteMatchmakingConfigurationError>`](crate::error::DeleteMatchmakingConfigurationError)
pub fn delete_matchmaking_configuration(
&self,
) -> fluent_builders::DeleteMatchmakingConfiguration {
fluent_builders::DeleteMatchmakingConfiguration::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteMatchmakingRuleSet`](crate::client::fluent_builders::DeleteMatchmakingRuleSet) operation.
///
/// - The fluent builder is configurable:
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::DeleteMatchmakingRuleSet::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::DeleteMatchmakingRuleSet::set_name): <p>A unique identifier for the matchmaking rule set to be deleted. (Note: The rule set name is different from the optional "name" field in the rule set body.) You can use either the rule set name or ARN value.</p>
/// - On success, responds with [`DeleteMatchmakingRuleSetOutput`](crate::output::DeleteMatchmakingRuleSetOutput)
/// - On failure, responds with [`SdkError<DeleteMatchmakingRuleSetError>`](crate::error::DeleteMatchmakingRuleSetError)
pub fn delete_matchmaking_rule_set(&self) -> fluent_builders::DeleteMatchmakingRuleSet {
fluent_builders::DeleteMatchmakingRuleSet::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteScalingPolicy`](crate::client::fluent_builders::DeleteScalingPolicy) operation.
///
/// - The fluent builder is configurable:
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::DeleteScalingPolicy::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::DeleteScalingPolicy::set_name): <p>A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.</p>
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::DeleteScalingPolicy::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::DeleteScalingPolicy::set_fleet_id): <p>A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value.</p>
/// - On success, responds with [`DeleteScalingPolicyOutput`](crate::output::DeleteScalingPolicyOutput)
/// - On failure, responds with [`SdkError<DeleteScalingPolicyError>`](crate::error::DeleteScalingPolicyError)
pub fn delete_scaling_policy(&self) -> fluent_builders::DeleteScalingPolicy {
fluent_builders::DeleteScalingPolicy::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteScript`](crate::client::fluent_builders::DeleteScript) operation.
///
/// - The fluent builder is configurable:
/// - [`script_id(impl Into<String>)`](crate::client::fluent_builders::DeleteScript::script_id) / [`set_script_id(Option<String>)`](crate::client::fluent_builders::DeleteScript::set_script_id): <p>A unique identifier for the Realtime script to delete. You can use either the script ID or ARN value.</p>
/// - On success, responds with [`DeleteScriptOutput`](crate::output::DeleteScriptOutput)
/// - On failure, responds with [`SdkError<DeleteScriptError>`](crate::error::DeleteScriptError)
pub fn delete_script(&self) -> fluent_builders::DeleteScript {
fluent_builders::DeleteScript::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteVpcPeeringAuthorization`](crate::client::fluent_builders::DeleteVpcPeeringAuthorization) operation.
///
/// - The fluent builder is configurable:
/// - [`game_lift_aws_account_id(impl Into<String>)`](crate::client::fluent_builders::DeleteVpcPeeringAuthorization::game_lift_aws_account_id) / [`set_game_lift_aws_account_id(Option<String>)`](crate::client::fluent_builders::DeleteVpcPeeringAuthorization::set_game_lift_aws_account_id): <p>A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.</p>
/// - [`peer_vpc_id(impl Into<String>)`](crate::client::fluent_builders::DeleteVpcPeeringAuthorization::peer_vpc_id) / [`set_peer_vpc_id(Option<String>)`](crate::client::fluent_builders::DeleteVpcPeeringAuthorization::set_peer_vpc_id): <p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with GameLift Fleets</a>.</p>
/// - On success, responds with [`DeleteVpcPeeringAuthorizationOutput`](crate::output::DeleteVpcPeeringAuthorizationOutput)
/// - On failure, responds with [`SdkError<DeleteVpcPeeringAuthorizationError>`](crate::error::DeleteVpcPeeringAuthorizationError)
pub fn delete_vpc_peering_authorization(
&self,
) -> fluent_builders::DeleteVpcPeeringAuthorization {
fluent_builders::DeleteVpcPeeringAuthorization::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeleteVpcPeeringConnection`](crate::client::fluent_builders::DeleteVpcPeeringConnection) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::DeleteVpcPeeringConnection::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::DeleteVpcPeeringConnection::set_fleet_id): <p>A unique identifier for the fleet. This fleet specified must match the fleet referenced in the VPC peering connection record. You can use either the fleet ID or ARN value.</p>
/// - [`vpc_peering_connection_id(impl Into<String>)`](crate::client::fluent_builders::DeleteVpcPeeringConnection::vpc_peering_connection_id) / [`set_vpc_peering_connection_id(Option<String>)`](crate::client::fluent_builders::DeleteVpcPeeringConnection::set_vpc_peering_connection_id): <p>A unique identifier for a VPC peering connection.</p>
/// - On success, responds with [`DeleteVpcPeeringConnectionOutput`](crate::output::DeleteVpcPeeringConnectionOutput)
/// - On failure, responds with [`SdkError<DeleteVpcPeeringConnectionError>`](crate::error::DeleteVpcPeeringConnectionError)
pub fn delete_vpc_peering_connection(&self) -> fluent_builders::DeleteVpcPeeringConnection {
fluent_builders::DeleteVpcPeeringConnection::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeregisterCompute`](crate::client::fluent_builders::DeregisterCompute) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::DeregisterCompute::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::DeregisterCompute::set_fleet_id): <p>>A unique identifier for the fleet the compute resource is registered to.</p>
/// - [`compute_name(impl Into<String>)`](crate::client::fluent_builders::DeregisterCompute::compute_name) / [`set_compute_name(Option<String>)`](crate::client::fluent_builders::DeregisterCompute::set_compute_name): <p>The name of the compute resource you want to delete.</p>
/// - On success, responds with [`DeregisterComputeOutput`](crate::output::DeregisterComputeOutput)
/// - On failure, responds with [`SdkError<DeregisterComputeError>`](crate::error::DeregisterComputeError)
pub fn deregister_compute(&self) -> fluent_builders::DeregisterCompute {
fluent_builders::DeregisterCompute::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DeregisterGameServer`](crate::client::fluent_builders::DeregisterGameServer) operation.
///
/// - The fluent builder is configurable:
/// - [`game_server_group_name(impl Into<String>)`](crate::client::fluent_builders::DeregisterGameServer::game_server_group_name) / [`set_game_server_group_name(Option<String>)`](crate::client::fluent_builders::DeregisterGameServer::set_game_server_group_name): <p>A unique identifier for the game server group where the game server is running.</p>
/// - [`game_server_id(impl Into<String>)`](crate::client::fluent_builders::DeregisterGameServer::game_server_id) / [`set_game_server_id(Option<String>)`](crate::client::fluent_builders::DeregisterGameServer::set_game_server_id): <p>A custom string that uniquely identifies the game server to deregister.</p>
/// - On success, responds with [`DeregisterGameServerOutput`](crate::output::DeregisterGameServerOutput)
/// - On failure, responds with [`SdkError<DeregisterGameServerError>`](crate::error::DeregisterGameServerError)
pub fn deregister_game_server(&self) -> fluent_builders::DeregisterGameServer {
fluent_builders::DeregisterGameServer::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeAlias`](crate::client::fluent_builders::DescribeAlias) operation.
///
/// - The fluent builder is configurable:
/// - [`alias_id(impl Into<String>)`](crate::client::fluent_builders::DescribeAlias::alias_id) / [`set_alias_id(Option<String>)`](crate::client::fluent_builders::DescribeAlias::set_alias_id): <p>The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN value. </p>
/// - On success, responds with [`DescribeAliasOutput`](crate::output::DescribeAliasOutput) with field(s):
/// - [`alias(Option<Alias>)`](crate::output::DescribeAliasOutput::alias): <p>The requested alias resource.</p>
/// - On failure, responds with [`SdkError<DescribeAliasError>`](crate::error::DescribeAliasError)
pub fn describe_alias(&self) -> fluent_builders::DescribeAlias {
fluent_builders::DescribeAlias::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeBuild`](crate::client::fluent_builders::DescribeBuild) operation.
///
/// - The fluent builder is configurable:
/// - [`build_id(impl Into<String>)`](crate::client::fluent_builders::DescribeBuild::build_id) / [`set_build_id(Option<String>)`](crate::client::fluent_builders::DescribeBuild::set_build_id): <p>A unique identifier for the build to retrieve properties for. You can use either the build ID or ARN value. </p>
/// - On success, responds with [`DescribeBuildOutput`](crate::output::DescribeBuildOutput) with field(s):
/// - [`build_value(Option<Build>)`](crate::output::DescribeBuildOutput::build_value): <p>Set of properties describing the requested build.</p>
/// - On failure, responds with [`SdkError<DescribeBuildError>`](crate::error::DescribeBuildError)
pub fn describe_build(&self) -> fluent_builders::DescribeBuild {
fluent_builders::DescribeBuild::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeCompute`](crate::client::fluent_builders::DescribeCompute) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::DescribeCompute::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::DescribeCompute::set_fleet_id): <p>A unique identifier for the fleet the compute is registered to.</p>
/// - [`compute_name(impl Into<String>)`](crate::client::fluent_builders::DescribeCompute::compute_name) / [`set_compute_name(Option<String>)`](crate::client::fluent_builders::DescribeCompute::set_compute_name): <p>A descriptive label that is associated with the compute resource registered to your fleet.</p>
/// - On success, responds with [`DescribeComputeOutput`](crate::output::DescribeComputeOutput) with field(s):
/// - [`compute(Option<Compute>)`](crate::output::DescribeComputeOutput::compute): <p>The details of the compute resource you registered to the specified fleet.</p>
/// - On failure, responds with [`SdkError<DescribeComputeError>`](crate::error::DescribeComputeError)
pub fn describe_compute(&self) -> fluent_builders::DescribeCompute {
fluent_builders::DescribeCompute::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeEC2InstanceLimits`](crate::client::fluent_builders::DescribeEC2InstanceLimits) operation.
///
/// - The fluent builder is configurable:
/// - [`ec2_instance_type(Ec2InstanceType)`](crate::client::fluent_builders::DescribeEC2InstanceLimits::ec2_instance_type) / [`set_ec2_instance_type(Option<Ec2InstanceType>)`](crate::client::fluent_builders::DescribeEC2InstanceLimits::set_ec2_instance_type): <p>Name of an Amazon EC2 instance type that is supported in GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Do not specify a value for this parameter to retrieve limits for all instance types.</p>
/// - [`location(impl Into<String>)`](crate::client::fluent_builders::DescribeEC2InstanceLimits::location) / [`set_location(Option<String>)`](crate::client::fluent_builders::DescribeEC2InstanceLimits::set_location): <p>The name of a remote location to request instance limits for, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>.</p>
/// - On success, responds with [`DescribeEc2InstanceLimitsOutput`](crate::output::DescribeEc2InstanceLimitsOutput) with field(s):
/// - [`ec2_instance_limits(Option<Vec<Ec2InstanceLimit>>)`](crate::output::DescribeEc2InstanceLimitsOutput::ec2_instance_limits): <p>The maximum number of instances for the specified instance type.</p>
/// - On failure, responds with [`SdkError<DescribeEC2InstanceLimitsError>`](crate::error::DescribeEC2InstanceLimitsError)
pub fn describe_ec2_instance_limits(&self) -> fluent_builders::DescribeEC2InstanceLimits {
fluent_builders::DescribeEC2InstanceLimits::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeFleetAttributes`](crate::client::fluent_builders::DescribeFleetAttributes) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::DescribeFleetAttributes::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`fleet_ids(Vec<String>)`](crate::client::fluent_builders::DescribeFleetAttributes::fleet_ids) / [`set_fleet_ids(Option<Vec<String>>)`](crate::client::fluent_builders::DescribeFleetAttributes::set_fleet_ids): <p>A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. </p>
/// - [`limit(i32)`](crate::client::fluent_builders::DescribeFleetAttributes::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::DescribeFleetAttributes::set_limit): <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::DescribeFleetAttributes::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::DescribeFleetAttributes::set_next_token): <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. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
/// - On success, responds with [`DescribeFleetAttributesOutput`](crate::output::DescribeFleetAttributesOutput) with field(s):
/// - [`fleet_attributes(Option<Vec<FleetAttributes>>)`](crate::output::DescribeFleetAttributesOutput::fleet_attributes): <p>A collection of objects containing attribute metadata for each requested fleet ID. Attribute objects are returned only for fleets that currently exist.</p>
/// - [`next_token(Option<String>)`](crate::output::DescribeFleetAttributesOutput::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>
/// - On failure, responds with [`SdkError<DescribeFleetAttributesError>`](crate::error::DescribeFleetAttributesError)
pub fn describe_fleet_attributes(&self) -> fluent_builders::DescribeFleetAttributes {
fluent_builders::DescribeFleetAttributes::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeFleetCapacity`](crate::client::fluent_builders::DescribeFleetCapacity) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::DescribeFleetCapacity::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`fleet_ids(Vec<String>)`](crate::client::fluent_builders::DescribeFleetCapacity::fleet_ids) / [`set_fleet_ids(Option<Vec<String>>)`](crate::client::fluent_builders::DescribeFleetCapacity::set_fleet_ids): <p>A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.</p>
/// - [`limit(i32)`](crate::client::fluent_builders::DescribeFleetCapacity::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::DescribeFleetCapacity::set_limit): <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::DescribeFleetCapacity::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::DescribeFleetCapacity::set_next_token): <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. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
/// - On success, responds with [`DescribeFleetCapacityOutput`](crate::output::DescribeFleetCapacityOutput) with field(s):
/// - [`fleet_capacity(Option<Vec<FleetCapacity>>)`](crate::output::DescribeFleetCapacityOutput::fleet_capacity): <p>A collection of objects that contains capacity information for each requested fleet ID. Capacity objects are returned only for fleets that currently exist.</p>
/// - [`next_token(Option<String>)`](crate::output::DescribeFleetCapacityOutput::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>
/// - On failure, responds with [`SdkError<DescribeFleetCapacityError>`](crate::error::DescribeFleetCapacityError)
pub fn describe_fleet_capacity(&self) -> fluent_builders::DescribeFleetCapacity {
fluent_builders::DescribeFleetCapacity::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeFleetEvents`](crate::client::fluent_builders::DescribeFleetEvents) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::DescribeFleetEvents::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::DescribeFleetEvents::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::DescribeFleetEvents::set_fleet_id): <p>A unique identifier for the fleet to get event logs for. You can use either the fleet ID or ARN value.</p>
/// - [`start_time(DateTime)`](crate::client::fluent_builders::DescribeFleetEvents::start_time) / [`set_start_time(Option<DateTime>)`](crate::client::fluent_builders::DescribeFleetEvents::set_start_time): <p>The earliest date to retrieve event logs for. If no start time is specified, this call returns entries starting from when the fleet was created to the specified end time. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").</p>
/// - [`end_time(DateTime)`](crate::client::fluent_builders::DescribeFleetEvents::end_time) / [`set_end_time(Option<DateTime>)`](crate::client::fluent_builders::DescribeFleetEvents::set_end_time): <p>The most recent date to retrieve event logs for. If no end time is specified, this call returns entries from the specified start time up to the present. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").</p>
/// - [`limit(i32)`](crate::client::fluent_builders::DescribeFleetEvents::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::DescribeFleetEvents::set_limit): <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>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::DescribeFleetEvents::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::DescribeFleetEvents::set_next_token): <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>
/// - On success, responds with [`DescribeFleetEventsOutput`](crate::output::DescribeFleetEventsOutput) with field(s):
/// - [`events(Option<Vec<Event>>)`](crate::output::DescribeFleetEventsOutput::events): <p>A collection of objects containing event log entries for the specified fleet.</p>
/// - [`next_token(Option<String>)`](crate::output::DescribeFleetEventsOutput::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>
/// - On failure, responds with [`SdkError<DescribeFleetEventsError>`](crate::error::DescribeFleetEventsError)
pub fn describe_fleet_events(&self) -> fluent_builders::DescribeFleetEvents {
fluent_builders::DescribeFleetEvents::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeFleetLocationAttributes`](crate::client::fluent_builders::DescribeFleetLocationAttributes) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::DescribeFleetLocationAttributes::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::DescribeFleetLocationAttributes::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::DescribeFleetLocationAttributes::set_fleet_id): <p>A unique identifier for the fleet to retrieve remote locations for. You can use either the fleet ID or ARN value.</p>
/// - [`locations(Vec<String>)`](crate::client::fluent_builders::DescribeFleetLocationAttributes::locations) / [`set_locations(Option<Vec<String>>)`](crate::client::fluent_builders::DescribeFleetLocationAttributes::set_locations): <p>A list of fleet locations to retrieve information for. Specify locations in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
/// - [`limit(i32)`](crate::client::fluent_builders::DescribeFleetLocationAttributes::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::DescribeFleetLocationAttributes::set_limit): <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This limit is not currently enforced.</p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::DescribeFleetLocationAttributes::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::DescribeFleetLocationAttributes::set_next_token): <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>
/// - On success, responds with [`DescribeFleetLocationAttributesOutput`](crate::output::DescribeFleetLocationAttributesOutput) with field(s):
/// - [`fleet_id(Option<String>)`](crate::output::DescribeFleetLocationAttributesOutput::fleet_id): <p>A unique identifier for the fleet that location attributes were requested for.</p>
/// - [`fleet_arn(Option<String>)`](crate::output::DescribeFleetLocationAttributesOutput::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 GameLift 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>
/// - [`location_attributes(Option<Vec<LocationAttributes>>)`](crate::output::DescribeFleetLocationAttributesOutput::location_attributes): <p> Location-specific information on the requested fleet's remote locations.</p>
/// - [`next_token(Option<String>)`](crate::output::DescribeFleetLocationAttributesOutput::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>
/// - On failure, responds with [`SdkError<DescribeFleetLocationAttributesError>`](crate::error::DescribeFleetLocationAttributesError)
pub fn describe_fleet_location_attributes(
&self,
) -> fluent_builders::DescribeFleetLocationAttributes {
fluent_builders::DescribeFleetLocationAttributes::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeFleetLocationCapacity`](crate::client::fluent_builders::DescribeFleetLocationCapacity) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::DescribeFleetLocationCapacity::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::DescribeFleetLocationCapacity::set_fleet_id): <p>A unique identifier for the fleet to request location capacity for. You can use either the fleet ID or ARN value.</p>
/// - [`location(impl Into<String>)`](crate::client::fluent_builders::DescribeFleetLocationCapacity::location) / [`set_location(Option<String>)`](crate::client::fluent_builders::DescribeFleetLocationCapacity::set_location): <p>The fleet location to retrieve capacity information for. Specify a location in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
/// - On success, responds with [`DescribeFleetLocationCapacityOutput`](crate::output::DescribeFleetLocationCapacityOutput) with field(s):
/// - [`fleet_capacity(Option<FleetCapacity>)`](crate::output::DescribeFleetLocationCapacityOutput::fleet_capacity): <p>Resource capacity information for the requested fleet location. Capacity objects are returned only for fleets and locations that currently exist.</p>
/// - On failure, responds with [`SdkError<DescribeFleetLocationCapacityError>`](crate::error::DescribeFleetLocationCapacityError)
pub fn describe_fleet_location_capacity(
&self,
) -> fluent_builders::DescribeFleetLocationCapacity {
fluent_builders::DescribeFleetLocationCapacity::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeFleetLocationUtilization`](crate::client::fluent_builders::DescribeFleetLocationUtilization) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::DescribeFleetLocationUtilization::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::DescribeFleetLocationUtilization::set_fleet_id): <p>A unique identifier for the fleet to request location utilization for. You can use either the fleet ID or ARN value.</p>
/// - [`location(impl Into<String>)`](crate::client::fluent_builders::DescribeFleetLocationUtilization::location) / [`set_location(Option<String>)`](crate::client::fluent_builders::DescribeFleetLocationUtilization::set_location): <p>The fleet location to retrieve utilization information for. Specify a location in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
/// - On success, responds with [`DescribeFleetLocationUtilizationOutput`](crate::output::DescribeFleetLocationUtilizationOutput) with field(s):
/// - [`fleet_utilization(Option<FleetUtilization>)`](crate::output::DescribeFleetLocationUtilizationOutput::fleet_utilization): <p>Utilization information for the requested fleet location. Utilization objects are returned only for fleets and locations that currently exist.</p>
/// - On failure, responds with [`SdkError<DescribeFleetLocationUtilizationError>`](crate::error::DescribeFleetLocationUtilizationError)
pub fn describe_fleet_location_utilization(
&self,
) -> fluent_builders::DescribeFleetLocationUtilization {
fluent_builders::DescribeFleetLocationUtilization::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeFleetPortSettings`](crate::client::fluent_builders::DescribeFleetPortSettings) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::DescribeFleetPortSettings::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::DescribeFleetPortSettings::set_fleet_id): <p>A unique identifier for the fleet to retrieve port settings for. You can use either the fleet ID or ARN value.</p>
/// - [`location(impl Into<String>)`](crate::client::fluent_builders::DescribeFleetPortSettings::location) / [`set_location(Option<String>)`](crate::client::fluent_builders::DescribeFleetPortSettings::set_location): <p>A remote location to check for status of port setting updates. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>.</p>
/// - On success, responds with [`DescribeFleetPortSettingsOutput`](crate::output::DescribeFleetPortSettingsOutput) with field(s):
/// - [`fleet_id(Option<String>)`](crate::output::DescribeFleetPortSettingsOutput::fleet_id): <p>A unique identifier for the fleet that was requested. </p>
/// - [`fleet_arn(Option<String>)`](crate::output::DescribeFleetPortSettingsOutput::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 GameLift 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>
/// - [`inbound_permissions(Option<Vec<IpPermission>>)`](crate::output::DescribeFleetPortSettingsOutput::inbound_permissions): <p>The port settings for the requested fleet ID.</p>
/// - [`update_status(Option<LocationUpdateStatus>)`](crate::output::DescribeFleetPortSettingsOutput::update_status): <p>The current status of updates to the fleet's port settings in the requested fleet location. A status of <code>PENDING_UPDATE</code> indicates that an update was requested for the fleet but has not yet been completed for the location.</p>
/// - [`location(Option<String>)`](crate::output::DescribeFleetPortSettingsOutput::location): <p>The requested fleet location, expressed as an Amazon Web Services Region code, such as <code>us-west-2</code>. </p>
/// - On failure, responds with [`SdkError<DescribeFleetPortSettingsError>`](crate::error::DescribeFleetPortSettingsError)
pub fn describe_fleet_port_settings(&self) -> fluent_builders::DescribeFleetPortSettings {
fluent_builders::DescribeFleetPortSettings::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeFleetUtilization`](crate::client::fluent_builders::DescribeFleetUtilization) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::DescribeFleetUtilization::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`fleet_ids(Vec<String>)`](crate::client::fluent_builders::DescribeFleetUtilization::fleet_ids) / [`set_fleet_ids(Option<Vec<String>>)`](crate::client::fluent_builders::DescribeFleetUtilization::set_fleet_ids): <p>A unique identifier for the fleet to retrieve utilization data for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. </p>
/// - [`limit(i32)`](crate::client::fluent_builders::DescribeFleetUtilization::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::DescribeFleetUtilization::set_limit): <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::DescribeFleetUtilization::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::DescribeFleetUtilization::set_next_token): <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. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
/// - On success, responds with [`DescribeFleetUtilizationOutput`](crate::output::DescribeFleetUtilizationOutput) with field(s):
/// - [`fleet_utilization(Option<Vec<FleetUtilization>>)`](crate::output::DescribeFleetUtilizationOutput::fleet_utilization): <p>A collection of objects containing utilization information for each requested fleet ID. Utilization objects are returned only for fleets that currently exist.</p>
/// - [`next_token(Option<String>)`](crate::output::DescribeFleetUtilizationOutput::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>
/// - On failure, responds with [`SdkError<DescribeFleetUtilizationError>`](crate::error::DescribeFleetUtilizationError)
pub fn describe_fleet_utilization(&self) -> fluent_builders::DescribeFleetUtilization {
fluent_builders::DescribeFleetUtilization::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeGameServer`](crate::client::fluent_builders::DescribeGameServer) operation.
///
/// - The fluent builder is configurable:
/// - [`game_server_group_name(impl Into<String>)`](crate::client::fluent_builders::DescribeGameServer::game_server_group_name) / [`set_game_server_group_name(Option<String>)`](crate::client::fluent_builders::DescribeGameServer::set_game_server_group_name): <p>A unique identifier for the game server group where the game server is running.</p>
/// - [`game_server_id(impl Into<String>)`](crate::client::fluent_builders::DescribeGameServer::game_server_id) / [`set_game_server_id(Option<String>)`](crate::client::fluent_builders::DescribeGameServer::set_game_server_id): <p>A custom string that uniquely identifies the game server information to be retrieved.</p>
/// - On success, responds with [`DescribeGameServerOutput`](crate::output::DescribeGameServerOutput) with field(s):
/// - [`game_server(Option<GameServer>)`](crate::output::DescribeGameServerOutput::game_server): <p>Object that describes the requested game server.</p>
/// - On failure, responds with [`SdkError<DescribeGameServerError>`](crate::error::DescribeGameServerError)
pub fn describe_game_server(&self) -> fluent_builders::DescribeGameServer {
fluent_builders::DescribeGameServer::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeGameServerGroup`](crate::client::fluent_builders::DescribeGameServerGroup) operation.
///
/// - The fluent builder is configurable:
/// - [`game_server_group_name(impl Into<String>)`](crate::client::fluent_builders::DescribeGameServerGroup::game_server_group_name) / [`set_game_server_group_name(Option<String>)`](crate::client::fluent_builders::DescribeGameServerGroup::set_game_server_group_name): <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
/// - On success, responds with [`DescribeGameServerGroupOutput`](crate::output::DescribeGameServerGroupOutput) with field(s):
/// - [`game_server_group(Option<GameServerGroup>)`](crate::output::DescribeGameServerGroupOutput::game_server_group): <p>An object with the property settings for the requested game server group resource. </p>
/// - On failure, responds with [`SdkError<DescribeGameServerGroupError>`](crate::error::DescribeGameServerGroupError)
pub fn describe_game_server_group(&self) -> fluent_builders::DescribeGameServerGroup {
fluent_builders::DescribeGameServerGroup::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeGameServerInstances`](crate::client::fluent_builders::DescribeGameServerInstances) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::DescribeGameServerInstances::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`game_server_group_name(impl Into<String>)`](crate::client::fluent_builders::DescribeGameServerInstances::game_server_group_name) / [`set_game_server_group_name(Option<String>)`](crate::client::fluent_builders::DescribeGameServerInstances::set_game_server_group_name): <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
/// - [`instance_ids(Vec<String>)`](crate::client::fluent_builders::DescribeGameServerInstances::instance_ids) / [`set_instance_ids(Option<Vec<String>>)`](crate::client::fluent_builders::DescribeGameServerInstances::set_instance_ids): <p>The Amazon EC2 instance IDs that you want to retrieve status on. Amazon EC2 instance IDs use a 17-character format, for example: <code>i-1234567890abcdef0</code>. To retrieve all instances in the game server group, leave this parameter empty. </p>
/// - [`limit(i32)`](crate::client::fluent_builders::DescribeGameServerInstances::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::DescribeGameServerInstances::set_limit): <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>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::DescribeGameServerInstances::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::DescribeGameServerInstances::set_next_token): <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>
/// - On success, responds with [`DescribeGameServerInstancesOutput`](crate::output::DescribeGameServerInstancesOutput) with field(s):
/// - [`game_server_instances(Option<Vec<GameServerInstance>>)`](crate::output::DescribeGameServerInstancesOutput::game_server_instances): <p>The collection of requested game server instances.</p>
/// - [`next_token(Option<String>)`](crate::output::DescribeGameServerInstancesOutput::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>
/// - On failure, responds with [`SdkError<DescribeGameServerInstancesError>`](crate::error::DescribeGameServerInstancesError)
pub fn describe_game_server_instances(&self) -> fluent_builders::DescribeGameServerInstances {
fluent_builders::DescribeGameServerInstances::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeGameSessionDetails`](crate::client::fluent_builders::DescribeGameSessionDetails) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::DescribeGameSessionDetails::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::DescribeGameSessionDetails::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::DescribeGameSessionDetails::set_fleet_id): <p>A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.</p>
/// - [`game_session_id(impl Into<String>)`](crate::client::fluent_builders::DescribeGameSessionDetails::game_session_id) / [`set_game_session_id(Option<String>)`](crate::client::fluent_builders::DescribeGameSessionDetails::set_game_session_id): <p>A unique identifier for the game session to retrieve. </p>
/// - [`alias_id(impl Into<String>)`](crate::client::fluent_builders::DescribeGameSessionDetails::alias_id) / [`set_alias_id(Option<String>)`](crate::client::fluent_builders::DescribeGameSessionDetails::set_alias_id): <p>A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.</p>
/// - [`location(impl Into<String>)`](crate::client::fluent_builders::DescribeGameSessionDetails::location) / [`set_location(Option<String>)`](crate::client::fluent_builders::DescribeGameSessionDetails::set_location): <p>A fleet location to get game session details for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>. </p>
/// - [`status_filter(impl Into<String>)`](crate::client::fluent_builders::DescribeGameSessionDetails::status_filter) / [`set_status_filter(Option<String>)`](crate::client::fluent_builders::DescribeGameSessionDetails::set_status_filter): <p>Game session status to filter results on. Possible game session statuses include <code>ACTIVE</code>, <code>TERMINATED</code>, <code>ACTIVATING</code> and <code>TERMINATING</code> (the last two are transitory). </p>
/// - [`limit(i32)`](crate::client::fluent_builders::DescribeGameSessionDetails::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::DescribeGameSessionDetails::set_limit): <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>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::DescribeGameSessionDetails::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::DescribeGameSessionDetails::set_next_token): <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>
/// - On success, responds with [`DescribeGameSessionDetailsOutput`](crate::output::DescribeGameSessionDetailsOutput) with field(s):
/// - [`game_session_details(Option<Vec<GameSessionDetail>>)`](crate::output::DescribeGameSessionDetailsOutput::game_session_details): <p>A collection of properties for each game session that matches the request.</p>
/// - [`next_token(Option<String>)`](crate::output::DescribeGameSessionDetailsOutput::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>
/// - On failure, responds with [`SdkError<DescribeGameSessionDetailsError>`](crate::error::DescribeGameSessionDetailsError)
pub fn describe_game_session_details(&self) -> fluent_builders::DescribeGameSessionDetails {
fluent_builders::DescribeGameSessionDetails::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeGameSessionPlacement`](crate::client::fluent_builders::DescribeGameSessionPlacement) operation.
///
/// - The fluent builder is configurable:
/// - [`placement_id(impl Into<String>)`](crate::client::fluent_builders::DescribeGameSessionPlacement::placement_id) / [`set_placement_id(Option<String>)`](crate::client::fluent_builders::DescribeGameSessionPlacement::set_placement_id): <p>A unique identifier for a game session placement to retrieve.</p>
/// - On success, responds with [`DescribeGameSessionPlacementOutput`](crate::output::DescribeGameSessionPlacementOutput) with field(s):
/// - [`game_session_placement(Option<GameSessionPlacement>)`](crate::output::DescribeGameSessionPlacementOutput::game_session_placement): <p>Object that describes the requested game session placement.</p>
/// - On failure, responds with [`SdkError<DescribeGameSessionPlacementError>`](crate::error::DescribeGameSessionPlacementError)
pub fn describe_game_session_placement(&self) -> fluent_builders::DescribeGameSessionPlacement {
fluent_builders::DescribeGameSessionPlacement::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeGameSessionQueues`](crate::client::fluent_builders::DescribeGameSessionQueues) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::DescribeGameSessionQueues::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`names(Vec<String>)`](crate::client::fluent_builders::DescribeGameSessionQueues::names) / [`set_names(Option<Vec<String>>)`](crate::client::fluent_builders::DescribeGameSessionQueues::set_names): <p>A list of queue names to retrieve information for. You can use either the queue ID or ARN value. To request settings for all queues, leave this parameter empty. </p>
/// - [`limit(i32)`](crate::client::fluent_builders::DescribeGameSessionQueues::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::DescribeGameSessionQueues::set_limit): <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. You can request up to 50 results.</p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::DescribeGameSessionQueues::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::DescribeGameSessionQueues::set_next_token): <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>
/// - On success, responds with [`DescribeGameSessionQueuesOutput`](crate::output::DescribeGameSessionQueuesOutput) with field(s):
/// - [`game_session_queues(Option<Vec<GameSessionQueue>>)`](crate::output::DescribeGameSessionQueuesOutput::game_session_queues): <p>A collection of objects that describe the requested game session queues.</p>
/// - [`next_token(Option<String>)`](crate::output::DescribeGameSessionQueuesOutput::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>
/// - On failure, responds with [`SdkError<DescribeGameSessionQueuesError>`](crate::error::DescribeGameSessionQueuesError)
pub fn describe_game_session_queues(&self) -> fluent_builders::DescribeGameSessionQueues {
fluent_builders::DescribeGameSessionQueues::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeGameSessions`](crate::client::fluent_builders::DescribeGameSessions) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::DescribeGameSessions::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::DescribeGameSessions::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::DescribeGameSessions::set_fleet_id): <p>A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value. </p>
/// - [`game_session_id(impl Into<String>)`](crate::client::fluent_builders::DescribeGameSessions::game_session_id) / [`set_game_session_id(Option<String>)`](crate::client::fluent_builders::DescribeGameSessions::set_game_session_id): <p>A unique identifier for the game session to retrieve. </p>
/// - [`alias_id(impl Into<String>)`](crate::client::fluent_builders::DescribeGameSessions::alias_id) / [`set_alias_id(Option<String>)`](crate::client::fluent_builders::DescribeGameSessions::set_alias_id): <p>A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the alias ID or ARN value.</p>
/// - [`location(impl Into<String>)`](crate::client::fluent_builders::DescribeGameSessions::location) / [`set_location(Option<String>)`](crate::client::fluent_builders::DescribeGameSessions::set_location): <p>A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>. </p>
/// - [`status_filter(impl Into<String>)`](crate::client::fluent_builders::DescribeGameSessions::status_filter) / [`set_status_filter(Option<String>)`](crate::client::fluent_builders::DescribeGameSessions::set_status_filter): <p>Game session status to filter results on. You can filter on the following states: <code>ACTIVE</code>, <code>TERMINATED</code>, <code>ACTIVATING</code>, and <code>TERMINATING</code>. The last two are transitory and used for only very brief periods of time. </p>
/// - [`limit(i32)`](crate::client::fluent_builders::DescribeGameSessions::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::DescribeGameSessions::set_limit): <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>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::DescribeGameSessions::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::DescribeGameSessions::set_next_token): <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>
/// - On success, responds with [`DescribeGameSessionsOutput`](crate::output::DescribeGameSessionsOutput) with field(s):
/// - [`game_sessions(Option<Vec<GameSession>>)`](crate::output::DescribeGameSessionsOutput::game_sessions): <p>A collection of properties for each game session that matches the request.</p>
/// - [`next_token(Option<String>)`](crate::output::DescribeGameSessionsOutput::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>
/// - On failure, responds with [`SdkError<DescribeGameSessionsError>`](crate::error::DescribeGameSessionsError)
pub fn describe_game_sessions(&self) -> fluent_builders::DescribeGameSessions {
fluent_builders::DescribeGameSessions::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeInstances`](crate::client::fluent_builders::DescribeInstances) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::DescribeInstances::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::DescribeInstances::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::DescribeInstances::set_fleet_id): <p>A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.</p>
/// - [`instance_id(impl Into<String>)`](crate::client::fluent_builders::DescribeInstances::instance_id) / [`set_instance_id(Option<String>)`](crate::client::fluent_builders::DescribeInstances::set_instance_id): <p>A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.</p>
/// - [`limit(i32)`](crate::client::fluent_builders::DescribeInstances::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::DescribeInstances::set_limit): <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>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::DescribeInstances::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::DescribeInstances::set_next_token): <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>
/// - [`location(impl Into<String>)`](crate::client::fluent_builders::DescribeInstances::location) / [`set_location(Option<String>)`](crate::client::fluent_builders::DescribeInstances::set_location): <p>The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>. </p>
/// - On success, responds with [`DescribeInstancesOutput`](crate::output::DescribeInstancesOutput) with field(s):
/// - [`instances(Option<Vec<Instance>>)`](crate::output::DescribeInstancesOutput::instances): <p>A collection of objects containing properties for each instance returned.</p>
/// - [`next_token(Option<String>)`](crate::output::DescribeInstancesOutput::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>
/// - On failure, responds with [`SdkError<DescribeInstancesError>`](crate::error::DescribeInstancesError)
pub fn describe_instances(&self) -> fluent_builders::DescribeInstances {
fluent_builders::DescribeInstances::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeMatchmaking`](crate::client::fluent_builders::DescribeMatchmaking) operation.
///
/// - The fluent builder is configurable:
/// - [`ticket_ids(Vec<String>)`](crate::client::fluent_builders::DescribeMatchmaking::ticket_ids) / [`set_ticket_ids(Option<Vec<String>>)`](crate::client::fluent_builders::DescribeMatchmaking::set_ticket_ids): <p>A unique identifier for a matchmaking ticket. You can include up to 10 ID values. </p>
/// - On success, responds with [`DescribeMatchmakingOutput`](crate::output::DescribeMatchmakingOutput) with field(s):
/// - [`ticket_list(Option<Vec<MatchmakingTicket>>)`](crate::output::DescribeMatchmakingOutput::ticket_list): <p>A collection of existing matchmaking ticket objects matching the request.</p>
/// - On failure, responds with [`SdkError<DescribeMatchmakingError>`](crate::error::DescribeMatchmakingError)
pub fn describe_matchmaking(&self) -> fluent_builders::DescribeMatchmaking {
fluent_builders::DescribeMatchmaking::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeMatchmakingConfigurations`](crate::client::fluent_builders::DescribeMatchmakingConfigurations) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::DescribeMatchmakingConfigurations::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`names(Vec<String>)`](crate::client::fluent_builders::DescribeMatchmakingConfigurations::names) / [`set_names(Option<Vec<String>>)`](crate::client::fluent_builders::DescribeMatchmakingConfigurations::set_names): <p>A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration name or ARN value. To request all existing configurations, leave this parameter empty.</p>
/// - [`rule_set_name(impl Into<String>)`](crate::client::fluent_builders::DescribeMatchmakingConfigurations::rule_set_name) / [`set_rule_set_name(Option<String>)`](crate::client::fluent_builders::DescribeMatchmakingConfigurations::set_rule_set_name): <p>A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use this parameter to retrieve all matchmaking configurations that use this rule set.</p>
/// - [`limit(i32)`](crate::client::fluent_builders::DescribeMatchmakingConfigurations::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::DescribeMatchmakingConfigurations::set_limit): <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This parameter is limited to 10.</p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::DescribeMatchmakingConfigurations::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::DescribeMatchmakingConfigurations::set_next_token): <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>
/// - On success, responds with [`DescribeMatchmakingConfigurationsOutput`](crate::output::DescribeMatchmakingConfigurationsOutput) with field(s):
/// - [`configurations(Option<Vec<MatchmakingConfiguration>>)`](crate::output::DescribeMatchmakingConfigurationsOutput::configurations): <p>A collection of requested matchmaking configurations.</p>
/// - [`next_token(Option<String>)`](crate::output::DescribeMatchmakingConfigurationsOutput::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>
/// - On failure, responds with [`SdkError<DescribeMatchmakingConfigurationsError>`](crate::error::DescribeMatchmakingConfigurationsError)
pub fn describe_matchmaking_configurations(
&self,
) -> fluent_builders::DescribeMatchmakingConfigurations {
fluent_builders::DescribeMatchmakingConfigurations::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeMatchmakingRuleSets`](crate::client::fluent_builders::DescribeMatchmakingRuleSets) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::DescribeMatchmakingRuleSets::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`names(Vec<String>)`](crate::client::fluent_builders::DescribeMatchmakingRuleSets::names) / [`set_names(Option<Vec<String>>)`](crate::client::fluent_builders::DescribeMatchmakingRuleSets::set_names): <p>A list of one or more matchmaking rule set names to retrieve details for. (Note: The rule set name is different from the optional "name" field in the rule set body.) You can use either the rule set name or ARN value. </p>
/// - [`limit(i32)`](crate::client::fluent_builders::DescribeMatchmakingRuleSets::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::DescribeMatchmakingRuleSets::set_limit): <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>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::DescribeMatchmakingRuleSets::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::DescribeMatchmakingRuleSets::set_next_token): <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>
/// - On success, responds with [`DescribeMatchmakingRuleSetsOutput`](crate::output::DescribeMatchmakingRuleSetsOutput) with field(s):
/// - [`rule_sets(Option<Vec<MatchmakingRuleSet>>)`](crate::output::DescribeMatchmakingRuleSetsOutput::rule_sets): <p>A collection of requested matchmaking rule set objects. </p>
/// - [`next_token(Option<String>)`](crate::output::DescribeMatchmakingRuleSetsOutput::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>
/// - On failure, responds with [`SdkError<DescribeMatchmakingRuleSetsError>`](crate::error::DescribeMatchmakingRuleSetsError)
pub fn describe_matchmaking_rule_sets(&self) -> fluent_builders::DescribeMatchmakingRuleSets {
fluent_builders::DescribeMatchmakingRuleSets::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribePlayerSessions`](crate::client::fluent_builders::DescribePlayerSessions) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::DescribePlayerSessions::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`game_session_id(impl Into<String>)`](crate::client::fluent_builders::DescribePlayerSessions::game_session_id) / [`set_game_session_id(Option<String>)`](crate::client::fluent_builders::DescribePlayerSessions::set_game_session_id): <p>A unique identifier for the game session to retrieve player sessions for.</p>
/// - [`player_id(impl Into<String>)`](crate::client::fluent_builders::DescribePlayerSessions::player_id) / [`set_player_id(Option<String>)`](crate::client::fluent_builders::DescribePlayerSessions::set_player_id): <p>A unique identifier for a player to retrieve player sessions for.</p>
/// - [`player_session_id(impl Into<String>)`](crate::client::fluent_builders::DescribePlayerSessions::player_session_id) / [`set_player_session_id(Option<String>)`](crate::client::fluent_builders::DescribePlayerSessions::set_player_session_id): <p>A unique identifier for a player session to retrieve.</p>
/// - [`player_session_status_filter(impl Into<String>)`](crate::client::fluent_builders::DescribePlayerSessions::player_session_status_filter) / [`set_player_session_status_filter(Option<String>)`](crate::client::fluent_builders::DescribePlayerSessions::set_player_session_status_filter): <p>Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.</p> <p>Possible player session statuses include the following:</p> <ul> <li> <p> <b>RESERVED</b> -- The player session request has been received, but the player has not yet connected to the server process and/or been validated. </p> </li> <li> <p> <b>ACTIVE</b> -- The player has been validated by the server process and is currently connected.</p> </li> <li> <p> <b>COMPLETED</b> -- The player connection has been dropped.</p> </li> <li> <p> <b>TIMEDOUT</b> -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).</p> </li> </ul>
/// - [`limit(i32)`](crate::client::fluent_builders::DescribePlayerSessions::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::DescribePlayerSessions::set_limit): <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.</p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::DescribePlayerSessions::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::DescribePlayerSessions::set_next_token): <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. If a player session ID is specified, this parameter is ignored.</p>
/// - On success, responds with [`DescribePlayerSessionsOutput`](crate::output::DescribePlayerSessionsOutput) with field(s):
/// - [`player_sessions(Option<Vec<PlayerSession>>)`](crate::output::DescribePlayerSessionsOutput::player_sessions): <p>A collection of objects containing properties for each player session that matches the request.</p>
/// - [`next_token(Option<String>)`](crate::output::DescribePlayerSessionsOutput::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>
/// - On failure, responds with [`SdkError<DescribePlayerSessionsError>`](crate::error::DescribePlayerSessionsError)
pub fn describe_player_sessions(&self) -> fluent_builders::DescribePlayerSessions {
fluent_builders::DescribePlayerSessions::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeRuntimeConfiguration`](crate::client::fluent_builders::DescribeRuntimeConfiguration) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::DescribeRuntimeConfiguration::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::DescribeRuntimeConfiguration::set_fleet_id): <p>A unique identifier for the fleet to get the runtime configuration for. You can use either the fleet ID or ARN value.</p>
/// - On success, responds with [`DescribeRuntimeConfigurationOutput`](crate::output::DescribeRuntimeConfigurationOutput) with field(s):
/// - [`runtime_configuration(Option<RuntimeConfiguration>)`](crate::output::DescribeRuntimeConfigurationOutput::runtime_configuration): <p>Instructions that describe how server processes should be launched and maintained on each instance in the fleet.</p>
/// - On failure, responds with [`SdkError<DescribeRuntimeConfigurationError>`](crate::error::DescribeRuntimeConfigurationError)
pub fn describe_runtime_configuration(&self) -> fluent_builders::DescribeRuntimeConfiguration {
fluent_builders::DescribeRuntimeConfiguration::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeScalingPolicies`](crate::client::fluent_builders::DescribeScalingPolicies) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::DescribeScalingPolicies::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::DescribeScalingPolicies::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::DescribeScalingPolicies::set_fleet_id): <p>A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN value.</p>
/// - [`status_filter(ScalingStatusType)`](crate::client::fluent_builders::DescribeScalingPolicies::status_filter) / [`set_status_filter(Option<ScalingStatusType>)`](crate::client::fluent_builders::DescribeScalingPolicies::set_status_filter): <p>Scaling policy status to filter results on. A scaling policy is only in force when in an <code>ACTIVE</code> status.</p> <ul> <li> <p> <b>ACTIVE</b> -- The scaling policy is currently in force.</p> </li> <li> <p> <b>UPDATEREQUESTED</b> -- A request to update the scaling policy has been received.</p> </li> <li> <p> <b>UPDATING</b> -- A change is being made to the scaling policy.</p> </li> <li> <p> <b>DELETEREQUESTED</b> -- A request to delete the scaling policy has been received.</p> </li> <li> <p> <b>DELETING</b> -- The scaling policy is being deleted.</p> </li> <li> <p> <b>DELETED</b> -- The scaling policy has been deleted.</p> </li> <li> <p> <b>ERROR</b> -- An error occurred in creating the policy. It should be removed and recreated.</p> </li> </ul>
/// - [`limit(i32)`](crate::client::fluent_builders::DescribeScalingPolicies::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::DescribeScalingPolicies::set_limit): <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>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::DescribeScalingPolicies::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::DescribeScalingPolicies::set_next_token): <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>
/// - [`location(impl Into<String>)`](crate::client::fluent_builders::DescribeScalingPolicies::location) / [`set_location(Option<String>)`](crate::client::fluent_builders::DescribeScalingPolicies::set_location): <p> The fleet location. If you don't specify this value, the response contains the scaling policies of every location in the fleet. </p>
/// - On success, responds with [`DescribeScalingPoliciesOutput`](crate::output::DescribeScalingPoliciesOutput) with field(s):
/// - [`scaling_policies(Option<Vec<ScalingPolicy>>)`](crate::output::DescribeScalingPoliciesOutput::scaling_policies): <p>A collection of objects containing the scaling policies matching the request.</p>
/// - [`next_token(Option<String>)`](crate::output::DescribeScalingPoliciesOutput::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>
/// - On failure, responds with [`SdkError<DescribeScalingPoliciesError>`](crate::error::DescribeScalingPoliciesError)
pub fn describe_scaling_policies(&self) -> fluent_builders::DescribeScalingPolicies {
fluent_builders::DescribeScalingPolicies::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeScript`](crate::client::fluent_builders::DescribeScript) operation.
///
/// - The fluent builder is configurable:
/// - [`script_id(impl Into<String>)`](crate::client::fluent_builders::DescribeScript::script_id) / [`set_script_id(Option<String>)`](crate::client::fluent_builders::DescribeScript::set_script_id): <p>A unique identifier for the Realtime script to retrieve properties for. You can use either the script ID or ARN value.</p>
/// - On success, responds with [`DescribeScriptOutput`](crate::output::DescribeScriptOutput) with field(s):
/// - [`script(Option<Script>)`](crate::output::DescribeScriptOutput::script): <p>A set of properties describing the requested script.</p>
/// - On failure, responds with [`SdkError<DescribeScriptError>`](crate::error::DescribeScriptError)
pub fn describe_script(&self) -> fluent_builders::DescribeScript {
fluent_builders::DescribeScript::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeVpcPeeringAuthorizations`](crate::client::fluent_builders::DescribeVpcPeeringAuthorizations) operation.
///
/// - The fluent builder takes no input, just [`send`](crate::client::fluent_builders::DescribeVpcPeeringAuthorizations::send) it.
/// - On success, responds with [`DescribeVpcPeeringAuthorizationsOutput`](crate::output::DescribeVpcPeeringAuthorizationsOutput) with field(s):
/// - [`vpc_peering_authorizations(Option<Vec<VpcPeeringAuthorization>>)`](crate::output::DescribeVpcPeeringAuthorizationsOutput::vpc_peering_authorizations): <p>A collection of objects that describe all valid VPC peering operations for the current Amazon Web Services account.</p>
/// - On failure, responds with [`SdkError<DescribeVpcPeeringAuthorizationsError>`](crate::error::DescribeVpcPeeringAuthorizationsError)
pub fn describe_vpc_peering_authorizations(
&self,
) -> fluent_builders::DescribeVpcPeeringAuthorizations {
fluent_builders::DescribeVpcPeeringAuthorizations::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`DescribeVpcPeeringConnections`](crate::client::fluent_builders::DescribeVpcPeeringConnections) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::DescribeVpcPeeringConnections::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::DescribeVpcPeeringConnections::set_fleet_id): <p>A unique identifier for the fleet. You can use either the fleet ID or ARN value.</p>
/// - On success, responds with [`DescribeVpcPeeringConnectionsOutput`](crate::output::DescribeVpcPeeringConnectionsOutput) with field(s):
/// - [`vpc_peering_connections(Option<Vec<VpcPeeringConnection>>)`](crate::output::DescribeVpcPeeringConnectionsOutput::vpc_peering_connections): <p>A collection of VPC peering connection records that match the request.</p>
/// - On failure, responds with [`SdkError<DescribeVpcPeeringConnectionsError>`](crate::error::DescribeVpcPeeringConnectionsError)
pub fn describe_vpc_peering_connections(
&self,
) -> fluent_builders::DescribeVpcPeeringConnections {
fluent_builders::DescribeVpcPeeringConnections::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetComputeAccess`](crate::client::fluent_builders::GetComputeAccess) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::GetComputeAccess::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::GetComputeAccess::set_fleet_id): <p>A unique identifier for the fleet that the compute resource is registered to.</p>
/// - [`compute_name(impl Into<String>)`](crate::client::fluent_builders::GetComputeAccess::compute_name) / [`set_compute_name(Option<String>)`](crate::client::fluent_builders::GetComputeAccess::set_compute_name): <p>The name of the compute resource you are requesting credentials for.</p>
/// - On success, responds with [`GetComputeAccessOutput`](crate::output::GetComputeAccessOutput) with field(s):
/// - [`fleet_id(Option<String>)`](crate::output::GetComputeAccessOutput::fleet_id): <p>The fleet ID of compute resource.</p>
/// - [`fleet_arn(Option<String>)`](crate::output::GetComputeAccessOutput::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 GameLift 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>
/// - [`compute_name(Option<String>)`](crate::output::GetComputeAccessOutput::compute_name): <p>The name of the compute resource you requested credentials for.</p>
/// - [`compute_arn(Option<String>)`](crate::output::GetComputeAccessOutput::compute_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 GameLift compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift: <region> ::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 </region></code>.</p>
/// - [`credentials(Option<AwsCredentials>)`](crate::output::GetComputeAccessOutput::credentials): <p>The access credentials for the compute resource.</p>
/// - On failure, responds with [`SdkError<GetComputeAccessError>`](crate::error::GetComputeAccessError)
pub fn get_compute_access(&self) -> fluent_builders::GetComputeAccess {
fluent_builders::GetComputeAccess::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetComputeAuthToken`](crate::client::fluent_builders::GetComputeAuthToken) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::GetComputeAuthToken::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::GetComputeAuthToken::set_fleet_id): <p>A unique identifier for the fleet that the compute is registered to.</p>
/// - [`compute_name(impl Into<String>)`](crate::client::fluent_builders::GetComputeAuthToken::compute_name) / [`set_compute_name(Option<String>)`](crate::client::fluent_builders::GetComputeAuthToken::set_compute_name): <p>The name of the compute resource you are requesting the authorization token for.</p>
/// - On success, responds with [`GetComputeAuthTokenOutput`](crate::output::GetComputeAuthTokenOutput) with field(s):
/// - [`fleet_id(Option<String>)`](crate::output::GetComputeAuthTokenOutput::fleet_id): <p>A unique identifier for the fleet that the compute is registered to.</p>
/// - [`fleet_arn(Option<String>)`](crate::output::GetComputeAuthTokenOutput::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 GameLift 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>
/// - [`compute_name(Option<String>)`](crate::output::GetComputeAuthTokenOutput::compute_name): <p>The name of the compute resource you are requesting the authorization token for.</p>
/// - [`compute_arn(Option<String>)`](crate::output::GetComputeAuthTokenOutput::compute_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 GameLift compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift: <region> ::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 </region></code> </p>
/// - [`auth_token(Option<String>)`](crate::output::GetComputeAuthTokenOutput::auth_token): <p>The authorization token that your game server uses to authenticate with GameLift.</p>
/// - [`expiration_timestamp(Option<DateTime>)`](crate::output::GetComputeAuthTokenOutput::expiration_timestamp): <p>The amount of time until the authorization token is no longer valid. To continue using the compute resource for game server hosting, renew the authorization token by using this operation again.</p>
/// - On failure, responds with [`SdkError<GetComputeAuthTokenError>`](crate::error::GetComputeAuthTokenError)
pub fn get_compute_auth_token(&self) -> fluent_builders::GetComputeAuthToken {
fluent_builders::GetComputeAuthToken::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetGameSessionLogUrl`](crate::client::fluent_builders::GetGameSessionLogUrl) operation.
///
/// - The fluent builder is configurable:
/// - [`game_session_id(impl Into<String>)`](crate::client::fluent_builders::GetGameSessionLogUrl::game_session_id) / [`set_game_session_id(Option<String>)`](crate::client::fluent_builders::GetGameSessionLogUrl::set_game_session_id): <p>A unique identifier for the game session to get logs for. </p>
/// - On success, responds with [`GetGameSessionLogUrlOutput`](crate::output::GetGameSessionLogUrlOutput) with field(s):
/// - [`pre_signed_url(Option<String>)`](crate::output::GetGameSessionLogUrlOutput::pre_signed_url): <p>Location of the requested game session logs, available for download. This URL is valid for 15 minutes, after which S3 will reject any download request using this URL. You can request a new URL any time within the 14-day period that the logs are retained.</p>
/// - On failure, responds with [`SdkError<GetGameSessionLogUrlError>`](crate::error::GetGameSessionLogUrlError)
pub fn get_game_session_log_url(&self) -> fluent_builders::GetGameSessionLogUrl {
fluent_builders::GetGameSessionLogUrl::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`GetInstanceAccess`](crate::client::fluent_builders::GetInstanceAccess) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::GetInstanceAccess::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::GetInstanceAccess::set_fleet_id): <p>A unique identifier for the fleet that contains the instance you want access to. You can use either the fleet ID or ARN value. The fleet can be in any of the following statuses: <code>ACTIVATING</code>, <code>ACTIVE</code>, or <code>ERROR</code>. Fleets with an <code>ERROR</code> status may be accessible for a short time before they are deleted.</p>
/// - [`instance_id(impl Into<String>)`](crate::client::fluent_builders::GetInstanceAccess::instance_id) / [`set_instance_id(Option<String>)`](crate::client::fluent_builders::GetInstanceAccess::set_instance_id): <p>A unique identifier for the instance you want to get access to. You can access an instance in any status.</p>
/// - On success, responds with [`GetInstanceAccessOutput`](crate::output::GetInstanceAccessOutput) with field(s):
/// - [`instance_access(Option<InstanceAccess>)`](crate::output::GetInstanceAccessOutput::instance_access): <p>The connection information for a fleet instance, including IP address and access credentials.</p>
/// - On failure, responds with [`SdkError<GetInstanceAccessError>`](crate::error::GetInstanceAccessError)
pub fn get_instance_access(&self) -> fluent_builders::GetInstanceAccess {
fluent_builders::GetInstanceAccess::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListAliases`](crate::client::fluent_builders::ListAliases) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListAliases::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`routing_strategy_type(RoutingStrategyType)`](crate::client::fluent_builders::ListAliases::routing_strategy_type) / [`set_routing_strategy_type(Option<RoutingStrategyType>)`](crate::client::fluent_builders::ListAliases::set_routing_strategy_type): <p>The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing type. To retrieve all aliases, leave this parameter empty.</p> <p>Possible routing types include the following:</p> <ul> <li> <p> <b>SIMPLE</b> -- The alias resolves to one specific fleet. Use this type when routing to active fleets.</p> </li> <li> <p> <b>TERMINAL</b> -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_RoutingStrategy.html">RoutingStrategy</a> message embedded.</p> </li> </ul>
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::ListAliases::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::ListAliases::set_name): <p>A descriptive label that is associated with an alias. Alias names do not need to be unique.</p>
/// - [`limit(i32)`](crate::client::fluent_builders::ListAliases::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::ListAliases::set_limit): <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>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListAliases::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListAliases::set_next_token): <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>
/// - On success, responds with [`ListAliasesOutput`](crate::output::ListAliasesOutput) with field(s):
/// - [`aliases(Option<Vec<Alias>>)`](crate::output::ListAliasesOutput::aliases): <p>A collection of alias resources that match the request parameters.</p>
/// - [`next_token(Option<String>)`](crate::output::ListAliasesOutput::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>
/// - On failure, responds with [`SdkError<ListAliasesError>`](crate::error::ListAliasesError)
pub fn list_aliases(&self) -> fluent_builders::ListAliases {
fluent_builders::ListAliases::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListBuilds`](crate::client::fluent_builders::ListBuilds) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListBuilds::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`status(BuildStatus)`](crate::client::fluent_builders::ListBuilds::status) / [`set_status(Option<BuildStatus>)`](crate::client::fluent_builders::ListBuilds::set_status): <p>Build status to filter results by. To retrieve all builds, leave this parameter empty.</p> <p>Possible build statuses include the following:</p> <ul> <li> <p> <b>INITIALIZED</b> -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value. </p> </li> <li> <p> <b>READY</b> -- The game build has been successfully uploaded. You can now create new fleets for this build.</p> </li> <li> <p> <b>FAILED</b> -- The game build upload failed. You cannot create new fleets for this build. </p> </li> </ul>
/// - [`limit(i32)`](crate::client::fluent_builders::ListBuilds::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::ListBuilds::set_limit): <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>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListBuilds::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListBuilds::set_next_token): <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>
/// - On success, responds with [`ListBuildsOutput`](crate::output::ListBuildsOutput) with field(s):
/// - [`builds(Option<Vec<Build>>)`](crate::output::ListBuildsOutput::builds): <p>A collection of build resources that match the request.</p>
/// - [`next_token(Option<String>)`](crate::output::ListBuildsOutput::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>
/// - On failure, responds with [`SdkError<ListBuildsError>`](crate::error::ListBuildsError)
pub fn list_builds(&self) -> fluent_builders::ListBuilds {
fluent_builders::ListBuilds::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListCompute`](crate::client::fluent_builders::ListCompute) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListCompute::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::ListCompute::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::ListCompute::set_fleet_id): <p>A unique identifier for the fleet the compute resources are registered to.</p>
/// - [`location(impl Into<String>)`](crate::client::fluent_builders::ListCompute::location) / [`set_location(Option<String>)`](crate::client::fluent_builders::ListCompute::set_location): <p>The name of the custom location that the compute resources are assigned to.</p>
/// - [`limit(i32)`](crate::client::fluent_builders::ListCompute::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::ListCompute::set_limit): <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>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListCompute::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListCompute::set_next_token): <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>
/// - On success, responds with [`ListComputeOutput`](crate::output::ListComputeOutput) with field(s):
/// - [`compute_list(Option<Vec<Compute>>)`](crate::output::ListComputeOutput::compute_list): <p>A list of compute resources registered to the fleet you specified.</p>
/// - [`next_token(Option<String>)`](crate::output::ListComputeOutput::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>
/// - On failure, responds with [`SdkError<ListComputeError>`](crate::error::ListComputeError)
pub fn list_compute(&self) -> fluent_builders::ListCompute {
fluent_builders::ListCompute::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListFleets`](crate::client::fluent_builders::ListFleets) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListFleets::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`build_id(impl Into<String>)`](crate::client::fluent_builders::ListFleets::build_id) / [`set_build_id(Option<String>)`](crate::client::fluent_builders::ListFleets::set_build_id): <p>A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value.</p>
/// - [`script_id(impl Into<String>)`](crate::client::fluent_builders::ListFleets::script_id) / [`set_script_id(Option<String>)`](crate::client::fluent_builders::ListFleets::set_script_id): <p>A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value.</p>
/// - [`limit(i32)`](crate::client::fluent_builders::ListFleets::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::ListFleets::set_limit): <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>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListFleets::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListFleets::set_next_token): <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>
/// - On success, responds with [`ListFleetsOutput`](crate::output::ListFleetsOutput) with field(s):
/// - [`fleet_ids(Option<Vec<String>>)`](crate::output::ListFleetsOutput::fleet_ids): <p>A set of fleet IDs that match the list request.</p>
/// - [`next_token(Option<String>)`](crate::output::ListFleetsOutput::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>
/// - On failure, responds with [`SdkError<ListFleetsError>`](crate::error::ListFleetsError)
pub fn list_fleets(&self) -> fluent_builders::ListFleets {
fluent_builders::ListFleets::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListGameServerGroups`](crate::client::fluent_builders::ListGameServerGroups) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListGameServerGroups::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`limit(i32)`](crate::client::fluent_builders::ListGameServerGroups::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::ListGameServerGroups::set_limit): <p>The game server groups' limit.</p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListGameServerGroups::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListGameServerGroups::set_next_token): <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
/// - On success, responds with [`ListGameServerGroupsOutput`](crate::output::ListGameServerGroupsOutput) with field(s):
/// - [`game_server_groups(Option<Vec<GameServerGroup>>)`](crate::output::ListGameServerGroupsOutput::game_server_groups): <p>The game server groups' game server groups.</p>
/// - [`next_token(Option<String>)`](crate::output::ListGameServerGroupsOutput::next_token): <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
/// - On failure, responds with [`SdkError<ListGameServerGroupsError>`](crate::error::ListGameServerGroupsError)
pub fn list_game_server_groups(&self) -> fluent_builders::ListGameServerGroups {
fluent_builders::ListGameServerGroups::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListGameServers`](crate::client::fluent_builders::ListGameServers) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListGameServers::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`game_server_group_name(impl Into<String>)`](crate::client::fluent_builders::ListGameServers::game_server_group_name) / [`set_game_server_group_name(Option<String>)`](crate::client::fluent_builders::ListGameServers::set_game_server_group_name): <p>An identifier for the game server group to retrieve a list of game servers from. Use either the name or ARN value.</p>
/// - [`sort_order(SortOrder)`](crate::client::fluent_builders::ListGameServers::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::client::fluent_builders::ListGameServers::set_sort_order): <p>Indicates how to sort the returned data based on game server registration timestamp. Use <code>ASCENDING</code> to retrieve oldest game servers first, or use <code>DESCENDING</code> to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.</p>
/// - [`limit(i32)`](crate::client::fluent_builders::ListGameServers::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::ListGameServers::set_limit): <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>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListGameServers::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListGameServers::set_next_token): <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>
/// - On success, responds with [`ListGameServersOutput`](crate::output::ListGameServersOutput) with field(s):
/// - [`game_servers(Option<Vec<GameServer>>)`](crate::output::ListGameServersOutput::game_servers): <p>A collection of game server objects that match the request.</p>
/// - [`next_token(Option<String>)`](crate::output::ListGameServersOutput::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>
/// - On failure, responds with [`SdkError<ListGameServersError>`](crate::error::ListGameServersError)
pub fn list_game_servers(&self) -> fluent_builders::ListGameServers {
fluent_builders::ListGameServers::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListLocations`](crate::client::fluent_builders::ListLocations) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListLocations::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`filters(Vec<LocationFilter>)`](crate::client::fluent_builders::ListLocations::filters) / [`set_filters(Option<Vec<LocationFilter>>)`](crate::client::fluent_builders::ListLocations::set_filters): <p>Filters the list for <code>AWS</code> or <code>CUSTOM</code> locations.</p>
/// - [`limit(i32)`](crate::client::fluent_builders::ListLocations::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::ListLocations::set_limit): <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>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListLocations::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListLocations::set_next_token): <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>
/// - On success, responds with [`ListLocationsOutput`](crate::output::ListLocationsOutput) with field(s):
/// - [`locations(Option<Vec<LocationModel>>)`](crate::output::ListLocationsOutput::locations): <p>A collection of locations.</p>
/// - [`next_token(Option<String>)`](crate::output::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>
/// - On failure, responds with [`SdkError<ListLocationsError>`](crate::error::ListLocationsError)
pub fn list_locations(&self) -> fluent_builders::ListLocations {
fluent_builders::ListLocations::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListScripts`](crate::client::fluent_builders::ListScripts) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::ListScripts::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`limit(i32)`](crate::client::fluent_builders::ListScripts::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::ListScripts::set_limit): <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>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::ListScripts::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::ListScripts::set_next_token): <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>
/// - On success, responds with [`ListScriptsOutput`](crate::output::ListScriptsOutput) with field(s):
/// - [`scripts(Option<Vec<Script>>)`](crate::output::ListScriptsOutput::scripts): <p>A set of properties describing the requested script.</p>
/// - [`next_token(Option<String>)`](crate::output::ListScriptsOutput::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>
/// - On failure, responds with [`SdkError<ListScriptsError>`](crate::error::ListScriptsError)
pub fn list_scripts(&self) -> fluent_builders::ListScripts {
fluent_builders::ListScripts::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ListTagsForResource`](crate::client::fluent_builders::ListTagsForResource) operation.
///
/// - The fluent builder is configurable:
/// - [`resource_arn(impl Into<String>)`](crate::client::fluent_builders::ListTagsForResource::resource_arn) / [`set_resource_arn(Option<String>)`](crate::client::fluent_builders::ListTagsForResource::set_resource_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 and uniquely identifies the GameLift resource that you want to retrieve tags for. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type. </p>
/// - On success, responds with [`ListTagsForResourceOutput`](crate::output::ListTagsForResourceOutput) with field(s):
/// - [`tags(Option<Vec<Tag>>)`](crate::output::ListTagsForResourceOutput::tags): <p>The collection of tags that have been assigned to the specified resource. </p>
/// - On failure, responds with [`SdkError<ListTagsForResourceError>`](crate::error::ListTagsForResourceError)
pub fn list_tags_for_resource(&self) -> fluent_builders::ListTagsForResource {
fluent_builders::ListTagsForResource::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`PutScalingPolicy`](crate::client::fluent_builders::PutScalingPolicy) operation.
///
/// - The fluent builder is configurable:
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::PutScalingPolicy::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::PutScalingPolicy::set_name): <p>A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.</p>
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::PutScalingPolicy::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::PutScalingPolicy::set_fleet_id): <p>A unique identifier for the fleet to apply this policy to. You can use either the fleet ID or ARN value. The fleet cannot be in any of the following statuses: ERROR or DELETING.</p>
/// - [`scaling_adjustment(i32)`](crate::client::fluent_builders::PutScalingPolicy::scaling_adjustment) / [`set_scaling_adjustment(i32)`](crate::client::fluent_builders::PutScalingPolicy::set_scaling_adjustment): <p>Amount of adjustment to make, based on the scaling adjustment type.</p>
/// - [`scaling_adjustment_type(ScalingAdjustmentType)`](crate::client::fluent_builders::PutScalingPolicy::scaling_adjustment_type) / [`set_scaling_adjustment_type(Option<ScalingAdjustmentType>)`](crate::client::fluent_builders::PutScalingPolicy::set_scaling_adjustment_type): <p>The type of adjustment to make to a fleet's instance count:</p> <ul> <li> <p> <b>ChangeInCapacity</b> -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.</p> </li> <li> <p> <b>ExactCapacity</b> -- set the instance count to the scaling adjustment value.</p> </li> <li> <p> <b>PercentChangeInCapacity</b> -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down; for example, a value of "-10" scales the fleet down by 10%.</p> </li> </ul>
/// - [`threshold(f64)`](crate::client::fluent_builders::PutScalingPolicy::threshold) / [`set_threshold(f64)`](crate::client::fluent_builders::PutScalingPolicy::set_threshold): <p>Metric value used to trigger a scaling event.</p>
/// - [`comparison_operator(ComparisonOperatorType)`](crate::client::fluent_builders::PutScalingPolicy::comparison_operator) / [`set_comparison_operator(Option<ComparisonOperatorType>)`](crate::client::fluent_builders::PutScalingPolicy::set_comparison_operator): <p>Comparison operator to use when measuring the metric against the threshold value.</p>
/// - [`evaluation_periods(i32)`](crate::client::fluent_builders::PutScalingPolicy::evaluation_periods) / [`set_evaluation_periods(Option<i32>)`](crate::client::fluent_builders::PutScalingPolicy::set_evaluation_periods): <p>Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.</p>
/// - [`metric_name(MetricName)`](crate::client::fluent_builders::PutScalingPolicy::metric_name) / [`set_metric_name(Option<MetricName>)`](crate::client::fluent_builders::PutScalingPolicy::set_metric_name): <p>Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html">Monitor Amazon GameLift with Amazon CloudWatch</a>. </p> <ul> <li> <p> <b>ActivatingGameSessions</b> -- Game sessions in the process of being created.</p> </li> <li> <p> <b>ActiveGameSessions</b> -- Game sessions that are currently running.</p> </li> <li> <p> <b>ActiveInstances</b> -- Fleet instances that are currently running at least one game session.</p> </li> <li> <p> <b>AvailableGameSessions</b> -- Additional game sessions that fleet could host simultaneously, given current capacity.</p> </li> <li> <p> <b>AvailablePlayerSessions</b> -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.</p> </li> <li> <p> <b>CurrentPlayerSessions</b> -- Player slots in active game sessions that are being used by a player or are reserved for a player. </p> </li> <li> <p> <b>IdleInstances</b> -- Active instances that are currently hosting zero game sessions. </p> </li> <li> <p> <b>PercentAvailableGameSessions</b> -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.</p> </li> <li> <p> <b>PercentIdleInstances</b> -- Percentage of the total number of active instances that are hosting zero game sessions.</p> </li> <li> <p> <b>QueueDepth</b> -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.</p> </li> <li> <p> <b>WaitTime</b> -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination. </p> </li> </ul>
/// - [`policy_type(PolicyType)`](crate::client::fluent_builders::PutScalingPolicy::policy_type) / [`set_policy_type(Option<PolicyType>)`](crate::client::fluent_builders::PutScalingPolicy::set_policy_type): <p>The type of scaling policy to create. For a target-based policy, set the parameter <i>MetricName</i> to 'PercentAvailableGameSessions' and specify a <i>TargetConfiguration</i>. For a rule-based policy set the following parameters: <i>MetricName</i>, <i>ComparisonOperator</i>, <i>Threshold</i>, <i>EvaluationPeriods</i>, <i>ScalingAdjustmentType</i>, and <i>ScalingAdjustment</i>.</p>
/// - [`target_configuration(TargetConfiguration)`](crate::client::fluent_builders::PutScalingPolicy::target_configuration) / [`set_target_configuration(Option<TargetConfiguration>)`](crate::client::fluent_builders::PutScalingPolicy::set_target_configuration): <p>An object that contains settings for a target-based scaling policy.</p>
/// - On success, responds with [`PutScalingPolicyOutput`](crate::output::PutScalingPolicyOutput) with field(s):
/// - [`name(Option<String>)`](crate::output::PutScalingPolicyOutput::name): <p>A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.</p>
/// - On failure, responds with [`SdkError<PutScalingPolicyError>`](crate::error::PutScalingPolicyError)
pub fn put_scaling_policy(&self) -> fluent_builders::PutScalingPolicy {
fluent_builders::PutScalingPolicy::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`RegisterCompute`](crate::client::fluent_builders::RegisterCompute) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::RegisterCompute::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::RegisterCompute::set_fleet_id): <p>A unique identifier for the fleet to register the compute to. You can use either the fleet ID or ARN value.</p>
/// - [`compute_name(impl Into<String>)`](crate::client::fluent_builders::RegisterCompute::compute_name) / [`set_compute_name(Option<String>)`](crate::client::fluent_builders::RegisterCompute::set_compute_name): <p>A descriptive label that is associated with the compute resource registered to your fleet.</p>
/// - [`certificate_path(impl Into<String>)`](crate::client::fluent_builders::RegisterCompute::certificate_path) / [`set_certificate_path(Option<String>)`](crate::client::fluent_builders::RegisterCompute::set_certificate_path): <p>The path to the TLS certificate on your compute resource. The path and certificate are not validated by GameLift.</p>
/// - [`dns_name(impl Into<String>)`](crate::client::fluent_builders::RegisterCompute::dns_name) / [`set_dns_name(Option<String>)`](crate::client::fluent_builders::RegisterCompute::set_dns_name): <p>The DNS name of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.</p>
/// - [`ip_address(impl Into<String>)`](crate::client::fluent_builders::RegisterCompute::ip_address) / [`set_ip_address(Option<String>)`](crate::client::fluent_builders::RegisterCompute::set_ip_address): <p>The IP address of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.</p>
/// - [`location(impl Into<String>)`](crate::client::fluent_builders::RegisterCompute::location) / [`set_location(Option<String>)`](crate::client::fluent_builders::RegisterCompute::set_location): <p>The name of the custom location you added to the fleet you are registering this compute resource to.</p>
/// - On success, responds with [`RegisterComputeOutput`](crate::output::RegisterComputeOutput) with field(s):
/// - [`compute(Option<Compute>)`](crate::output::RegisterComputeOutput::compute): <p>The details of the compute resource you registered to the specified fleet.</p>
/// - On failure, responds with [`SdkError<RegisterComputeError>`](crate::error::RegisterComputeError)
pub fn register_compute(&self) -> fluent_builders::RegisterCompute {
fluent_builders::RegisterCompute::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`RegisterGameServer`](crate::client::fluent_builders::RegisterGameServer) operation.
///
/// - The fluent builder is configurable:
/// - [`game_server_group_name(impl Into<String>)`](crate::client::fluent_builders::RegisterGameServer::game_server_group_name) / [`set_game_server_group_name(Option<String>)`](crate::client::fluent_builders::RegisterGameServer::set_game_server_group_name): <p>A unique identifier for the game server group where the game server is running.</p>
/// - [`game_server_id(impl Into<String>)`](crate::client::fluent_builders::RegisterGameServer::game_server_id) / [`set_game_server_id(Option<String>)`](crate::client::fluent_builders::RegisterGameServer::set_game_server_id): <p>A custom string that uniquely identifies the game server to register. Game server IDs are developer-defined and must be unique across all game server groups in your Amazon Web Services account.</p>
/// - [`instance_id(impl Into<String>)`](crate::client::fluent_builders::RegisterGameServer::instance_id) / [`set_instance_id(Option<String>)`](crate::client::fluent_builders::RegisterGameServer::set_instance_id): <p>The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: <code>i-1234567890abcdef0</code>.</p>
/// - [`connection_info(impl Into<String>)`](crate::client::fluent_builders::RegisterGameServer::connection_info) / [`set_connection_info(Option<String>)`](crate::client::fluent_builders::RegisterGameServer::set_connection_info): <p>Information that is needed to make inbound client connections to the game server. This might include the IP address and port, DNS name, and other information.</p>
/// - [`game_server_data(impl Into<String>)`](crate::client::fluent_builders::RegisterGameServer::game_server_data) / [`set_game_server_data(Option<String>)`](crate::client::fluent_builders::RegisterGameServer::set_game_server_data): <p>A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers. </p>
/// - On success, responds with [`RegisterGameServerOutput`](crate::output::RegisterGameServerOutput) with field(s):
/// - [`game_server(Option<GameServer>)`](crate::output::RegisterGameServerOutput::game_server): <p>Object that describes the newly registered game server.</p>
/// - On failure, responds with [`SdkError<RegisterGameServerError>`](crate::error::RegisterGameServerError)
pub fn register_game_server(&self) -> fluent_builders::RegisterGameServer {
fluent_builders::RegisterGameServer::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`RequestUploadCredentials`](crate::client::fluent_builders::RequestUploadCredentials) operation.
///
/// - The fluent builder is configurable:
/// - [`build_id(impl Into<String>)`](crate::client::fluent_builders::RequestUploadCredentials::build_id) / [`set_build_id(Option<String>)`](crate::client::fluent_builders::RequestUploadCredentials::set_build_id): <p>A unique identifier for the build to get credentials for. You can use either the build ID or ARN value. </p>
/// - On success, responds with [`RequestUploadCredentialsOutput`](crate::output::RequestUploadCredentialsOutput) with field(s):
/// - [`upload_credentials(Option<AwsCredentials>)`](crate::output::RequestUploadCredentialsOutput::upload_credentials): <p>Amazon Web Services credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for.</p>
/// - [`storage_location(Option<S3Location>)`](crate::output::RequestUploadCredentialsOutput::storage_location): <p>Amazon S3 path and key, identifying where the game build files are stored.</p>
/// - On failure, responds with [`SdkError<RequestUploadCredentialsError>`](crate::error::RequestUploadCredentialsError)
pub fn request_upload_credentials(&self) -> fluent_builders::RequestUploadCredentials {
fluent_builders::RequestUploadCredentials::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ResolveAlias`](crate::client::fluent_builders::ResolveAlias) operation.
///
/// - The fluent builder is configurable:
/// - [`alias_id(impl Into<String>)`](crate::client::fluent_builders::ResolveAlias::alias_id) / [`set_alias_id(Option<String>)`](crate::client::fluent_builders::ResolveAlias::set_alias_id): <p>The unique identifier of the alias that you want to retrieve a fleet ID for. You can use either the alias ID or ARN value.</p>
/// - On success, responds with [`ResolveAliasOutput`](crate::output::ResolveAliasOutput) with field(s):
/// - [`fleet_id(Option<String>)`](crate::output::ResolveAliasOutput::fleet_id): <p>The fleet identifier that the alias is pointing to.</p>
/// - [`fleet_arn(Option<String>)`](crate::output::ResolveAliasOutput::fleet_arn): <p> The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) associated with the GameLift fleet resource that this alias points to. </p>
/// - On failure, responds with [`SdkError<ResolveAliasError>`](crate::error::ResolveAliasError)
pub fn resolve_alias(&self) -> fluent_builders::ResolveAlias {
fluent_builders::ResolveAlias::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ResumeGameServerGroup`](crate::client::fluent_builders::ResumeGameServerGroup) operation.
///
/// - The fluent builder is configurable:
/// - [`game_server_group_name(impl Into<String>)`](crate::client::fluent_builders::ResumeGameServerGroup::game_server_group_name) / [`set_game_server_group_name(Option<String>)`](crate::client::fluent_builders::ResumeGameServerGroup::set_game_server_group_name): <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
/// - [`resume_actions(Vec<GameServerGroupAction>)`](crate::client::fluent_builders::ResumeGameServerGroup::resume_actions) / [`set_resume_actions(Option<Vec<GameServerGroupAction>>)`](crate::client::fluent_builders::ResumeGameServerGroup::set_resume_actions): <p>The activity to resume for this game server group.</p>
/// - On success, responds with [`ResumeGameServerGroupOutput`](crate::output::ResumeGameServerGroupOutput) with field(s):
/// - [`game_server_group(Option<GameServerGroup>)`](crate::output::ResumeGameServerGroupOutput::game_server_group): <p>An object that describes the game server group resource, with the <code>SuspendedActions</code> property updated to reflect the resumed activity.</p>
/// - On failure, responds with [`SdkError<ResumeGameServerGroupError>`](crate::error::ResumeGameServerGroupError)
pub fn resume_game_server_group(&self) -> fluent_builders::ResumeGameServerGroup {
fluent_builders::ResumeGameServerGroup::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`SearchGameSessions`](crate::client::fluent_builders::SearchGameSessions) operation.
/// This operation supports pagination; See [`into_paginator()`](crate::client::fluent_builders::SearchGameSessions::into_paginator).
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::SearchGameSessions::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::SearchGameSessions::set_fleet_id): <p>A unique identifier for the fleet to search for active game sessions. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.</p>
/// - [`alias_id(impl Into<String>)`](crate::client::fluent_builders::SearchGameSessions::alias_id) / [`set_alias_id(Option<String>)`](crate::client::fluent_builders::SearchGameSessions::set_alias_id): <p>A unique identifier for the alias associated with the fleet to search for active game sessions. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.</p>
/// - [`location(impl Into<String>)`](crate::client::fluent_builders::SearchGameSessions::location) / [`set_location(Option<String>)`](crate::client::fluent_builders::SearchGameSessions::set_location): <p>A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>. </p>
/// - [`filter_expression(impl Into<String>)`](crate::client::fluent_builders::SearchGameSessions::filter_expression) / [`set_filter_expression(Option<String>)`](crate::client::fluent_builders::SearchGameSessions::set_filter_expression): <p>String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in <code>ACTIVE</code> status.</p> <p>A filter expression can contain one or multiple conditions. Each condition consists of the following:</p> <ul> <li> <p> <b>Operand</b> -- Name of a game session attribute. Valid values are <code>gameSessionName</code>, <code>gameSessionId</code>, <code>gameSessionProperties</code>, <code>maximumSessions</code>, <code>creationTimeMillis</code>, <code>playerSessionCount</code>, <code>hasAvailablePlayerSessions</code>.</p> </li> <li> <p> <b>Comparator</b> -- Valid comparators are: <code>=</code>, <code><></code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>. </p> </li> <li> <p> <b>Value</b> -- Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators <code>=</code> and <code><></code>. For example, the following filter expression searches on <code>gameSessionName</code>: "<code>FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'"</code>. </p> </li> </ul> <p>To chain multiple conditions in a single expression, use the logical keywords <code>AND</code>, <code>OR</code>, and <code>NOT</code> and parentheses as needed. For example: <code>x AND y AND NOT z</code>, <code>NOT (x OR y)</code>.</p> <p>Session search evaluates conditions from left to right using the following precedence rules:</p> <ol> <li> <p> <code>=</code>, <code><></code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code> </p> </li> <li> <p>Parentheses</p> </li> <li> <p>NOT</p> </li> <li> <p>AND</p> </li> <li> <p>OR</p> </li> </ol> <p>For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: <code>"maximumSessions>=10 AND hasAvailablePlayerSessions=true"</code>. </p>
/// - [`sort_expression(impl Into<String>)`](crate::client::fluent_builders::SearchGameSessions::sort_expression) / [`set_sort_expression(Option<String>)`](crate::client::fluent_builders::SearchGameSessions::set_sort_expression): <p>Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:</p> <ul> <li> <p> <b>Operand</b> -- Name of a game session attribute. Valid values are <code>gameSessionName</code>, <code>gameSessionId</code>, <code>gameSessionProperties</code>, <code>maximumSessions</code>, <code>creationTimeMillis</code>, <code>playerSessionCount</code>, <code>hasAvailablePlayerSessions</code>.</p> </li> <li> <p> <b>Order</b> -- Valid sort orders are <code>ASC</code> (ascending) and <code>DESC</code> (descending).</p> </li> </ul> <p>For example, this sort expression returns the oldest active sessions first: <code>"SortExpression": "creationTimeMillis ASC"</code>. Results with a null value for the sort operand are returned at the end of the list.</p>
/// - [`limit(i32)`](crate::client::fluent_builders::SearchGameSessions::limit) / [`set_limit(Option<i32>)`](crate::client::fluent_builders::SearchGameSessions::set_limit): <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher than 20. </p>
/// - [`next_token(impl Into<String>)`](crate::client::fluent_builders::SearchGameSessions::next_token) / [`set_next_token(Option<String>)`](crate::client::fluent_builders::SearchGameSessions::set_next_token): <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>
/// - On success, responds with [`SearchGameSessionsOutput`](crate::output::SearchGameSessionsOutput) with field(s):
/// - [`game_sessions(Option<Vec<GameSession>>)`](crate::output::SearchGameSessionsOutput::game_sessions): <p>A collection of objects containing game session properties for each session that matches the request.</p>
/// - [`next_token(Option<String>)`](crate::output::SearchGameSessionsOutput::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>
/// - On failure, responds with [`SdkError<SearchGameSessionsError>`](crate::error::SearchGameSessionsError)
pub fn search_game_sessions(&self) -> fluent_builders::SearchGameSessions {
fluent_builders::SearchGameSessions::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`StartFleetActions`](crate::client::fluent_builders::StartFleetActions) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::StartFleetActions::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::StartFleetActions::set_fleet_id): <p>A unique identifier for the fleet to restart actions on. You can use either the fleet ID or ARN value.</p>
/// - [`actions(Vec<FleetAction>)`](crate::client::fluent_builders::StartFleetActions::actions) / [`set_actions(Option<Vec<FleetAction>>)`](crate::client::fluent_builders::StartFleetActions::set_actions): <p>List of actions to restart on the fleet.</p>
/// - [`location(impl Into<String>)`](crate::client::fluent_builders::StartFleetActions::location) / [`set_location(Option<String>)`](crate::client::fluent_builders::StartFleetActions::set_location): <p>The fleet location to restart fleet actions for. Specify a location in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
/// - On success, responds with [`StartFleetActionsOutput`](crate::output::StartFleetActionsOutput) with field(s):
/// - [`fleet_id(Option<String>)`](crate::output::StartFleetActionsOutput::fleet_id): <p>A unique identifier for the fleet to restart actions on.</p>
/// - [`fleet_arn(Option<String>)`](crate::output::StartFleetActionsOutput::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 GameLift 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>
/// - On failure, responds with [`SdkError<StartFleetActionsError>`](crate::error::StartFleetActionsError)
pub fn start_fleet_actions(&self) -> fluent_builders::StartFleetActions {
fluent_builders::StartFleetActions::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`StartGameSessionPlacement`](crate::client::fluent_builders::StartGameSessionPlacement) operation.
///
/// - The fluent builder is configurable:
/// - [`placement_id(impl Into<String>)`](crate::client::fluent_builders::StartGameSessionPlacement::placement_id) / [`set_placement_id(Option<String>)`](crate::client::fluent_builders::StartGameSessionPlacement::set_placement_id): <p>A unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all Regions and cannot be reused.</p>
/// - [`game_session_queue_name(impl Into<String>)`](crate::client::fluent_builders::StartGameSessionPlacement::game_session_queue_name) / [`set_game_session_queue_name(Option<String>)`](crate::client::fluent_builders::StartGameSessionPlacement::set_game_session_queue_name): <p>Name of the queue to use to place the new game session. You can use either the queue name or ARN value. </p>
/// - [`game_properties(Vec<GameProperty>)`](crate::client::fluent_builders::StartGameSessionPlacement::game_properties) / [`set_game_properties(Option<Vec<GameProperty>>)`](crate::client::fluent_builders::StartGameSessionPlacement::set_game_properties): <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</p>
/// - [`maximum_player_session_count(i32)`](crate::client::fluent_builders::StartGameSessionPlacement::maximum_player_session_count) / [`set_maximum_player_session_count(Option<i32>)`](crate::client::fluent_builders::StartGameSessionPlacement::set_maximum_player_session_count): <p>The maximum number of players that can be connected simultaneously to the game session.</p>
/// - [`game_session_name(impl Into<String>)`](crate::client::fluent_builders::StartGameSessionPlacement::game_session_name) / [`set_game_session_name(Option<String>)`](crate::client::fluent_builders::StartGameSessionPlacement::set_game_session_name): <p>A descriptive label that is associated with a game session. Session names do not need to be unique.</p>
/// - [`player_latencies(Vec<PlayerLatency>)`](crate::client::fluent_builders::StartGameSessionPlacement::player_latencies) / [`set_player_latencies(Option<Vec<PlayerLatency>>)`](crate::client::fluent_builders::StartGameSessionPlacement::set_player_latencies): <p>A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players. </p>
/// - [`desired_player_sessions(Vec<DesiredPlayerSession>)`](crate::client::fluent_builders::StartGameSessionPlacement::desired_player_sessions) / [`set_desired_player_sessions(Option<Vec<DesiredPlayerSession>>)`](crate::client::fluent_builders::StartGameSessionPlacement::set_desired_player_sessions): <p>Set of information on each player to create a player session for.</p>
/// - [`game_session_data(impl Into<String>)`](crate::client::fluent_builders::StartGameSessionPlacement::game_session_data) / [`set_game_session_data(Option<String>)`](crate::client::fluent_builders::StartGameSessionPlacement::set_game_session_data): <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the <code>GameSession</code> object with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</p>
/// - On success, responds with [`StartGameSessionPlacementOutput`](crate::output::StartGameSessionPlacementOutput) with field(s):
/// - [`game_session_placement(Option<GameSessionPlacement>)`](crate::output::StartGameSessionPlacementOutput::game_session_placement): <p>Object that describes the newly created game session placement. This object includes all the information provided in the request, as well as start/end time stamps and placement status. </p>
/// - On failure, responds with [`SdkError<StartGameSessionPlacementError>`](crate::error::StartGameSessionPlacementError)
pub fn start_game_session_placement(&self) -> fluent_builders::StartGameSessionPlacement {
fluent_builders::StartGameSessionPlacement::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`StartMatchBackfill`](crate::client::fluent_builders::StartMatchBackfill) operation.
///
/// - The fluent builder is configurable:
/// - [`ticket_id(impl Into<String>)`](crate::client::fluent_builders::StartMatchBackfill::ticket_id) / [`set_ticket_id(Option<String>)`](crate::client::fluent_builders::StartMatchBackfill::set_ticket_id): <p>A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.</p>
/// - [`configuration_name(impl Into<String>)`](crate::client::fluent_builders::StartMatchBackfill::configuration_name) / [`set_configuration_name(Option<String>)`](crate::client::fluent_builders::StartMatchBackfill::set_configuration_name): <p>Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the <code>GameSession</code> object, <code>MatchmakerData</code> property.</p>
/// - [`game_session_arn(impl Into<String>)`](crate::client::fluent_builders::StartMatchBackfill::game_session_arn) / [`set_game_session_arn(Option<String>)`](crate::client::fluent_builders::StartMatchBackfill::set_game_session_arn): <p>A unique identifier for the game session. Use the game session ID. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed. </p>
/// - [`players(Vec<Player>)`](crate::client::fluent_builders::StartMatchBackfill::players) / [`set_players(Option<Vec<Player>>)`](crate::client::fluent_builders::StartMatchBackfill::set_players): <p>Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.</p> <p>You can include up to 199 <code>Players</code> in a <code>StartMatchBackfill</code> request.</p> <ul> <li> <p>PlayerID, PlayerAttributes, Team -- This information is maintained in the <code>GameSession</code> object, <code>MatchmakerData</code> property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data"> Match Data</a>. </p> <p>The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.</p> </li> <li> <p>LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.</p> </li> </ul>
/// - On success, responds with [`StartMatchBackfillOutput`](crate::output::StartMatchBackfillOutput) with field(s):
/// - [`matchmaking_ticket(Option<MatchmakingTicket>)`](crate::output::StartMatchBackfillOutput::matchmaking_ticket): <p>Ticket representing the backfill matchmaking request. This object includes the information in the request, ticket status, and match results as generated during the matchmaking process.</p>
/// - On failure, responds with [`SdkError<StartMatchBackfillError>`](crate::error::StartMatchBackfillError)
pub fn start_match_backfill(&self) -> fluent_builders::StartMatchBackfill {
fluent_builders::StartMatchBackfill::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`StartMatchmaking`](crate::client::fluent_builders::StartMatchmaking) operation.
///
/// - The fluent builder is configurable:
/// - [`ticket_id(impl Into<String>)`](crate::client::fluent_builders::StartMatchmaking::ticket_id) / [`set_ticket_id(Option<String>)`](crate::client::fluent_builders::StartMatchmaking::set_ticket_id): <p>A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.</p>
/// - [`configuration_name(impl Into<String>)`](crate::client::fluent_builders::StartMatchmaking::configuration_name) / [`set_configuration_name(Option<String>)`](crate::client::fluent_builders::StartMatchmaking::set_configuration_name): <p>Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same Region as this request. You can use either the configuration name or ARN value.</p>
/// - [`players(Vec<Player>)`](crate::client::fluent_builders::StartMatchmaking::players) / [`set_players(Option<Vec<Player>>)`](crate::client::fluent_builders::StartMatchmaking::set_players): <p>Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, <code>Player</code> objects contain the name of the team the player is assigned to.</p> <p>You can include up to 10 <code>Players</code> in a <code>StartMatchmaking</code> request.</p>
/// - On success, responds with [`StartMatchmakingOutput`](crate::output::StartMatchmakingOutput) with field(s):
/// - [`matchmaking_ticket(Option<MatchmakingTicket>)`](crate::output::StartMatchmakingOutput::matchmaking_ticket): <p>Ticket representing the matchmaking request. This object include the information included in the request, ticket status, and match results as generated during the matchmaking process.</p>
/// - On failure, responds with [`SdkError<StartMatchmakingError>`](crate::error::StartMatchmakingError)
pub fn start_matchmaking(&self) -> fluent_builders::StartMatchmaking {
fluent_builders::StartMatchmaking::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`StopFleetActions`](crate::client::fluent_builders::StopFleetActions) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::StopFleetActions::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::StopFleetActions::set_fleet_id): <p>A unique identifier for the fleet to stop actions on. You can use either the fleet ID or ARN value.</p>
/// - [`actions(Vec<FleetAction>)`](crate::client::fluent_builders::StopFleetActions::actions) / [`set_actions(Option<Vec<FleetAction>>)`](crate::client::fluent_builders::StopFleetActions::set_actions): <p>List of actions to suspend on the fleet. </p>
/// - [`location(impl Into<String>)`](crate::client::fluent_builders::StopFleetActions::location) / [`set_location(Option<String>)`](crate::client::fluent_builders::StopFleetActions::set_location): <p>The fleet location to stop fleet actions for. Specify a location in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
/// - On success, responds with [`StopFleetActionsOutput`](crate::output::StopFleetActionsOutput) with field(s):
/// - [`fleet_id(Option<String>)`](crate::output::StopFleetActionsOutput::fleet_id): <p>A unique identifier for the fleet to stop actions on.</p>
/// - [`fleet_arn(Option<String>)`](crate::output::StopFleetActionsOutput::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 GameLift 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>
/// - On failure, responds with [`SdkError<StopFleetActionsError>`](crate::error::StopFleetActionsError)
pub fn stop_fleet_actions(&self) -> fluent_builders::StopFleetActions {
fluent_builders::StopFleetActions::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`StopGameSessionPlacement`](crate::client::fluent_builders::StopGameSessionPlacement) operation.
///
/// - The fluent builder is configurable:
/// - [`placement_id(impl Into<String>)`](crate::client::fluent_builders::StopGameSessionPlacement::placement_id) / [`set_placement_id(Option<String>)`](crate::client::fluent_builders::StopGameSessionPlacement::set_placement_id): <p>A unique identifier for a game session placement to stop.</p>
/// - On success, responds with [`StopGameSessionPlacementOutput`](crate::output::StopGameSessionPlacementOutput) with field(s):
/// - [`game_session_placement(Option<GameSessionPlacement>)`](crate::output::StopGameSessionPlacementOutput::game_session_placement): <p>Object that describes the canceled game session placement, with <code>CANCELLED</code> status and an end time stamp. </p>
/// - On failure, responds with [`SdkError<StopGameSessionPlacementError>`](crate::error::StopGameSessionPlacementError)
pub fn stop_game_session_placement(&self) -> fluent_builders::StopGameSessionPlacement {
fluent_builders::StopGameSessionPlacement::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`StopMatchmaking`](crate::client::fluent_builders::StopMatchmaking) operation.
///
/// - The fluent builder is configurable:
/// - [`ticket_id(impl Into<String>)`](crate::client::fluent_builders::StopMatchmaking::ticket_id) / [`set_ticket_id(Option<String>)`](crate::client::fluent_builders::StopMatchmaking::set_ticket_id): <p>A unique identifier for a matchmaking ticket.</p>
/// - On success, responds with [`StopMatchmakingOutput`](crate::output::StopMatchmakingOutput)
/// - On failure, responds with [`SdkError<StopMatchmakingError>`](crate::error::StopMatchmakingError)
pub fn stop_matchmaking(&self) -> fluent_builders::StopMatchmaking {
fluent_builders::StopMatchmaking::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`SuspendGameServerGroup`](crate::client::fluent_builders::SuspendGameServerGroup) operation.
///
/// - The fluent builder is configurable:
/// - [`game_server_group_name(impl Into<String>)`](crate::client::fluent_builders::SuspendGameServerGroup::game_server_group_name) / [`set_game_server_group_name(Option<String>)`](crate::client::fluent_builders::SuspendGameServerGroup::set_game_server_group_name): <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
/// - [`suspend_actions(Vec<GameServerGroupAction>)`](crate::client::fluent_builders::SuspendGameServerGroup::suspend_actions) / [`set_suspend_actions(Option<Vec<GameServerGroupAction>>)`](crate::client::fluent_builders::SuspendGameServerGroup::set_suspend_actions): <p>The activity to suspend for this game server group.</p>
/// - On success, responds with [`SuspendGameServerGroupOutput`](crate::output::SuspendGameServerGroupOutput) with field(s):
/// - [`game_server_group(Option<GameServerGroup>)`](crate::output::SuspendGameServerGroupOutput::game_server_group): <p>An object that describes the game server group resource, with the <code>SuspendedActions</code> property updated to reflect the suspended activity.</p>
/// - On failure, responds with [`SdkError<SuspendGameServerGroupError>`](crate::error::SuspendGameServerGroupError)
pub fn suspend_game_server_group(&self) -> fluent_builders::SuspendGameServerGroup {
fluent_builders::SuspendGameServerGroup::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`TagResource`](crate::client::fluent_builders::TagResource) operation.
///
/// - The fluent builder is configurable:
/// - [`resource_arn(impl Into<String>)`](crate::client::fluent_builders::TagResource::resource_arn) / [`set_resource_arn(Option<String>)`](crate::client::fluent_builders::TagResource::set_resource_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 and uniquely identifies the GameLift resource that you want to assign tags to. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type. </p>
/// - [`tags(Vec<Tag>)`](crate::client::fluent_builders::TagResource::tags) / [`set_tags(Option<Vec<Tag>>)`](crate::client::fluent_builders::TagResource::set_tags): <p>A list of one or more tags to assign to the specified GameLift resource. Tags are developer-defined and structured as key-value pairs. The maximum tag limit may be lower than stated. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> for actual tagging limits.</p>
/// - On success, responds with [`TagResourceOutput`](crate::output::TagResourceOutput)
/// - On failure, responds with [`SdkError<TagResourceError>`](crate::error::TagResourceError)
pub fn tag_resource(&self) -> fluent_builders::TagResource {
fluent_builders::TagResource::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UntagResource`](crate::client::fluent_builders::UntagResource) operation.
///
/// - The fluent builder is configurable:
/// - [`resource_arn(impl Into<String>)`](crate::client::fluent_builders::UntagResource::resource_arn) / [`set_resource_arn(Option<String>)`](crate::client::fluent_builders::UntagResource::set_resource_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 and uniquely identifies the GameLift resource that you want to remove tags from. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type. </p>
/// - [`tag_keys(Vec<String>)`](crate::client::fluent_builders::UntagResource::tag_keys) / [`set_tag_keys(Option<Vec<String>>)`](crate::client::fluent_builders::UntagResource::set_tag_keys): <p>A list of one or more tag keys to remove from the specified GameLift resource. An Amazon Web Services resource can have only one tag with a specific tag key, so specifying the tag key identifies which tag to remove. </p>
/// - On success, responds with [`UntagResourceOutput`](crate::output::UntagResourceOutput)
/// - On failure, responds with [`SdkError<UntagResourceError>`](crate::error::UntagResourceError)
pub fn untag_resource(&self) -> fluent_builders::UntagResource {
fluent_builders::UntagResource::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateAlias`](crate::client::fluent_builders::UpdateAlias) operation.
///
/// - The fluent builder is configurable:
/// - [`alias_id(impl Into<String>)`](crate::client::fluent_builders::UpdateAlias::alias_id) / [`set_alias_id(Option<String>)`](crate::client::fluent_builders::UpdateAlias::set_alias_id): <p>A unique identifier for the alias that you want to update. You can use either the alias ID or ARN value.</p>
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::UpdateAlias::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::UpdateAlias::set_name): <p>A descriptive label that is associated with an alias. Alias names do not need to be unique.</p>
/// - [`description(impl Into<String>)`](crate::client::fluent_builders::UpdateAlias::description) / [`set_description(Option<String>)`](crate::client::fluent_builders::UpdateAlias::set_description): <p>A human-readable description of the alias.</p>
/// - [`routing_strategy(RoutingStrategy)`](crate::client::fluent_builders::UpdateAlias::routing_strategy) / [`set_routing_strategy(Option<RoutingStrategy>)`](crate::client::fluent_builders::UpdateAlias::set_routing_strategy): <p>The routing configuration, including routing type and fleet target, for the alias.</p>
/// - On success, responds with [`UpdateAliasOutput`](crate::output::UpdateAliasOutput) with field(s):
/// - [`alias(Option<Alias>)`](crate::output::UpdateAliasOutput::alias): <p>The updated alias resource.</p>
/// - On failure, responds with [`SdkError<UpdateAliasError>`](crate::error::UpdateAliasError)
pub fn update_alias(&self) -> fluent_builders::UpdateAlias {
fluent_builders::UpdateAlias::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateBuild`](crate::client::fluent_builders::UpdateBuild) operation.
///
/// - The fluent builder is configurable:
/// - [`build_id(impl Into<String>)`](crate::client::fluent_builders::UpdateBuild::build_id) / [`set_build_id(Option<String>)`](crate::client::fluent_builders::UpdateBuild::set_build_id): <p>A unique identifier for the build to update. You can use either the build ID or ARN value. </p>
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::UpdateBuild::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::UpdateBuild::set_name): <p>A descriptive label associated with a build. Build names do not need to be unique. </p>
/// - [`version(impl Into<String>)`](crate::client::fluent_builders::UpdateBuild::version) / [`set_version(Option<String>)`](crate::client::fluent_builders::UpdateBuild::set_version): <p>Version information associated with a build or script. Version strings do not need to be unique.</p>
/// - On success, responds with [`UpdateBuildOutput`](crate::output::UpdateBuildOutput) with field(s):
/// - [`build_value(Option<Build>)`](crate::output::UpdateBuildOutput::build_value): <p>The updated build resource.</p>
/// - On failure, responds with [`SdkError<UpdateBuildError>`](crate::error::UpdateBuildError)
pub fn update_build(&self) -> fluent_builders::UpdateBuild {
fluent_builders::UpdateBuild::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateFleetAttributes`](crate::client::fluent_builders::UpdateFleetAttributes) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::UpdateFleetAttributes::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::UpdateFleetAttributes::set_fleet_id): <p>A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.</p>
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::UpdateFleetAttributes::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::UpdateFleetAttributes::set_name): <p>A descriptive label that is associated with a fleet. Fleet names do not need to be unique.</p>
/// - [`description(impl Into<String>)`](crate::client::fluent_builders::UpdateFleetAttributes::description) / [`set_description(Option<String>)`](crate::client::fluent_builders::UpdateFleetAttributes::set_description): <p>A human-readable description of a fleet.</p>
/// - [`new_game_session_protection_policy(ProtectionPolicy)`](crate::client::fluent_builders::UpdateFleetAttributes::new_game_session_protection_policy) / [`set_new_game_session_protection_policy(Option<ProtectionPolicy>)`](crate::client::fluent_builders::UpdateFleetAttributes::set_new_game_session_protection_policy): <p>The game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a> .</p> <ul> <li> <p> <b>NoProtection</b> -- The game session can be terminated during a scale-down event.</p> </li> <li> <p> <b>FullProtection</b> -- If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</p> </li> </ul>
/// - [`resource_creation_limit_policy(ResourceCreationLimitPolicy)`](crate::client::fluent_builders::UpdateFleetAttributes::resource_creation_limit_policy) / [`set_resource_creation_limit_policy(Option<ResourceCreationLimitPolicy>)`](crate::client::fluent_builders::UpdateFleetAttributes::set_resource_creation_limit_policy): <p>Policy settings that limit the number of game sessions an individual player can create over a span of time. </p>
/// - [`metric_groups(Vec<String>)`](crate::client::fluent_builders::UpdateFleetAttributes::metric_groups) / [`set_metric_groups(Option<Vec<String>>)`](crate::client::fluent_builders::UpdateFleetAttributes::set_metric_groups): <p>The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.</p>
/// - [`anywhere_configuration(AnywhereConfiguration)`](crate::client::fluent_builders::UpdateFleetAttributes::anywhere_configuration) / [`set_anywhere_configuration(Option<AnywhereConfiguration>)`](crate::client::fluent_builders::UpdateFleetAttributes::set_anywhere_configuration): <p>GameLift Anywhere configuration options.</p>
/// - On success, responds with [`UpdateFleetAttributesOutput`](crate::output::UpdateFleetAttributesOutput) with field(s):
/// - [`fleet_id(Option<String>)`](crate::output::UpdateFleetAttributesOutput::fleet_id): <p>A unique identifier for the fleet that was updated.</p>
/// - [`fleet_arn(Option<String>)`](crate::output::UpdateFleetAttributesOutput::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 GameLift 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>
/// - On failure, responds with [`SdkError<UpdateFleetAttributesError>`](crate::error::UpdateFleetAttributesError)
pub fn update_fleet_attributes(&self) -> fluent_builders::UpdateFleetAttributes {
fluent_builders::UpdateFleetAttributes::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateFleetCapacity`](crate::client::fluent_builders::UpdateFleetCapacity) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::UpdateFleetCapacity::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::UpdateFleetCapacity::set_fleet_id): <p>A unique identifier for the fleet to update capacity settings for. You can use either the fleet ID or ARN value.</p>
/// - [`desired_instances(i32)`](crate::client::fluent_builders::UpdateFleetCapacity::desired_instances) / [`set_desired_instances(Option<i32>)`](crate::client::fluent_builders::UpdateFleetCapacity::set_desired_instances): <p>The number of Amazon EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.</p>
/// - [`min_size(i32)`](crate::client::fluent_builders::UpdateFleetCapacity::min_size) / [`set_min_size(Option<i32>)`](crate::client::fluent_builders::UpdateFleetCapacity::set_min_size): <p>The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.</p>
/// - [`max_size(i32)`](crate::client::fluent_builders::UpdateFleetCapacity::max_size) / [`set_max_size(Option<i32>)`](crate::client::fluent_builders::UpdateFleetCapacity::set_max_size): <p>The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.</p>
/// - [`location(impl Into<String>)`](crate::client::fluent_builders::UpdateFleetCapacity::location) / [`set_location(Option<String>)`](crate::client::fluent_builders::UpdateFleetCapacity::set_location): <p>The name of a remote location to update fleet capacity settings for, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>.</p>
/// - On success, responds with [`UpdateFleetCapacityOutput`](crate::output::UpdateFleetCapacityOutput) with field(s):
/// - [`fleet_id(Option<String>)`](crate::output::UpdateFleetCapacityOutput::fleet_id): <p>A unique identifier for the fleet that was updated.</p>
/// - [`fleet_arn(Option<String>)`](crate::output::UpdateFleetCapacityOutput::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 GameLift 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>
/// - [`location(Option<String>)`](crate::output::UpdateFleetCapacityOutput::location): <p>The remote location being updated, expressed as an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
/// - On failure, responds with [`SdkError<UpdateFleetCapacityError>`](crate::error::UpdateFleetCapacityError)
pub fn update_fleet_capacity(&self) -> fluent_builders::UpdateFleetCapacity {
fluent_builders::UpdateFleetCapacity::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateFleetPortSettings`](crate::client::fluent_builders::UpdateFleetPortSettings) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::UpdateFleetPortSettings::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::UpdateFleetPortSettings::set_fleet_id): <p>A unique identifier for the fleet to update port settings for. You can use either the fleet ID or ARN value.</p>
/// - [`inbound_permission_authorizations(Vec<IpPermission>)`](crate::client::fluent_builders::UpdateFleetPortSettings::inbound_permission_authorizations) / [`set_inbound_permission_authorizations(Option<Vec<IpPermission>>)`](crate::client::fluent_builders::UpdateFleetPortSettings::set_inbound_permission_authorizations): <p>A collection of port settings to be added to the fleet resource.</p>
/// - [`inbound_permission_revocations(Vec<IpPermission>)`](crate::client::fluent_builders::UpdateFleetPortSettings::inbound_permission_revocations) / [`set_inbound_permission_revocations(Option<Vec<IpPermission>>)`](crate::client::fluent_builders::UpdateFleetPortSettings::set_inbound_permission_revocations): <p>A collection of port settings to be removed from the fleet resource.</p>
/// - On success, responds with [`UpdateFleetPortSettingsOutput`](crate::output::UpdateFleetPortSettingsOutput) with field(s):
/// - [`fleet_id(Option<String>)`](crate::output::UpdateFleetPortSettingsOutput::fleet_id): <p>A unique identifier for the fleet that was updated.</p>
/// - [`fleet_arn(Option<String>)`](crate::output::UpdateFleetPortSettingsOutput::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 GameLift 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>
/// - On failure, responds with [`SdkError<UpdateFleetPortSettingsError>`](crate::error::UpdateFleetPortSettingsError)
pub fn update_fleet_port_settings(&self) -> fluent_builders::UpdateFleetPortSettings {
fluent_builders::UpdateFleetPortSettings::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateGameServer`](crate::client::fluent_builders::UpdateGameServer) operation.
///
/// - The fluent builder is configurable:
/// - [`game_server_group_name(impl Into<String>)`](crate::client::fluent_builders::UpdateGameServer::game_server_group_name) / [`set_game_server_group_name(Option<String>)`](crate::client::fluent_builders::UpdateGameServer::set_game_server_group_name): <p>A unique identifier for the game server group where the game server is running.</p>
/// - [`game_server_id(impl Into<String>)`](crate::client::fluent_builders::UpdateGameServer::game_server_id) / [`set_game_server_id(Option<String>)`](crate::client::fluent_builders::UpdateGameServer::set_game_server_id): <p>A custom string that uniquely identifies the game server to update.</p>
/// - [`game_server_data(impl Into<String>)`](crate::client::fluent_builders::UpdateGameServer::game_server_data) / [`set_game_server_data(Option<String>)`](crate::client::fluent_builders::UpdateGameServer::set_game_server_data): <p>A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers. </p>
/// - [`utilization_status(GameServerUtilizationStatus)`](crate::client::fluent_builders::UpdateGameServer::utilization_status) / [`set_utilization_status(Option<GameServerUtilizationStatus>)`](crate::client::fluent_builders::UpdateGameServer::set_utilization_status): <p>Indicates whether the game server is available or is currently hosting gameplay.</p>
/// - [`health_check(GameServerHealthCheck)`](crate::client::fluent_builders::UpdateGameServer::health_check) / [`set_health_check(Option<GameServerHealthCheck>)`](crate::client::fluent_builders::UpdateGameServer::set_health_check): <p>Indicates health status of the game server. A request that includes this parameter updates the game server's <i>LastHealthCheckTime</i> timestamp. </p>
/// - On success, responds with [`UpdateGameServerOutput`](crate::output::UpdateGameServerOutput) with field(s):
/// - [`game_server(Option<GameServer>)`](crate::output::UpdateGameServerOutput::game_server): <p>Object that describes the newly updated game server.</p>
/// - On failure, responds with [`SdkError<UpdateGameServerError>`](crate::error::UpdateGameServerError)
pub fn update_game_server(&self) -> fluent_builders::UpdateGameServer {
fluent_builders::UpdateGameServer::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateGameServerGroup`](crate::client::fluent_builders::UpdateGameServerGroup) operation.
///
/// - The fluent builder is configurable:
/// - [`game_server_group_name(impl Into<String>)`](crate::client::fluent_builders::UpdateGameServerGroup::game_server_group_name) / [`set_game_server_group_name(Option<String>)`](crate::client::fluent_builders::UpdateGameServerGroup::set_game_server_group_name): <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
/// - [`role_arn(impl Into<String>)`](crate::client::fluent_builders::UpdateGameServerGroup::role_arn) / [`set_role_arn(Option<String>)`](crate::client::fluent_builders::UpdateGameServerGroup::set_role_arn): <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.</p>
/// - [`instance_definitions(Vec<InstanceDefinition>)`](crate::client::fluent_builders::UpdateGameServerGroup::instance_definitions) / [`set_instance_definitions(Option<Vec<InstanceDefinition>>)`](crate::client::fluent_builders::UpdateGameServerGroup::set_instance_definitions): <p>An updated list of Amazon EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">EC2 Instance Types</a> in the <i>Amazon EC2 User Guide</i>. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html"> Instance Weighting for Amazon EC2 Auto Scaling</a> in the Amazon EC2 Auto Scaling User Guide.</p>
/// - [`game_server_protection_policy(GameServerProtectionPolicy)`](crate::client::fluent_builders::UpdateGameServerGroup::game_server_protection_policy) / [`set_game_server_protection_policy(Option<GameServerProtectionPolicy>)`](crate::client::fluent_builders::UpdateGameServerGroup::set_game_server_protection_policy): <p>A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by Amazon Web Services regardless of protection status. This property is set to <code>NO_PROTECTION</code> by default.</p>
/// - [`balancing_strategy(BalancingStrategy)`](crate::client::fluent_builders::UpdateGameServerGroup::balancing_strategy) / [`set_balancing_strategy(Option<BalancingStrategy>)`](crate::client::fluent_builders::UpdateGameServerGroup::set_balancing_strategy): <p>Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:</p> <ul> <li> <p> <code>SPOT_ONLY</code> - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.</p> </li> <li> <p> <code>SPOT_PREFERRED</code> - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.</p> </li> <li> <p> <code>ON_DEMAND_ONLY</code> - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.</p> </li> </ul>
/// - On success, responds with [`UpdateGameServerGroupOutput`](crate::output::UpdateGameServerGroupOutput) with field(s):
/// - [`game_server_group(Option<GameServerGroup>)`](crate::output::UpdateGameServerGroupOutput::game_server_group): <p>An object that describes the game server group resource with updated properties. </p>
/// - On failure, responds with [`SdkError<UpdateGameServerGroupError>`](crate::error::UpdateGameServerGroupError)
pub fn update_game_server_group(&self) -> fluent_builders::UpdateGameServerGroup {
fluent_builders::UpdateGameServerGroup::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateGameSession`](crate::client::fluent_builders::UpdateGameSession) operation.
///
/// - The fluent builder is configurable:
/// - [`game_session_id(impl Into<String>)`](crate::client::fluent_builders::UpdateGameSession::game_session_id) / [`set_game_session_id(Option<String>)`](crate::client::fluent_builders::UpdateGameSession::set_game_session_id): <p>A unique identifier for the game session to update. </p>
/// - [`maximum_player_session_count(i32)`](crate::client::fluent_builders::UpdateGameSession::maximum_player_session_count) / [`set_maximum_player_session_count(Option<i32>)`](crate::client::fluent_builders::UpdateGameSession::set_maximum_player_session_count): <p>The maximum number of players that can be connected simultaneously to the game session.</p>
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::UpdateGameSession::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::UpdateGameSession::set_name): <p>A descriptive label that is associated with a game session. Session names do not need to be unique.</p>
/// - [`player_session_creation_policy(PlayerSessionCreationPolicy)`](crate::client::fluent_builders::UpdateGameSession::player_session_creation_policy) / [`set_player_session_creation_policy(Option<PlayerSessionCreationPolicy>)`](crate::client::fluent_builders::UpdateGameSession::set_player_session_creation_policy): <p>A policy that determines whether the game session is accepting new players.</p>
/// - [`protection_policy(ProtectionPolicy)`](crate::client::fluent_builders::UpdateGameSession::protection_policy) / [`set_protection_policy(Option<ProtectionPolicy>)`](crate::client::fluent_builders::UpdateGameSession::set_protection_policy): <p>Game session protection policy to apply to this game session only.</p> <ul> <li> <p> <b>NoProtection</b> -- The game session can be terminated during a scale-down event.</p> </li> <li> <p> <b>FullProtection</b> -- If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</p> </li> </ul>
/// - On success, responds with [`UpdateGameSessionOutput`](crate::output::UpdateGameSessionOutput) with field(s):
/// - [`game_session(Option<GameSession>)`](crate::output::UpdateGameSessionOutput::game_session): <p>The updated game session properties.</p>
/// - On failure, responds with [`SdkError<UpdateGameSessionError>`](crate::error::UpdateGameSessionError)
pub fn update_game_session(&self) -> fluent_builders::UpdateGameSession {
fluent_builders::UpdateGameSession::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateGameSessionQueue`](crate::client::fluent_builders::UpdateGameSessionQueue) operation.
///
/// - The fluent builder is configurable:
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::UpdateGameSessionQueue::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::UpdateGameSessionQueue::set_name): <p>A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value. </p>
/// - [`timeout_in_seconds(i32)`](crate::client::fluent_builders::UpdateGameSessionQueue::timeout_in_seconds) / [`set_timeout_in_seconds(Option<i32>)`](crate::client::fluent_builders::UpdateGameSessionQueue::set_timeout_in_seconds): <p>The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a <code>TIMED_OUT</code> status.</p>
/// - [`player_latency_policies(Vec<PlayerLatencyPolicy>)`](crate::client::fluent_builders::UpdateGameSessionQueue::player_latency_policies) / [`set_player_latency_policies(Option<Vec<PlayerLatencyPolicy>>)`](crate::client::fluent_builders::UpdateGameSessionQueue::set_player_latency_policies): <p>A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.</p>
/// - [`destinations(Vec<GameSessionQueueDestination>)`](crate::client::fluent_builders::UpdateGameSessionQueue::destinations) / [`set_destinations(Option<Vec<GameSessionQueueDestination>>)`](crate::client::fluent_builders::UpdateGameSessionQueue::set_destinations): <p>A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. When updating this list, provide a complete list of destinations.</p>
/// - [`filter_configuration(FilterConfiguration)`](crate::client::fluent_builders::UpdateGameSessionQueue::filter_configuration) / [`set_filter_configuration(Option<FilterConfiguration>)`](crate::client::fluent_builders::UpdateGameSessionQueue::set_filter_configuration): <p>A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as <code>us-west-2</code>. If this parameter is not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.</p>
/// - [`priority_configuration(PriorityConfiguration)`](crate::client::fluent_builders::UpdateGameSessionQueue::priority_configuration) / [`set_priority_configuration(Option<PriorityConfiguration>)`](crate::client::fluent_builders::UpdateGameSessionQueue::set_priority_configuration): <p>Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. To remove an existing priority configuration, pass in an empty set.</p>
/// - [`custom_event_data(impl Into<String>)`](crate::client::fluent_builders::UpdateGameSessionQueue::custom_event_data) / [`set_custom_event_data(Option<String>)`](crate::client::fluent_builders::UpdateGameSessionQueue::set_custom_event_data): <p>Information to be added to all events that are related to this game session queue.</p>
/// - [`notification_target(impl Into<String>)`](crate::client::fluent_builders::UpdateGameSessionQueue::notification_target) / [`set_notification_target(Option<String>)`](crate::client::fluent_builders::UpdateGameSessionQueue::set_notification_target): <p>An SNS topic ARN that is set up to receive game session placement notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html"> Setting up notifications for game session placement</a>.</p>
/// - On success, responds with [`UpdateGameSessionQueueOutput`](crate::output::UpdateGameSessionQueueOutput) with field(s):
/// - [`game_session_queue(Option<GameSessionQueue>)`](crate::output::UpdateGameSessionQueueOutput::game_session_queue): <p>An object that describes the newly updated game session queue.</p>
/// - On failure, responds with [`SdkError<UpdateGameSessionQueueError>`](crate::error::UpdateGameSessionQueueError)
pub fn update_game_session_queue(&self) -> fluent_builders::UpdateGameSessionQueue {
fluent_builders::UpdateGameSessionQueue::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateMatchmakingConfiguration`](crate::client::fluent_builders::UpdateMatchmakingConfiguration) operation.
///
/// - The fluent builder is configurable:
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::set_name): <p>A unique identifier for the matchmaking configuration to update. You can use either the configuration name or ARN value. </p>
/// - [`description(impl Into<String>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::description) / [`set_description(Option<String>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::set_description): <p>A description for the matchmaking configuration.</p>
/// - [`game_session_queue_arns(Vec<String>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::game_session_queue_arns) / [`set_game_session_queue_arns(Option<Vec<String>>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::set_game_session_queue_arns): <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 GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift: <region> ::gamesessionqueue/ <queue name></queue> </region></code>. Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If <code>FlexMatchMode</code> is set to <code>STANDALONE</code>, do not set this parameter.</p>
/// - [`request_timeout_seconds(i32)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::request_timeout_seconds) / [`set_request_timeout_seconds(Option<i32>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::set_request_timeout_seconds): <p>The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.</p>
/// - [`acceptance_timeout_seconds(i32)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::acceptance_timeout_seconds) / [`set_acceptance_timeout_seconds(Option<i32>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::set_acceptance_timeout_seconds): <p>The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.</p>
/// - [`acceptance_required(bool)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::acceptance_required) / [`set_acceptance_required(Option<bool>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::set_acceptance_required): <p>A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. With this option enabled, matchmaking tickets use the status <code>REQUIRES_ACCEPTANCE</code> to indicate when a completed potential match is waiting for player acceptance. </p>
/// - [`rule_set_name(impl Into<String>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::rule_set_name) / [`set_rule_set_name(Option<String>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::set_rule_set_name): <p>A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.</p>
/// - [`notification_target(impl Into<String>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::notification_target) / [`set_notification_target(Option<String>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::set_notification_target): <p>An SNS topic ARN that is set up to receive matchmaking notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Setting up notifications for matchmaking</a> for more information.</p>
/// - [`additional_player_count(i32)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::additional_player_count) / [`set_additional_player_count(Option<i32>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::set_additional_player_count): <p>The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
/// - [`custom_event_data(impl Into<String>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::custom_event_data) / [`set_custom_event_data(Option<String>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::set_custom_event_data): <p>Information to add to all events related to the matchmaking configuration. </p>
/// - [`game_properties(Vec<GameProperty>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::game_properties) / [`set_game_properties(Option<Vec<GameProperty>>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::set_game_properties): <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the new <code>GameSession</code> object that is created for a successful match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
/// - [`game_session_data(impl Into<String>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::game_session_data) / [`set_game_session_data(Option<String>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::set_game_session_data): <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the game session that is created for a successful match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
/// - [`backfill_mode(BackfillMode)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::backfill_mode) / [`set_backfill_mode(Option<BackfillMode>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::set_backfill_mode): <p>The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html">Backfill Existing Games with FlexMatch</a>. Automatic backfill is not available when <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
/// - [`flex_match_mode(FlexMatchMode)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::flex_match_mode) / [`set_flex_match_mode(Option<FlexMatchMode>)`](crate::client::fluent_builders::UpdateMatchmakingConfiguration::set_flex_match_mode): <p>Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution. </p> <ul> <li> <p> <b>STANDALONE</b> - FlexMatch forms matches and returns match information, including players and team assignments, in a <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded"> MatchmakingSucceeded</a> event.</p> </li> <li> <p> <b>WITH_QUEUE</b> - FlexMatch forms matches and uses the specified GameLift queue to start a game session for the match. </p> </li> </ul>
/// - On success, responds with [`UpdateMatchmakingConfigurationOutput`](crate::output::UpdateMatchmakingConfigurationOutput) with field(s):
/// - [`configuration(Option<MatchmakingConfiguration>)`](crate::output::UpdateMatchmakingConfigurationOutput::configuration): <p>The updated matchmaking configuration.</p>
/// - On failure, responds with [`SdkError<UpdateMatchmakingConfigurationError>`](crate::error::UpdateMatchmakingConfigurationError)
pub fn update_matchmaking_configuration(
&self,
) -> fluent_builders::UpdateMatchmakingConfiguration {
fluent_builders::UpdateMatchmakingConfiguration::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateRuntimeConfiguration`](crate::client::fluent_builders::UpdateRuntimeConfiguration) operation.
///
/// - The fluent builder is configurable:
/// - [`fleet_id(impl Into<String>)`](crate::client::fluent_builders::UpdateRuntimeConfiguration::fleet_id) / [`set_fleet_id(Option<String>)`](crate::client::fluent_builders::UpdateRuntimeConfiguration::set_fleet_id): <p>A unique identifier for the fleet to update runtime configuration for. You can use either the fleet ID or ARN value.</p>
/// - [`runtime_configuration(RuntimeConfiguration)`](crate::client::fluent_builders::UpdateRuntimeConfiguration::runtime_configuration) / [`set_runtime_configuration(Option<RuntimeConfiguration>)`](crate::client::fluent_builders::UpdateRuntimeConfiguration::set_runtime_configuration): <p>Instructions for alaunching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime Servers script. The runtime configuration lists the types of server processes to run on an instance, how to launch them, and the number of processes to run concurrently.</p>
/// - On success, responds with [`UpdateRuntimeConfigurationOutput`](crate::output::UpdateRuntimeConfigurationOutput) with field(s):
/// - [`runtime_configuration(Option<RuntimeConfiguration>)`](crate::output::UpdateRuntimeConfigurationOutput::runtime_configuration): <p>The runtime configuration currently in use by all instances in the fleet. If the update was successful, all property changes are shown. </p>
/// - On failure, responds with [`SdkError<UpdateRuntimeConfigurationError>`](crate::error::UpdateRuntimeConfigurationError)
pub fn update_runtime_configuration(&self) -> fluent_builders::UpdateRuntimeConfiguration {
fluent_builders::UpdateRuntimeConfiguration::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`UpdateScript`](crate::client::fluent_builders::UpdateScript) operation.
///
/// - The fluent builder is configurable:
/// - [`script_id(impl Into<String>)`](crate::client::fluent_builders::UpdateScript::script_id) / [`set_script_id(Option<String>)`](crate::client::fluent_builders::UpdateScript::set_script_id): <p>A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.</p>
/// - [`name(impl Into<String>)`](crate::client::fluent_builders::UpdateScript::name) / [`set_name(Option<String>)`](crate::client::fluent_builders::UpdateScript::set_name): <p>A descriptive label that is associated with a script. Script names do not need to be unique.</p>
/// - [`version(impl Into<String>)`](crate::client::fluent_builders::UpdateScript::version) / [`set_version(Option<String>)`](crate::client::fluent_builders::UpdateScript::set_version): <p>Version information associated with a build or script. Version strings do not need to be unique.</p>
/// - [`storage_location(S3Location)`](crate::client::fluent_builders::UpdateScript::storage_location) / [`set_storage_location(Option<S3Location>)`](crate::client::fluent_builders::UpdateScript::set_storage_location): <p>The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the <code>ObjectVersion</code> parameter to specify an earlier version. </p>
/// - [`zip_file(Blob)`](crate::client::fluent_builders::UpdateScript::zip_file) / [`set_zip_file(Option<Blob>)`](crate::client::fluent_builders::UpdateScript::set_zip_file): <p>A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.</p> <p>When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: <code>--zip-file fileb://myRealtimeScript.zip</code>.</p>
/// - On success, responds with [`UpdateScriptOutput`](crate::output::UpdateScriptOutput) with field(s):
/// - [`script(Option<Script>)`](crate::output::UpdateScriptOutput::script): <p>The newly created script record with a unique script ID. The new script's storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket under your account, the storage location reflects the information that was provided in the <i>CreateScript</i> request; (2) If the script file was uploaded from a local zip file, the storage location reflects an S3 location controls by the Amazon GameLift service.</p>
/// - On failure, responds with [`SdkError<UpdateScriptError>`](crate::error::UpdateScriptError)
pub fn update_script(&self) -> fluent_builders::UpdateScript {
fluent_builders::UpdateScript::new(self.handle.clone())
}
/// Constructs a fluent builder for the [`ValidateMatchmakingRuleSet`](crate::client::fluent_builders::ValidateMatchmakingRuleSet) operation.
///
/// - The fluent builder is configurable:
/// - [`rule_set_body(impl Into<String>)`](crate::client::fluent_builders::ValidateMatchmakingRuleSet::rule_set_body) / [`set_rule_set_body(Option<String>)`](crate::client::fluent_builders::ValidateMatchmakingRuleSet::set_rule_set_body): <p>A collection of matchmaking rules to validate, formatted as a JSON string.</p>
/// - On success, responds with [`ValidateMatchmakingRuleSetOutput`](crate::output::ValidateMatchmakingRuleSetOutput) with field(s):
/// - [`valid(Option<bool>)`](crate::output::ValidateMatchmakingRuleSetOutput::valid): <p>A response indicating whether the rule set is valid.</p>
/// - On failure, responds with [`SdkError<ValidateMatchmakingRuleSetError>`](crate::error::ValidateMatchmakingRuleSetError)
pub fn validate_matchmaking_rule_set(&self) -> fluent_builders::ValidateMatchmakingRuleSet {
fluent_builders::ValidateMatchmakingRuleSet::new(self.handle.clone())
}
}
pub mod fluent_builders {
//! Utilities to ergonomically construct a request to the service.
//!
//! Fluent builders are created through the [`Client`](crate::client::Client) by calling
//! one if its operation methods. After parameters are set using the builder methods,
//! the `send` method can be called to initiate the request.
/// Fluent builder constructing a request to `AcceptMatch`.
///
/// <p>Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit. </p>
/// <p>When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status <code>REQUIRES_ACCEPTANCE</code>. This is a trigger for your game to get acceptance from all players in the ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an error.</p>
/// <p>To register acceptance, specify the ticket ID, a response, and one or more players. Once all players have registered acceptance, the matchmaking tickets advance to status <code>PLACING</code>, where a new game session is created for the match. </p>
/// <p>If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. The matchmaking tickets are then handled in one of two ways: For tickets where one or more players rejected the match or failed to respond, the ticket status is set to <code>CANCELLED</code>, and processing is terminated. For tickets where players have accepted or not yet responded, the ticket status is returned to <code>SEARCHING</code> to find a new match. A new matchmaking request for these players can be submitted as needed. </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html"> Add FlexMatch to a game client</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html"> FlexMatch events</a> (reference)</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct AcceptMatch {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::accept_match_input::Builder,
}
impl AcceptMatch {
/// Creates a new `AcceptMatch`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::AcceptMatch,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::AcceptMatchError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::AcceptMatchOutput,
aws_smithy_http::result::SdkError<crate::error::AcceptMatchError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for a matchmaking ticket. The ticket must be in status <code>REQUIRES_ACCEPTANCE</code>; otherwise this request will fail.</p>
pub fn ticket_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.ticket_id(input.into());
self
}
/// <p>A unique identifier for a matchmaking ticket. The ticket must be in status <code>REQUIRES_ACCEPTANCE</code>; otherwise this request will fail.</p>
pub fn set_ticket_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_ticket_id(input);
self
}
/// Appends an item to `PlayerIds`.
///
/// To override the contents of this collection use [`set_player_ids`](Self::set_player_ids).
///
/// <p>A unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.</p>
pub fn player_ids(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.player_ids(input.into());
self
}
/// <p>A unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.</p>
pub fn set_player_ids(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_player_ids(input);
self
}
/// <p>Player response to the proposed match.</p>
pub fn acceptance_type(mut self, input: crate::model::AcceptanceType) -> Self {
self.inner = self.inner.acceptance_type(input);
self
}
/// <p>Player response to the proposed match.</p>
pub fn set_acceptance_type(
mut self,
input: std::option::Option<crate::model::AcceptanceType>,
) -> Self {
self.inner = self.inner.set_acceptance_type(input);
self
}
}
/// Fluent builder constructing a request to `ClaimGameServer`.
///
/// <p> <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b> </p>
/// <p>Locates an available game server and temporarily reserves it to host gameplay and players. This operation is called from a game client or client service (such as a matchmaker) to request hosting resources for a new game session. In response, GameLift FleetIQ locates an available game server, places it in <code>CLAIMED</code> status for 60 seconds, and returns connection information that players can use to connect to the game server. </p>
/// <p>To claim a game server, identify a game server group. You can also specify a game server ID, although this approach bypasses GameLift FleetIQ placement optimization. Optionally, include game data to pass to the game server at the start of a game session, such as a game map or player information. </p>
/// <p>When a game server is successfully claimed, connection information is returned. A claimed game server's utilization status remains <code>AVAILABLE</code> while the claim status is set to <code>CLAIMED</code> for up to 60 seconds. This time period gives the game server time to update its status to <code>UTILIZED</code> after players join. If the game server's status is not updated within 60 seconds, the game server reverts to unclaimed status and is available to be claimed by another request. The claim time period is a fixed value and is not configurable.</p>
/// <p>If you try to claim a specific game server, this request will fail in the following cases:</p>
/// <ul>
/// <li> <p>If the game server utilization status is <code>UTILIZED</code>.</p> </li>
/// <li> <p>If the game server claim status is <code>CLAIMED</code>.</p> </li>
/// </ul> <note>
/// <p>When claiming a specific game server, this request will succeed even if the game server is running on an instance in <code>DRAINING</code> status. To avoid this, first check the instance status by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameServerInstances.html">DescribeGameServerInstances</a> .</p>
/// </note>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ Guide</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ClaimGameServer {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::claim_game_server_input::Builder,
}
impl ClaimGameServer {
/// Creates a new `ClaimGameServer`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ClaimGameServer,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ClaimGameServerError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ClaimGameServerOutput,
aws_smithy_http::result::SdkError<crate::error::ClaimGameServerError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want GameLift FleetIQ to look for an available game server to claim. </p>
pub fn game_server_group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_group_name(input.into());
self
}
/// <p>A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want GameLift FleetIQ to look for an available game server to claim. </p>
pub fn set_game_server_group_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_group_name(input);
self
}
/// <p>A custom string that uniquely identifies the game server to claim. If this parameter is left empty, GameLift FleetIQ searches for an available game server in the specified game server group.</p>
pub fn game_server_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_id(input.into());
self
}
/// <p>A custom string that uniquely identifies the game server to claim. If this parameter is left empty, GameLift FleetIQ searches for an available game server in the specified game server group.</p>
pub fn set_game_server_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_id(input);
self
}
/// <p>A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers. </p>
pub fn game_server_data(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_data(input.into());
self
}
/// <p>A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers. </p>
pub fn set_game_server_data(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_data(input);
self
}
}
/// Fluent builder constructing a request to `CreateAlias`.
///
/// <p>Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. An alias provides a level of abstraction for a fleet that is useful when redirecting player traffic from one fleet to another, such as when updating your game build. </p>
/// <p>Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site. </p>
/// <p>To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID and an ARN. You can reassign an alias to another fleet by calling <code>UpdateAlias</code>.</p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateAlias {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_alias_input::Builder,
}
impl CreateAlias {
/// Creates a new `CreateAlias`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateAlias,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateAliasError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateAliasOutput,
aws_smithy_http::result::SdkError<crate::error::CreateAliasError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A descriptive label that is associated with an alias. Alias names do not need to be unique.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A descriptive label that is associated with an alias. Alias names do not need to be unique.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>A human-readable description of the alias.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.description(input.into());
self
}
/// <p>A human-readable description of the alias.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_description(input);
self
}
/// <p>The routing configuration, including routing type and fleet target, for the alias. </p>
pub fn routing_strategy(mut self, input: crate::model::RoutingStrategy) -> Self {
self.inner = self.inner.routing_strategy(input);
self
}
/// <p>The routing configuration, including routing type and fleet target, for the alias. </p>
pub fn set_routing_strategy(
mut self,
input: std::option::Option<crate::model::RoutingStrategy>,
) -> Self {
self.inner = self.inner.set_routing_strategy(input);
self
}
/// Appends an item to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
pub fn tags(mut self, input: crate::model::Tag) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
pub fn set_tags(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::Tag>>,
) -> Self {
self.inner = self.inner.set_tags(input);
self
}
}
/// Fluent builder constructing a request to `CreateBuild`.
///
/// <p>Creates a new Amazon GameLift build resource for your game server binary files. Combine game server binaries into a zip file for use with Amazon GameLift. </p> <important>
/// <p>When setting up a new game build for GameLift, we recommend using the CLI command <b> <a href="https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html">upload-build</a> </b>. This helper command combines two tasks: (1) it uploads your build files from a file directory to a GameLift Amazon S3 location, and (2) it creates a new build resource.</p>
/// </important>
/// <p>You can use the operation in the following scenarios:</p>
/// <ul>
/// <li> <p>To create a new game build with build files that are in an Amazon S3 location under an Amazon Web Services account that you control. To use this option, you give Amazon GameLift access to the Amazon S3 bucket. With permissions in place, specify a build name, operating system, and the Amazon S3 storage location of your game build.</p> </li>
/// <li> <p>To directly upload your build files to a GameLift Amazon S3 location. To use this option, specify a build name and operating system. This operation creates a new build resource and also returns an Amazon S3 location with temporary access credentials. Use the credentials to manually upload your build files to the specified Amazon S3 location. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html">Uploading Objects</a> in the <i>Amazon S3 Developer Guide</i>. After you upload build files to the GameLift Amazon S3 location, you can't update them. </p> </li>
/// </ul>
/// <p>If successful, this operation creates a new build resource with a unique build ID and places it in <code>INITIALIZED</code> status. A build must be in <code>READY</code> status before you can create fleets with it.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html">Uploading Your Game</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build"> Create a Build with Files in Amazon S3</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateBuild {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_build_input::Builder,
}
impl CreateBuild {
/// Creates a new `CreateBuild`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateBuild,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateBuildError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateBuildOutput,
aws_smithy_http::result::SdkError<crate::error::CreateBuildError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A descriptive label associated with a build. Build names do not need to be unique. You can change this value later. </p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A descriptive label associated with a build. Build names do not need to be unique. You can change this value later. </p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>Version information associated with a build or script. Version strings do not need to be unique. You can change this value later. </p>
pub fn version(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.version(input.into());
self
}
/// <p>Version information associated with a build or script. Version strings do not need to be unique. You can change this value later. </p>
pub fn set_version(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_version(input);
self
}
/// <p>Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.</p>
/// <p>If a <code>StorageLocation</code> is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift will report a <code>SizeOnDisk</code> of 0. </p>
pub fn storage_location(mut self, input: crate::model::S3Location) -> Self {
self.inner = self.inner.storage_location(input);
self
}
/// <p>Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.</p>
/// <p>If a <code>StorageLocation</code> is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift will report a <code>SizeOnDisk</code> of 0. </p>
pub fn set_storage_location(
mut self,
input: std::option::Option<crate::model::S3Location>,
) -> Self {
self.inner = self.inner.set_storage_location(input);
self
}
/// <p>The operating system that you built the game server binaries to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.</p>
pub fn operating_system(mut self, input: crate::model::OperatingSystem) -> Self {
self.inner = self.inner.operating_system(input);
self
}
/// <p>The operating system that you built the game server binaries to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.</p>
pub fn set_operating_system(
mut self,
input: std::option::Option<crate::model::OperatingSystem>,
) -> Self {
self.inner = self.inner.set_operating_system(input);
self
}
/// Appends an item to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>A list of labels to assign to the new build resource. Tags are developer defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. Once the resource is created, you can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html">TagResource</a>, <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html">UntagResource</a>, and <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html">ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.</p>
pub fn tags(mut self, input: crate::model::Tag) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>A list of labels to assign to the new build resource. Tags are developer defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. Once the resource is created, you can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html">TagResource</a>, <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html">UntagResource</a>, and <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html">ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.</p>
pub fn set_tags(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::Tag>>,
) -> Self {
self.inner = self.inner.set_tags(input);
self
}
/// <p>A server SDK version you used when integrating your game server build with GameLift. For more information see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html">Integrate games with custom game servers</a>.</p>
pub fn server_sdk_version(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.server_sdk_version(input.into());
self
}
/// <p>A server SDK version you used when integrating your game server build with GameLift. For more information see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html">Integrate games with custom game servers</a>.</p>
pub fn set_server_sdk_version(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_server_sdk_version(input);
self
}
}
/// Fluent builder constructing a request to `CreateFleet`.
///
/// <p>Creates a fleet of Amazon Elastic Compute Cloud (Amazon Elastic Compute Cloud) instances to host your custom game server or Realtime Servers. Use this operation to configure the computing resources for your fleet and provide instructions for running game servers on each instance.</p>
/// <p>Most GameLift fleets can deploy instances to multiple locations, including the home Region (where the fleet is created) and an optional set of remote locations. Fleets that are created in the following Amazon Web Services Regions support multiple locations: us-east-1 (N. Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that are created in other GameLift Regions can deploy instances in the fleet's home Region only. All fleet instances use the same configuration regardless of location; however, you can adjust capacity settings and turn auto-scaling on/off for each location.</p>
/// <p>To create a fleet, choose the hardware for your instances, specify a game server build or Realtime script to deploy, and provide a runtime configuration to direct GameLift how to start and run game servers on each instance in the fleet. Set permissions for inbound traffic to your game servers, and enable optional features as needed. When creating a multi-location fleet, provide a list of additional remote locations.</p>
/// <p>If you need to debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create the development fleet with port 22/3389 open. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. </p>
/// <p>If successful, this operation creates a new Fleet resource and places it in <code>NEW</code> status, which prompts GameLift to initiate the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creation-workflow.html">fleet creation workflow</a>.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up fleets</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation">Debug fleet creation issues</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Multi-location fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateFleet {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_fleet_input::Builder,
}
impl CreateFleet {
/// Creates a new `CreateFleet`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateFleet,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateFleetError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateFleetOutput,
aws_smithy_http::result::SdkError<crate::error::CreateFleetError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A descriptive label that is associated with a fleet. Fleet names do not need to be unique.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A descriptive label that is associated with a fleet. Fleet names do not need to be unique.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>A description for the fleet.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.description(input.into());
self
}
/// <p>A description for the fleet.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_description(input);
self
}
/// <p>The unique identifier for a custom game server build to be deployed on fleet instances. You can use either the build ID or ARN. The build must be uploaded to GameLift and in <code>READY</code> status. This fleet property cannot be changed later.</p>
pub fn build_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.build_id(input.into());
self
}
/// <p>The unique identifier for a custom game server build to be deployed on fleet instances. You can use either the build ID or ARN. The build must be uploaded to GameLift and in <code>READY</code> status. This fleet property cannot be changed later.</p>
pub fn set_build_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_build_id(input);
self
}
/// <p>The unique identifier for a Realtime configuration script to be deployed on fleet instances. You can use either the script ID or ARN. Scripts must be uploaded to GameLift prior to creating the fleet. This fleet property cannot be changed later.</p>
pub fn script_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.script_id(input.into());
self
}
/// <p>The unique identifier for a Realtime configuration script to be deployed on fleet instances. You can use either the script ID or ARN. Scripts must be uploaded to GameLift prior to creating the fleet. This fleet property cannot be changed later.</p>
pub fn set_script_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_script_id(input);
self
}
/// <p> <b>This parameter is no longer used.</b> Specify a server launch path using the <code>RuntimeConfiguration</code> parameter. Requests that use this parameter instead continue to be valid.</p>
pub fn server_launch_path(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.server_launch_path(input.into());
self
}
/// <p> <b>This parameter is no longer used.</b> Specify a server launch path using the <code>RuntimeConfiguration</code> parameter. Requests that use this parameter instead continue to be valid.</p>
pub fn set_server_launch_path(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_server_launch_path(input);
self
}
/// <p> <b>This parameter is no longer used.</b> Specify server launch parameters using the <code>RuntimeConfiguration</code> parameter. Requests that use this parameter instead continue to be valid.</p>
pub fn server_launch_parameters(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.server_launch_parameters(input.into());
self
}
/// <p> <b>This parameter is no longer used.</b> Specify server launch parameters using the <code>RuntimeConfiguration</code> parameter. Requests that use this parameter instead continue to be valid.</p>
pub fn set_server_launch_parameters(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_server_launch_parameters(input);
self
}
/// Appends an item to `LogPaths`.
///
/// To override the contents of this collection use [`set_log_paths`](Self::set_log_paths).
///
/// <p> <b>This parameter is no longer used.</b> To specify where GameLift should store log files once a server process shuts down, use the GameLift server API <code>ProcessReady()</code> and specify one or more directory paths in <code>logParameters</code>. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize">Initialize the server process</a> in the <i>GameLift Developer Guide</i>. </p>
pub fn log_paths(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.log_paths(input.into());
self
}
/// <p> <b>This parameter is no longer used.</b> To specify where GameLift should store log files once a server process shuts down, use the GameLift server API <code>ProcessReady()</code> and specify one or more directory paths in <code>logParameters</code>. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize">Initialize the server process</a> in the <i>GameLift Developer Guide</i>. </p>
pub fn set_log_paths(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_log_paths(input);
self
}
/// <p>The GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See <a href="http://aws.amazon.com/ec2/instance-types/">Amazon Elastic Compute Cloud Instance Types</a> for detailed descriptions of Amazon EC2 instance types.</p>
pub fn ec2_instance_type(mut self, input: crate::model::Ec2InstanceType) -> Self {
self.inner = self.inner.ec2_instance_type(input);
self
}
/// <p>The GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See <a href="http://aws.amazon.com/ec2/instance-types/">Amazon Elastic Compute Cloud Instance Types</a> for detailed descriptions of Amazon EC2 instance types.</p>
pub fn set_ec2_instance_type(
mut self,
input: std::option::Option<crate::model::Ec2InstanceType>,
) -> Self {
self.inner = self.inner.set_ec2_instance_type(input);
self
}
/// Appends an item to `EC2InboundPermissions`.
///
/// To override the contents of this collection use [`set_ec2_inbound_permissions`](Self::set_ec2_inbound_permissions).
///
/// <p>The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, GameLift automatically sets TCP and UDP ranges. </p>
pub fn ec2_inbound_permissions(mut self, input: crate::model::IpPermission) -> Self {
self.inner = self.inner.ec2_inbound_permissions(input);
self
}
/// <p>The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, GameLift automatically sets TCP and UDP ranges. </p>
pub fn set_ec2_inbound_permissions(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::IpPermission>>,
) -> Self {
self.inner = self.inner.set_ec2_inbound_permissions(input);
self
}
/// <p>The status of termination protection for active game sessions on the fleet. By default, this property is set to <code>NoProtection</code>. You can also set game session protection for an individual game session by calling <a href="gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a>.</p>
/// <ul>
/// <li> <p> <b>NoProtection</b> - Game sessions can be terminated during active gameplay as a result of a scale-down event. </p> </li>
/// <li> <p> <b>FullProtection</b> - Game sessions in <code>ACTIVE</code> status cannot be terminated during a scale-down event.</p> </li>
/// </ul>
pub fn new_game_session_protection_policy(
mut self,
input: crate::model::ProtectionPolicy,
) -> Self {
self.inner = self.inner.new_game_session_protection_policy(input);
self
}
/// <p>The status of termination protection for active game sessions on the fleet. By default, this property is set to <code>NoProtection</code>. You can also set game session protection for an individual game session by calling <a href="gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a>.</p>
/// <ul>
/// <li> <p> <b>NoProtection</b> - Game sessions can be terminated during active gameplay as a result of a scale-down event. </p> </li>
/// <li> <p> <b>FullProtection</b> - Game sessions in <code>ACTIVE</code> status cannot be terminated during a scale-down event.</p> </li>
/// </ul>
pub fn set_new_game_session_protection_policy(
mut self,
input: std::option::Option<crate::model::ProtectionPolicy>,
) -> Self {
self.inner = self.inner.set_new_game_session_protection_policy(input);
self
}
/// <p>Instructions for how to launch and maintain server processes on instances in the fleet. The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently. </p> <note>
/// <p>The <code>RuntimeConfiguration</code> parameter is required unless the fleet is being configured using the older parameters <code>ServerLaunchPath</code> and <code>ServerLaunchParameters</code>, which are still supported for backward compatibility.</p>
/// </note>
pub fn runtime_configuration(mut self, input: crate::model::RuntimeConfiguration) -> Self {
self.inner = self.inner.runtime_configuration(input);
self
}
/// <p>Instructions for how to launch and maintain server processes on instances in the fleet. The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently. </p> <note>
/// <p>The <code>RuntimeConfiguration</code> parameter is required unless the fleet is being configured using the older parameters <code>ServerLaunchPath</code> and <code>ServerLaunchParameters</code>, which are still supported for backward compatibility.</p>
/// </note>
pub fn set_runtime_configuration(
mut self,
input: std::option::Option<crate::model::RuntimeConfiguration>,
) -> Self {
self.inner = self.inner.set_runtime_configuration(input);
self
}
/// <p>A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.</p>
pub fn resource_creation_limit_policy(
mut self,
input: crate::model::ResourceCreationLimitPolicy,
) -> Self {
self.inner = self.inner.resource_creation_limit_policy(input);
self
}
/// <p>A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.</p>
pub fn set_resource_creation_limit_policy(
mut self,
input: std::option::Option<crate::model::ResourceCreationLimitPolicy>,
) -> Self {
self.inner = self.inner.set_resource_creation_limit_policy(input);
self
}
/// Appends an item to `MetricGroups`.
///
/// To override the contents of this collection use [`set_metric_groups`](Self::set_metric_groups).
///
/// <p>The name of an Amazon Web Services CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time. </p>
pub fn metric_groups(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.metric_groups(input.into());
self
}
/// <p>The name of an Amazon Web Services CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time. </p>
pub fn set_metric_groups(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_metric_groups(input);
self
}
/// <p>Used when peering your GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account settings. </p>
pub fn peer_vpc_aws_account_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.peer_vpc_aws_account_id(input.into());
self
}
/// <p>Used when peering your GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account settings. </p>
pub fn set_peer_vpc_aws_account_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_peer_vpc_aws_account_id(input);
self
}
/// <p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with GameLift Fleets</a>.</p>
pub fn peer_vpc_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.peer_vpc_id(input.into());
self
}
/// <p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with GameLift Fleets</a>.</p>
pub fn set_peer_vpc_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_peer_vpc_id(input);
self
}
/// <p>Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to <code>ON_DEMAND</code>. Learn more about when to use <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot"> On-Demand versus Spot Instances</a>. This property cannot be changed after the fleet is created.</p>
pub fn fleet_type(mut self, input: crate::model::FleetType) -> Self {
self.inner = self.inner.fleet_type(input);
self
}
/// <p>Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to <code>ON_DEMAND</code>. Learn more about when to use <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot"> On-Demand versus Spot Instances</a>. This property cannot be changed after the fleet is created.</p>
pub fn set_fleet_type(
mut self,
input: std::option::Option<crate::model::FleetType>,
) -> Self {
self.inner = self.inner.set_fleet_type(input);
self
}
/// <p>A unique identifier for an IAM role that manages access to your Amazon Web Services services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the <a href="https://console.aws.amazon.com/iam/">IAM dashboard</a> in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html"> Access external resources from a game server</a>. This property cannot be changed after the fleet is created.</p>
pub fn instance_role_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.instance_role_arn(input.into());
self
}
/// <p>A unique identifier for an IAM role that manages access to your Amazon Web Services services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the <a href="https://console.aws.amazon.com/iam/">IAM dashboard</a> in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html"> Access external resources from a game server</a>. This property cannot be changed after the fleet is created.</p>
pub fn set_instance_role_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_instance_role_arn(input);
self
}
/// <p>Prompts GameLift to generate a TLS/SSL certificate for the fleet. GameLift uses the certificates to encrypt traffic between game clients and the game servers running on GameLift. By default, the <code>CertificateConfiguration</code> is <code>DISABLED</code>. You can't change this property after you create the fleet. </p>
/// <p>Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.</p> <note>
/// <p>ACM isn't available in all Amazon Web Services regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html">Supported Regions</a> in the <i>Certificate Manager User Guide</i>.</p>
/// </note>
pub fn certificate_configuration(
mut self,
input: crate::model::CertificateConfiguration,
) -> Self {
self.inner = self.inner.certificate_configuration(input);
self
}
/// <p>Prompts GameLift to generate a TLS/SSL certificate for the fleet. GameLift uses the certificates to encrypt traffic between game clients and the game servers running on GameLift. By default, the <code>CertificateConfiguration</code> is <code>DISABLED</code>. You can't change this property after you create the fleet. </p>
/// <p>Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.</p> <note>
/// <p>ACM isn't available in all Amazon Web Services regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html">Supported Regions</a> in the <i>Certificate Manager User Guide</i>.</p>
/// </note>
pub fn set_certificate_configuration(
mut self,
input: std::option::Option<crate::model::CertificateConfiguration>,
) -> Self {
self.inner = self.inner.set_certificate_configuration(input);
self
}
/// Appends an item to `Locations`.
///
/// To override the contents of this collection use [`set_locations`](Self::set_locations).
///
/// <p>A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that support multiple locations. You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>. To create a fleet with instances in the home Region only, omit this parameter. </p>
pub fn locations(mut self, input: crate::model::LocationConfiguration) -> Self {
self.inner = self.inner.locations(input);
self
}
/// <p>A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that support multiple locations. You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>. To create a fleet with instances in the home Region only, omit this parameter. </p>
pub fn set_locations(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::LocationConfiguration>>,
) -> Self {
self.inner = self.inner.set_locations(input);
self
}
/// Appends an item to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
pub fn tags(mut self, input: crate::model::Tag) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
pub fn set_tags(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::Tag>>,
) -> Self {
self.inner = self.inner.set_tags(input);
self
}
/// <p>The type of compute resource used to host your game servers. You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift.</p>
pub fn compute_type(mut self, input: crate::model::ComputeType) -> Self {
self.inner = self.inner.compute_type(input);
self
}
/// <p>The type of compute resource used to host your game servers. You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift.</p>
pub fn set_compute_type(
mut self,
input: std::option::Option<crate::model::ComputeType>,
) -> Self {
self.inner = self.inner.set_compute_type(input);
self
}
/// <p>GameLift Anywhere configuration options.</p>
pub fn anywhere_configuration(
mut self,
input: crate::model::AnywhereConfiguration,
) -> Self {
self.inner = self.inner.anywhere_configuration(input);
self
}
/// <p>GameLift Anywhere configuration options.</p>
pub fn set_anywhere_configuration(
mut self,
input: std::option::Option<crate::model::AnywhereConfiguration>,
) -> Self {
self.inner = self.inner.set_anywhere_configuration(input);
self
}
}
/// Fluent builder constructing a request to `CreateFleetLocations`.
///
/// <p>Adds remote locations to a fleet and begins populating the new locations with EC2 instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings. </p> <note>
/// <p>This operation cannot be used with fleets that don't support remote locations. Fleets can have multiple locations only if they reside in Amazon Web Services Regions that support this feature and were created after the feature was released in March 2021.</p>
/// </note>
/// <p>To add fleet locations, specify the fleet to be updated and provide a list of one or more locations. </p>
/// <p>If successful, this operation returns the list of added locations with their status set to <code>NEW</code>. GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html">DescribeFleetEvents</a>.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up fleets</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Multi-location fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateFleetLocations {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_fleet_locations_input::Builder,
}
impl CreateFleetLocations {
/// Creates a new `CreateFleetLocations`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateFleetLocations,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateFleetLocationsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateFleetLocationsOutput,
aws_smithy_http::result::SdkError<crate::error::CreateFleetLocationsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet to add locations to. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to add locations to. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// Appends an item to `Locations`.
///
/// To override the contents of this collection use [`set_locations`](Self::set_locations).
///
/// <p>A list of locations to deploy additional instances to and manage as part of the fleet. You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>. </p>
pub fn locations(mut self, input: crate::model::LocationConfiguration) -> Self {
self.inner = self.inner.locations(input);
self
}
/// <p>A list of locations to deploy additional instances to and manage as part of the fleet. You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>. </p>
pub fn set_locations(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::LocationConfiguration>>,
) -> Self {
self.inner = self.inner.set_locations(input);
self
}
}
/// Fluent builder constructing a request to `CreateGameServerGroup`.
///
/// <p> <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b> </p>
/// <p>Creates a GameLift FleetIQ game server group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your Amazon Web Services account, and establishes a link between the two groups. You can view the status of your game server groups in the GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.</p>
/// <p>Before creating a new game server group, you must have the following: </p>
/// <ul>
/// <li> <p>An Amazon Elastic Compute Cloud launch template that specifies how to launch Amazon Elastic Compute Cloud instances with your game server build. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html"> Launching an Instance from a Launch Template</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </p> </li>
/// <li> <p>An IAM role that extends limited access to your Amazon Web Services account to allow GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-iam-permissions-roles.html">Create IAM roles for cross-service interaction</a> in the <i>GameLift FleetIQ Developer Guide</i>.</p> </li>
/// </ul>
/// <p>To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ metric.</p>
/// <p>Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ Guide</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateGameServerGroup {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_game_server_group_input::Builder,
}
impl CreateGameServerGroup {
/// Creates a new `CreateGameServerGroup`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateGameServerGroup,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateGameServerGroupError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateGameServerGroupOutput,
aws_smithy_http::result::SdkError<crate::error::CreateGameServerGroupError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>An identifier for the new game server group. This value is used to generate unique ARN identifiers for the Amazon EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per Amazon Web Services account.</p>
pub fn game_server_group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_group_name(input.into());
self
}
/// <p>An identifier for the new game server group. This value is used to generate unique ARN identifiers for the Amazon EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per Amazon Web Services account.</p>
pub fn set_game_server_group_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_group_name(input);
self
}
/// <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.</p>
pub fn role_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.role_arn(input.into());
self
}
/// <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.</p>
pub fn set_role_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_role_arn(input);
self
}
/// <p>The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.</p>
pub fn min_size(mut self, input: i32) -> Self {
self.inner = self.inner.min_size(input);
self
}
/// <p>The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.</p>
pub fn set_min_size(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_min_size(input);
self
}
/// <p>The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.</p>
pub fn max_size(mut self, input: i32) -> Self {
self.inner = self.inner.max_size(input);
self
}
/// <p>The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.</p>
pub fn set_max_size(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_size(input);
self
}
/// <p>The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html">Creating a Launch Template for an Auto Scaling Group</a> in the <i>Amazon Elastic Compute Cloud Auto Scaling User Guide</i>. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.</p> <note>
/// <p>If you specify network interfaces in your launch template, you must explicitly set the property <code>AssociatePublicIpAddress</code> to "true". If no network interface is specified in the launch template, GameLift FleetIQ uses your account's default VPC.</p>
/// </note>
pub fn launch_template(mut self, input: crate::model::LaunchTemplateSpecification) -> Self {
self.inner = self.inner.launch_template(input);
self
}
/// <p>The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html">Creating a Launch Template for an Auto Scaling Group</a> in the <i>Amazon Elastic Compute Cloud Auto Scaling User Guide</i>. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.</p> <note>
/// <p>If you specify network interfaces in your launch template, you must explicitly set the property <code>AssociatePublicIpAddress</code> to "true". If no network interface is specified in the launch template, GameLift FleetIQ uses your account's default VPC.</p>
/// </note>
pub fn set_launch_template(
mut self,
input: std::option::Option<crate::model::LaunchTemplateSpecification>,
) -> Self {
self.inner = self.inner.set_launch_template(input);
self
}
/// Appends an item to `InstanceDefinitions`.
///
/// To override the contents of this collection use [`set_instance_definitions`](Self::set_instance_definitions).
///
/// <p>The Amazon EC2 instance types and sizes to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">EC2 Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html"> Instance Weighting for Amazon EC2 Auto Scaling</a> in the Amazon EC2 Auto Scaling User Guide.</p>
pub fn instance_definitions(mut self, input: crate::model::InstanceDefinition) -> Self {
self.inner = self.inner.instance_definitions(input);
self
}
/// <p>The Amazon EC2 instance types and sizes to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">EC2 Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html"> Instance Weighting for Amazon EC2 Auto Scaling</a> in the Amazon EC2 Auto Scaling User Guide.</p>
pub fn set_instance_definitions(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::InstanceDefinition>>,
) -> Self {
self.inner = self.inner.set_instance_definitions(input);
self
}
/// <p>Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric <code>"PercentUtilizedGameServers"</code> to maintain a buffer of idle game servers that can immediately accommodate new games and players. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.</p>
pub fn auto_scaling_policy(
mut self,
input: crate::model::GameServerGroupAutoScalingPolicy,
) -> Self {
self.inner = self.inner.auto_scaling_policy(input);
self
}
/// <p>Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric <code>"PercentUtilizedGameServers"</code> to maintain a buffer of idle game servers that can immediately accommodate new games and players. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.</p>
pub fn set_auto_scaling_policy(
mut self,
input: std::option::Option<crate::model::GameServerGroupAutoScalingPolicy>,
) -> Self {
self.inner = self.inner.set_auto_scaling_policy(input);
self
}
/// <p>Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:</p>
/// <ul>
/// <li> <p> <code>SPOT_ONLY</code> - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.</p> </li>
/// <li> <p> <code>SPOT_PREFERRED</code> - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.</p> </li>
/// <li> <p> <code>ON_DEMAND_ONLY</code> - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.</p> </li>
/// </ul>
pub fn balancing_strategy(mut self, input: crate::model::BalancingStrategy) -> Self {
self.inner = self.inner.balancing_strategy(input);
self
}
/// <p>Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:</p>
/// <ul>
/// <li> <p> <code>SPOT_ONLY</code> - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.</p> </li>
/// <li> <p> <code>SPOT_PREFERRED</code> - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.</p> </li>
/// <li> <p> <code>ON_DEMAND_ONLY</code> - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.</p> </li>
/// </ul>
pub fn set_balancing_strategy(
mut self,
input: std::option::Option<crate::model::BalancingStrategy>,
) -> Self {
self.inner = self.inner.set_balancing_strategy(input);
self
}
/// <p>A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by Amazon Web Services regardless of protection status. This property is set to <code>NO_PROTECTION</code> by default.</p>
pub fn game_server_protection_policy(
mut self,
input: crate::model::GameServerProtectionPolicy,
) -> Self {
self.inner = self.inner.game_server_protection_policy(input);
self
}
/// <p>A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by Amazon Web Services regardless of protection status. This property is set to <code>NO_PROTECTION</code> by default.</p>
pub fn set_game_server_protection_policy(
mut self,
input: std::option::Option<crate::model::GameServerProtectionPolicy>,
) -> Self {
self.inner = self.inner.set_game_server_protection_policy(input);
self
}
/// Appends an item to `VpcSubnets`.
///
/// To override the contents of this collection use [`set_vpc_subnets`](Self::set_vpc_subnets).
///
/// <p>A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all GameLift FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly.</p>
pub fn vpc_subnets(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.vpc_subnets(input.into());
self
}
/// <p>A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all GameLift FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly.</p>
pub fn set_vpc_subnets(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_vpc_subnets(input);
self
}
/// Appends an item to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management, and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
pub fn tags(mut self, input: crate::model::Tag) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management, and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
pub fn set_tags(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::Tag>>,
) -> Self {
self.inner = self.inner.set_tags(input);
self
}
}
/// Fluent builder constructing a request to `CreateGameSession`.
///
/// <p>Creates a multiplayer game session for players in a specific fleet location. This operation prompts an available server process to start a game session and retrieves connection information for the new game session. As an alternative, consider using the GameLift game session placement feature with <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html">StartGameSessionPlacement</a> , which uses FleetIQ algorithms and queues to optimize the placement process.</p>
/// <p>When creating a game session, you specify exactly where you want to place it and provide a set of game session configuration settings. The fleet must be in <code>ACTIVE</code> status before a game session can be created in it. </p>
/// <p>This operation can be used in the following ways: </p>
/// <ul>
/// <li> <p>To create a game session on an instance in a fleet's home Region, provide a fleet or alias ID along with your game session configuration. </p> </li>
/// <li> <p>To create a game session on an instance in a fleet's remote location, provide a fleet or alias ID and a location name, along with your game session configuration. </p> </li>
/// </ul>
/// <p>If successful, a workflow is initiated to start a new game session. A <code>GameSession</code> object is returned containing the game session configuration and status. When the status is <code>ACTIVE</code>, game session connection information is provided and player sessions can be created for the game session. By default, newly created game sessions are open to new players. You can restrict new player access by using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a> to change the game session's player session creation policy.</p>
/// <p>Game session logs are retained for all active game sessions for 14 days. To access the logs, call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetGameSessionLogUrl.html">GetGameSessionLogUrl</a> to download the log files.</p>
/// <p> <i>Available in Amazon GameLift Local.</i> </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a game session</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateGameSession {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_game_session_input::Builder,
}
impl CreateGameSession {
/// Creates a new `CreateGameSession`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateGameSession,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateGameSessionError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateGameSessionOutput,
aws_smithy_http::result::SdkError<crate::error::CreateGameSessionError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>A unique identifier for the alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.</p>
pub fn alias_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.alias_id(input.into());
self
}
/// <p>A unique identifier for the alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.</p>
pub fn set_alias_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_alias_id(input);
self
}
/// <p>The maximum number of players that can be connected simultaneously to the game session.</p>
pub fn maximum_player_session_count(mut self, input: i32) -> Self {
self.inner = self.inner.maximum_player_session_count(input);
self
}
/// <p>The maximum number of players that can be connected simultaneously to the game session.</p>
pub fn set_maximum_player_session_count(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_maximum_player_session_count(input);
self
}
/// <p>A descriptive label that is associated with a game session. Session names do not need to be unique.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A descriptive label that is associated with a game session. Session names do not need to be unique.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// Appends an item to `GameProperties`.
///
/// To override the contents of this collection use [`set_game_properties`](Self::set_game_properties).
///
/// <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</p>
pub fn game_properties(mut self, input: crate::model::GameProperty) -> Self {
self.inner = self.inner.game_properties(input);
self
}
/// <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</p>
pub fn set_game_properties(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::GameProperty>>,
) -> Self {
self.inner = self.inner.set_game_properties(input);
self
}
/// <p>A unique identifier for a player or entity creating the game session. This parameter is required when requesting a new game session on a fleet with a resource creation limit policy. This type of policy limits the number of concurrent active game sessions that one player can create within a certain time span. GameLift uses the CreatorId to evaluate the new request against the policy.</p>
pub fn creator_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.creator_id(input.into());
self
}
/// <p>A unique identifier for a player or entity creating the game session. This parameter is required when requesting a new game session on a fleet with a resource creation limit policy. This type of policy limits the number of concurrent active game sessions that one player can create within a certain time span. GameLift uses the CreatorId to evaluate the new request against the policy.</p>
pub fn set_creator_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_creator_id(input);
self
}
/// <p> <i>This parameter is deprecated. Use <code>IdempotencyToken</code> instead.</i> </p>
/// <p>Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID.</p>
pub fn game_session_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_session_id(input.into());
self
}
/// <p> <i>This parameter is deprecated. Use <code>IdempotencyToken</code> instead.</i> </p>
/// <p>Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID.</p>
pub fn set_game_session_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_session_id(input);
self
}
/// <p>Custom string that uniquely identifies the new game session request. This is useful for ensuring that game session requests with the same idempotency token are processed only once. Subsequent requests with the same string return the original <code>GameSession</code> object, with an updated status. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. A game session ARN has the following format: <code>arn:aws:gamelift:
/// <region>
/// ::gamesession/
/// <fleet id>
/// /
/// <custom id string or idempotency token></custom>
/// </fleet>
/// </region></code>. Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.</p>
pub fn idempotency_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.idempotency_token(input.into());
self
}
/// <p>Custom string that uniquely identifies the new game session request. This is useful for ensuring that game session requests with the same idempotency token are processed only once. Subsequent requests with the same string return the original <code>GameSession</code> object, with an updated status. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. A game session ARN has the following format: <code>arn:aws:gamelift:
/// <region>
/// ::gamesession/
/// <fleet id>
/// /
/// <custom id string or idempotency token></custom>
/// </fleet>
/// </region></code>. Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.</p>
pub fn set_idempotency_token(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_idempotency_token(input);
self
}
/// <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</p>
pub fn game_session_data(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_session_data(input.into());
self
}
/// <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</p>
pub fn set_game_session_data(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_session_data(input);
self
}
/// <p>A fleet's remote location to place the new game session in. If this parameter is not set, the new game session is placed in the fleet's home Region. Specify a remote location with an Amazon Web Services Region code such as <code>us-west-2</code>. </p>
pub fn location(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.location(input.into());
self
}
/// <p>A fleet's remote location to place the new game session in. If this parameter is not set, the new game session is placed in the fleet's home Region. Specify a remote location with an Amazon Web Services Region code such as <code>us-west-2</code>. </p>
pub fn set_location(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_location(input);
self
}
}
/// Fluent builder constructing a request to `CreateGameSessionQueue`.
///
/// <p>Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server there, then prompts the game server process to start a new game session. </p>
/// <p>A game session queue is configured with a set of destinations (GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to place game sessions in all of a fleet's remote locations. You can opt to filter out individual locations if needed.</p>
/// <p>The queue configuration also determines how FleetIQ selects the best available placement for a new game session. Before searching for an available game server, FleetIQ first prioritizes the queue's destinations and locations, with the best placement locations on top. You can set up the queue to use the FleetIQ default prioritization or provide an alternate set of priorities.</p>
/// <p>To create a new queue, provide a name, timeout value, and a list of destinations. Optionally, specify a sort configuration and/or a filter, and define a set of latency cap policies. You can also include the ARN for an Amazon Simple Notification Service (SNS) topic to receive notifications of game session placement activity. Notifications using SNS or CloudWatch events is the preferred way to track placement activity.</p>
/// <p>If successful, a new <code>GameSessionQueue</code> object is returned with an assigned queue ARN. New game session requests, which are submitted to queue with <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html">StartGameSessionPlacement</a> or <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchmaking.html">StartMatchmaking</a>, reference a queue's name or ARN. </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-design.html"> Design a game session queue</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-creating.html"> Create a game session queue</a> </p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html">CreateGameSessionQueue</a> | <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html">DescribeGameSessionQueues</a> | <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html">UpdateGameSessionQueue</a> | <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html">DeleteGameSessionQueue</a> | <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateGameSessionQueue {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_game_session_queue_input::Builder,
}
impl CreateGameSessionQueue {
/// Creates a new `CreateGameSessionQueue`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateGameSessionQueue,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateGameSessionQueueError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateGameSessionQueueOutput,
aws_smithy_http::result::SdkError<crate::error::CreateGameSessionQueueError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A descriptive label that is associated with game session queue. Queue names must be unique within each Region.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A descriptive label that is associated with game session queue. Queue names must be unique within each Region.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a <code>TIMED_OUT</code> status.</p>
pub fn timeout_in_seconds(mut self, input: i32) -> Self {
self.inner = self.inner.timeout_in_seconds(input);
self
}
/// <p>The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a <code>TIMED_OUT</code> status.</p>
pub fn set_timeout_in_seconds(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_timeout_in_seconds(input);
self
}
/// Appends an item to `PlayerLatencyPolicies`.
///
/// To override the contents of this collection use [`set_player_latency_policies`](Self::set_player_latency_policies).
///
/// <p>A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.</p>
pub fn player_latency_policies(mut self, input: crate::model::PlayerLatencyPolicy) -> Self {
self.inner = self.inner.player_latency_policies(input);
self
}
/// <p>A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.</p>
pub fn set_player_latency_policies(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::PlayerLatencyPolicy>>,
) -> Self {
self.inner = self.inner.set_player_latency_policies(input);
self
}
/// Appends an item to `Destinations`.
///
/// To override the contents of this collection use [`set_destinations`](Self::set_destinations).
///
/// <p>A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.</p>
pub fn destinations(mut self, input: crate::model::GameSessionQueueDestination) -> Self {
self.inner = self.inner.destinations(input);
self
}
/// <p>A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.</p>
pub fn set_destinations(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::GameSessionQueueDestination>>,
) -> Self {
self.inner = self.inner.set_destinations(input);
self
}
/// <p>A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as <code>us-west-2</code>. If this parameter is not set, game sessions can be placed in any queue location. </p>
pub fn filter_configuration(mut self, input: crate::model::FilterConfiguration) -> Self {
self.inner = self.inner.filter_configuration(input);
self
}
/// <p>A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as <code>us-west-2</code>. If this parameter is not set, game sessions can be placed in any queue location. </p>
pub fn set_filter_configuration(
mut self,
input: std::option::Option<crate::model::FilterConfiguration>,
) -> Self {
self.inner = self.inner.set_filter_configuration(input);
self
}
/// <p>Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. </p>
pub fn priority_configuration(
mut self,
input: crate::model::PriorityConfiguration,
) -> Self {
self.inner = self.inner.priority_configuration(input);
self
}
/// <p>Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. </p>
pub fn set_priority_configuration(
mut self,
input: std::option::Option<crate::model::PriorityConfiguration>,
) -> Self {
self.inner = self.inner.set_priority_configuration(input);
self
}
/// <p>Information to be added to all events that are related to this game session queue.</p>
pub fn custom_event_data(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.custom_event_data(input.into());
self
}
/// <p>Information to be added to all events that are related to this game session queue.</p>
pub fn set_custom_event_data(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_custom_event_data(input);
self
}
/// <p>An SNS topic ARN that is set up to receive game session placement notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html"> Setting up notifications for game session placement</a>.</p>
pub fn notification_target(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.notification_target(input.into());
self
}
/// <p>An SNS topic ARN that is set up to receive game session placement notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html"> Setting up notifications for game session placement</a>.</p>
pub fn set_notification_target(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_notification_target(input);
self
}
/// Appends an item to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
pub fn tags(mut self, input: crate::model::Tag) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
pub fn set_tags(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::Tag>>,
) -> Self {
self.inner = self.inner.set_tags(input);
self
}
}
/// Fluent builder constructing a request to `CreateLocation`.
///
/// <p>Creates a custom location for use in an Anywhere fleet.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateLocation {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_location_input::Builder,
}
impl CreateLocation {
/// Creates a new `CreateLocation`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateLocation,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateLocationError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateLocationOutput,
aws_smithy_http::result::SdkError<crate::error::CreateLocationError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A descriptive name for the custom location.</p>
pub fn location_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.location_name(input.into());
self
}
/// <p>A descriptive name for the custom location.</p>
pub fn set_location_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_location_name(input);
self
}
/// Appends an item to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Rareference</i>.</p>
pub fn tags(mut self, input: crate::model::Tag) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Rareference</i>.</p>
pub fn set_tags(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::Tag>>,
) -> Self {
self.inner = self.inner.set_tags(input);
self
}
}
/// Fluent builder constructing a request to `CreateMatchmakingConfiguration`.
///
/// <p>Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using GameLift hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes consistent with that configuration. </p>
/// <p>To create a matchmaking configuration, you must provide the following: configuration name and FlexMatch mode (with or without GameLift hosting); a rule set that specifies how to evaluate players and find acceptable matches; whether player acceptance is required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch with GameLift hosting, you also need to identify the game session queue to use when starting a game session for the match.</p>
/// <p>In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html"> Design a FlexMatch matchmaker</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Set up FlexMatch event notification</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateMatchmakingConfiguration {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_matchmaking_configuration_input::Builder,
}
impl CreateMatchmakingConfiguration {
/// Creates a new `CreateMatchmakingConfiguration`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateMatchmakingConfiguration,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateMatchmakingConfigurationError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateMatchmakingConfigurationOutput,
aws_smithy_http::result::SdkError<crate::error::CreateMatchmakingConfigurationError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>A human-readable description of the matchmaking configuration. </p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.description(input.into());
self
}
/// <p>A human-readable description of the matchmaking configuration. </p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_description(input);
self
}
/// Appends an item to `GameSessionQueueArns`.
///
/// To override the contents of this collection use [`set_game_session_queue_arns`](Self::set_game_session_queue_arns).
///
/// <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 GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:
/// <region>
/// ::gamesessionqueue/
/// <queue name></queue>
/// </region></code>. Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If <code>FlexMatchMode</code> is set to <code>STANDALONE</code>, do not set this parameter. </p>
pub fn game_session_queue_arns(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_session_queue_arns(input.into());
self
}
/// <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 GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:
/// <region>
/// ::gamesessionqueue/
/// <queue name></queue>
/// </region></code>. Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If <code>FlexMatchMode</code> is set to <code>STANDALONE</code>, do not set this parameter. </p>
pub fn set_game_session_queue_arns(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_game_session_queue_arns(input);
self
}
/// <p>The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.</p>
pub fn request_timeout_seconds(mut self, input: i32) -> Self {
self.inner = self.inner.request_timeout_seconds(input);
self
}
/// <p>The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.</p>
pub fn set_request_timeout_seconds(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_request_timeout_seconds(input);
self
}
/// <p>The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. </p>
pub fn acceptance_timeout_seconds(mut self, input: i32) -> Self {
self.inner = self.inner.acceptance_timeout_seconds(input);
self
}
/// <p>The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. </p>
pub fn set_acceptance_timeout_seconds(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_acceptance_timeout_seconds(input);
self
}
/// <p>A flag that determines whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to <code>TRUE</code>. With this option enabled, matchmaking tickets use the status <code>REQUIRES_ACCEPTANCE</code> to indicate when a completed potential match is waiting for player acceptance. </p>
pub fn acceptance_required(mut self, input: bool) -> Self {
self.inner = self.inner.acceptance_required(input);
self
}
/// <p>A flag that determines whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to <code>TRUE</code>. With this option enabled, matchmaking tickets use the status <code>REQUIRES_ACCEPTANCE</code> to indicate when a completed potential match is waiting for player acceptance. </p>
pub fn set_acceptance_required(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_acceptance_required(input);
self
}
/// <p>A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.</p>
pub fn rule_set_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.rule_set_name(input.into());
self
}
/// <p>A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.</p>
pub fn set_rule_set_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_rule_set_name(input);
self
}
/// <p>An SNS topic ARN that is set up to receive matchmaking notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Setting up notifications for matchmaking</a> for more information.</p>
pub fn notification_target(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.notification_target(input.into());
self
}
/// <p>An SNS topic ARN that is set up to receive matchmaking notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Setting up notifications for matchmaking</a> for more information.</p>
pub fn set_notification_target(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_notification_target(input);
self
}
/// <p>The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
pub fn additional_player_count(mut self, input: i32) -> Self {
self.inner = self.inner.additional_player_count(input);
self
}
/// <p>The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
pub fn set_additional_player_count(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_additional_player_count(input);
self
}
/// <p>Information to be added to all events related to this matchmaking configuration. </p>
pub fn custom_event_data(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.custom_event_data(input.into());
self
}
/// <p>Information to be added to all events related to this matchmaking configuration. </p>
pub fn set_custom_event_data(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_custom_event_data(input);
self
}
/// Appends an item to `GameProperties`.
///
/// To override the contents of this collection use [`set_game_properties`](Self::set_game_properties).
///
/// <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the new <code>GameSession</code> object that is created for a successful match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
pub fn game_properties(mut self, input: crate::model::GameProperty) -> Self {
self.inner = self.inner.game_properties(input);
self
}
/// <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the new <code>GameSession</code> object that is created for a successful match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
pub fn set_game_properties(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::GameProperty>>,
) -> Self {
self.inner = self.inner.set_game_properties(input);
self
}
/// <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the new <code>GameSession</code> object that is created for a successful match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
pub fn game_session_data(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_session_data(input.into());
self
}
/// <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the new <code>GameSession</code> object that is created for a successful match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
pub fn set_game_session_data(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_session_data(input);
self
}
/// <p>The method used to backfill game sessions that are created with this matchmaking configuration. Specify <code>MANUAL</code> when your game manages backfill requests manually or does not use the match backfill feature. Specify <code>AUTOMATIC</code> to have GameLift create a backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html"> Backfill Existing Games with FlexMatch</a>. Automatic backfill is not available when <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
pub fn backfill_mode(mut self, input: crate::model::BackfillMode) -> Self {
self.inner = self.inner.backfill_mode(input);
self
}
/// <p>The method used to backfill game sessions that are created with this matchmaking configuration. Specify <code>MANUAL</code> when your game manages backfill requests manually or does not use the match backfill feature. Specify <code>AUTOMATIC</code> to have GameLift create a backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html"> Backfill Existing Games with FlexMatch</a>. Automatic backfill is not available when <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
pub fn set_backfill_mode(
mut self,
input: std::option::Option<crate::model::BackfillMode>,
) -> Self {
self.inner = self.inner.set_backfill_mode(input);
self
}
/// <p>Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution. </p>
/// <ul>
/// <li> <p> <b>STANDALONE</b> - FlexMatch forms matches and returns match information, including players and team assignments, in a <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded"> MatchmakingSucceeded</a> event.</p> </li>
/// <li> <p> <b>WITH_QUEUE</b> - FlexMatch forms matches and uses the specified GameLift queue to start a game session for the match. </p> </li>
/// </ul>
pub fn flex_match_mode(mut self, input: crate::model::FlexMatchMode) -> Self {
self.inner = self.inner.flex_match_mode(input);
self
}
/// <p>Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution. </p>
/// <ul>
/// <li> <p> <b>STANDALONE</b> - FlexMatch forms matches and returns match information, including players and team assignments, in a <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded"> MatchmakingSucceeded</a> event.</p> </li>
/// <li> <p> <b>WITH_QUEUE</b> - FlexMatch forms matches and uses the specified GameLift queue to start a game session for the match. </p> </li>
/// </ul>
pub fn set_flex_match_mode(
mut self,
input: std::option::Option<crate::model::FlexMatchMode>,
) -> Self {
self.inner = self.inner.set_flex_match_mode(input);
self
}
/// Appends an item to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
pub fn tags(mut self, input: crate::model::Tag) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
pub fn set_tags(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::Tag>>,
) -> Self {
self.inner = self.inner.set_tags(input);
self
}
}
/// Fluent builder constructing a request to `CreateMatchmakingRuleSet`.
///
/// <p>Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams. It also sets the parameters for acceptable player matches, such as minimum skill level or character type.</p>
/// <p>To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration they are used with.</p>
/// <p>Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ValidateMatchmakingRuleSet.html">ValidateMatchmakingRuleSet</a> before creating a new rule set.</p>
/// <p> <b>Learn more</b> </p>
/// <ul>
/// <li> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html">Build a rule set</a> </p> </li>
/// <li> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html">Design a matchmaker</a> </p> </li>
/// <li> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-intro.html">Matchmaking with FlexMatch</a> </p> </li>
/// </ul>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateMatchmakingRuleSet {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_matchmaking_rule_set_input::Builder,
}
impl CreateMatchmakingRuleSet {
/// Creates a new `CreateMatchmakingRuleSet`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateMatchmakingRuleSet,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateMatchmakingRuleSetError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateMatchmakingRuleSetOutput,
aws_smithy_http::result::SdkError<crate::error::CreateMatchmakingRuleSetError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the matchmaking rule set. A matchmaking configuration identifies the rule set it uses by this name value. Note that the rule set name is different from the optional <code>name</code> field in the rule set body.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A unique identifier for the matchmaking rule set. A matchmaking configuration identifies the rule set it uses by this name value. Note that the rule set name is different from the optional <code>name</code> field in the rule set body.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.</p>
pub fn rule_set_body(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.rule_set_body(input.into());
self
}
/// <p>A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.</p>
pub fn set_rule_set_body(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_rule_set_body(input);
self
}
/// Appends an item to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
pub fn tags(mut self, input: crate::model::Tag) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
pub fn set_tags(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::Tag>>,
) -> Self {
self.inner = self.inner.set_tags(input);
self
}
}
/// Fluent builder constructing a request to `CreatePlayerSession`.
///
/// <p>Reserves an open player slot in a game session for a player. New player sessions can be created in any game session with an open slot that is in <code>ACTIVE</code> status and has a player creation policy of <code>ACCEPT_ALL</code>. You can add a group of players to a game session with <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSessions.html">CreatePlayerSessions</a> . </p>
/// <p>To create a player session, specify a game session ID, player ID, and optionally a set of player data. </p>
/// <p>If successful, a slot is reserved in the game session for the player and a new <code>PlayerSessions</code> object is returned with a player session ID. The player references the player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the GameLift service. Player sessions cannot be updated. </p>
/// <p>The maximum number of players per game session is 200. It is not adjustable. </p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreatePlayerSession {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_player_session_input::Builder,
}
impl CreatePlayerSession {
/// Creates a new `CreatePlayerSession`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreatePlayerSession,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreatePlayerSessionError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreatePlayerSessionOutput,
aws_smithy_http::result::SdkError<crate::error::CreatePlayerSessionError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the game session to add a player to.</p>
pub fn game_session_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_session_id(input.into());
self
}
/// <p>A unique identifier for the game session to add a player to.</p>
pub fn set_game_session_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_session_id(input);
self
}
/// <p>A unique identifier for a player. Player IDs are developer-defined.</p>
pub fn player_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.player_id(input.into());
self
}
/// <p>A unique identifier for a player. Player IDs are developer-defined.</p>
pub fn set_player_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_player_id(input);
self
}
/// <p>Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.</p>
pub fn player_data(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.player_data(input.into());
self
}
/// <p>Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.</p>
pub fn set_player_data(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_player_data(input);
self
}
}
/// Fluent builder constructing a request to `CreatePlayerSessions`.
///
/// <p>Reserves open slots in a game session for a group of players. New player sessions can be created in any game session with an open slot that is in <code>ACTIVE</code> status and has a player creation policy of <code>ACCEPT_ALL</code>. To add a single player to a game session, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSession.html">CreatePlayerSession</a> </p>
/// <p>To create player sessions, specify a game session ID and a list of player IDs. Optionally, provide a set of player data for each player ID. </p>
/// <p>If successful, a slot is reserved in the game session for each player, and new <code>PlayerSession</code> objects are returned with player session IDs. Each player references their player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the GameLift service. Player sessions cannot be updated.</p>
/// <p>The maximum number of players per game session is 200. It is not adjustable. </p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreatePlayerSessions {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_player_sessions_input::Builder,
}
impl CreatePlayerSessions {
/// Creates a new `CreatePlayerSessions`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreatePlayerSessions,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreatePlayerSessionsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreatePlayerSessionsOutput,
aws_smithy_http::result::SdkError<crate::error::CreatePlayerSessionsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the game session to add players to.</p>
pub fn game_session_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_session_id(input.into());
self
}
/// <p>A unique identifier for the game session to add players to.</p>
pub fn set_game_session_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_session_id(input);
self
}
/// Appends an item to `PlayerIds`.
///
/// To override the contents of this collection use [`set_player_ids`](Self::set_player_ids).
///
/// <p>List of unique identifiers for the players to be added.</p>
pub fn player_ids(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.player_ids(input.into());
self
}
/// <p>List of unique identifiers for the players to be added.</p>
pub fn set_player_ids(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_player_ids(input);
self
}
/// Adds a key-value pair to `PlayerDataMap`.
///
/// To override the contents of this collection use [`set_player_data_map`](Self::set_player_data_map).
///
/// <p>Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the <code>PlayerIds</code> parameter are ignored. </p>
pub fn player_data_map(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.player_data_map(k.into(), v.into());
self
}
/// <p>Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Any player data strings for player IDs that are not included in the <code>PlayerIds</code> parameter are ignored. </p>
pub fn set_player_data_map(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.inner = self.inner.set_player_data_map(input);
self
}
}
/// Fluent builder constructing a request to `CreateScript`.
///
/// <p>Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session. </p>
/// <p>To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations: </p>
/// <ul>
/// <li> <p>A locally available directory. Use the <i>ZipFile</i> parameter for this option.</p> </li>
/// <li> <p>An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web Services account. Use the <i>StorageLocation</i> parameter for this option. You'll need to have an Identity Access Management (IAM) role that allows the Amazon GameLift service to access your S3 bucket. </p> </li>
/// </ul>
/// <p>If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html">Set Up a Role for Amazon GameLift Access</a> </p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateScript {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_script_input::Builder,
}
impl CreateScript {
/// Creates a new `CreateScript`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateScript,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateScriptError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateScriptOutput,
aws_smithy_http::result::SdkError<crate::error::CreateScriptError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A descriptive label that is associated with a script. Script names do not need to be unique. You can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html">UpdateScript</a> to change this value later. </p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A descriptive label that is associated with a script. Script names do not need to be unique. You can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html">UpdateScript</a> to change this value later. </p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>Version information associated with a build or script. Version strings do not need to be unique. You can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html">UpdateScript</a> to change this value later. </p>
pub fn version(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.version(input.into());
self
}
/// <p>Version information associated with a build or script. Version strings do not need to be unique. You can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html">UpdateScript</a> to change this value later. </p>
pub fn set_version(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_version(input);
self
}
/// <p>The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the <code>ObjectVersion</code> parameter to specify an earlier version. </p>
pub fn storage_location(mut self, input: crate::model::S3Location) -> Self {
self.inner = self.inner.storage_location(input);
self
}
/// <p>The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the <code>ObjectVersion</code> parameter to specify an earlier version. </p>
pub fn set_storage_location(
mut self,
input: std::option::Option<crate::model::S3Location>,
) -> Self {
self.inner = self.inner.set_storage_location(input);
self
}
/// <p>A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.</p>
/// <p>When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: <code>--zip-file fileb://myRealtimeScript.zip</code>.</p>
pub fn zip_file(mut self, input: aws_smithy_types::Blob) -> Self {
self.inner = self.inner.zip_file(input);
self
}
/// <p>A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.</p>
/// <p>When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: <code>--zip-file fileb://myRealtimeScript.zip</code>.</p>
pub fn set_zip_file(mut self, input: std::option::Option<aws_smithy_types::Blob>) -> Self {
self.inner = self.inner.set_zip_file(input);
self
}
/// Appends an item to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. Once the resource is created, you can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html">TagResource</a>, <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html">UntagResource</a>, and <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html">ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.</p>
pub fn tags(mut self, input: crate::model::Tag) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>. Once the resource is created, you can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html">TagResource</a>, <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html">UntagResource</a>, and <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html">ListTagsForResource</a> to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.</p>
pub fn set_tags(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::Tag>>,
) -> Self {
self.inner = self.inner.set_tags(input);
self
}
}
/// Fluent builder constructing a request to `CreateVpcPeeringAuthorization`.
///
/// <p>Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. After you've received authorization, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringConnection.html">CreateVpcPeeringConnection</a> to establish the peering connection. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon GameLift Fleets</a>.</p>
/// <p>You can peer with VPCs that are owned by any Amazon Web Services account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions.</p>
/// <p>To request authorization to create a connection, call this operation from the Amazon Web Services account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC. </p>
/// <p>To request authorization to delete a connection, call this operation from the Amazon Web Services account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the Amazon Web Services account that you use to manage Amazon GameLift. </p>
/// <p>The authorization remains valid for 24 hours unless it is canceled. You must create or delete the peering connection while the authorization is valid. </p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateVpcPeeringAuthorization {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_vpc_peering_authorization_input::Builder,
}
impl CreateVpcPeeringAuthorization {
/// Creates a new `CreateVpcPeeringAuthorization`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateVpcPeeringAuthorization,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateVpcPeeringAuthorizationError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateVpcPeeringAuthorizationOutput,
aws_smithy_http::result::SdkError<crate::error::CreateVpcPeeringAuthorizationError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.</p>
pub fn game_lift_aws_account_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_lift_aws_account_id(input.into());
self
}
/// <p>A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.</p>
pub fn set_game_lift_aws_account_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_lift_aws_account_id(input);
self
}
/// <p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with GameLift Fleets</a>.</p>
pub fn peer_vpc_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.peer_vpc_id(input.into());
self
}
/// <p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with GameLift Fleets</a>.</p>
pub fn set_peer_vpc_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_peer_vpc_id(input);
self
}
}
/// Fluent builder constructing a request to `CreateVpcPeeringConnection`.
///
/// <p>Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon GameLift Fleets</a>.</p>
/// <p>Before calling this operation to establish the peering connection, you first need to use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html">CreateVpcPeeringAuthorization</a> and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc. </p>
/// <p>To establish the connection, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a connection request is created. You can use continuous polling to track the request's status using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeVpcPeeringConnections.html">DescribeVpcPeeringConnections</a> , or by monitoring fleet events for success or failure using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html">DescribeFleetEvents</a> . </p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateVpcPeeringConnection {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::create_vpc_peering_connection_input::Builder,
}
impl CreateVpcPeeringConnection {
/// Creates a new `CreateVpcPeeringConnection`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::CreateVpcPeeringConnection,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::CreateVpcPeeringConnectionError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::CreateVpcPeeringConnectionOutput,
aws_smithy_http::result::SdkError<crate::error::CreateVpcPeeringConnectionError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet. You can use either the fleet ID or ARN value. This tells Amazon GameLift which GameLift VPC to peer with. </p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet. You can use either the fleet ID or ARN value. This tells Amazon GameLift which GameLift VPC to peer with. </p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>A unique identifier for the Amazon Web Services account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the Amazon Web Services Management Console under account settings.</p>
pub fn peer_vpc_aws_account_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.peer_vpc_aws_account_id(input.into());
self
}
/// <p>A unique identifier for the Amazon Web Services account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the Amazon Web Services Management Console under account settings.</p>
pub fn set_peer_vpc_aws_account_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_peer_vpc_aws_account_id(input);
self
}
/// <p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with GameLift Fleets</a>.</p>
pub fn peer_vpc_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.peer_vpc_id(input.into());
self
}
/// <p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with GameLift Fleets</a>.</p>
pub fn set_peer_vpc_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_peer_vpc_id(input);
self
}
}
/// Fluent builder constructing a request to `DeleteAlias`.
///
/// <p>Deletes an alias. This operation removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.</p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteAlias {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_alias_input::Builder,
}
impl DeleteAlias {
/// Creates a new `DeleteAlias`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteAlias,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteAliasError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteAliasOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteAliasError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier of the alias that you want to delete. You can use either the alias ID or ARN value.</p>
pub fn alias_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.alias_id(input.into());
self
}
/// <p>A unique identifier of the alias that you want to delete. You can use either the alias ID or ARN value.</p>
pub fn set_alias_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_alias_id(input);
self
}
}
/// Fluent builder constructing a request to `DeleteBuild`.
///
/// <p>Deletes a build. This operation permanently deletes the build resource and any uploaded build files. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build.</p>
/// <p>To delete a build, specify the build ID. </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html"> Upload a Custom Server Build</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteBuild {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_build_input::Builder,
}
impl DeleteBuild {
/// Creates a new `DeleteBuild`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteBuild,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteBuildError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteBuildOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteBuildError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the build to delete. You can use either the build ID or ARN value. </p>
pub fn build_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.build_id(input.into());
self
}
/// <p>A unique identifier for the build to delete. You can use either the build ID or ARN value. </p>
pub fn set_build_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_build_id(input);
self
}
}
/// Fluent builder constructing a request to `DeleteFleet`.
///
/// <p>Deletes all resources and information related a fleet. Any current fleet instances, including those in remote locations, are shut down. You don't need to call <code>DeleteFleetLocations</code> separately.</p> <note>
/// <p>If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html">CreateVpcPeeringAuthorization</a>. You do not need to explicitly delete the VPC peering connection.</p>
/// </note>
/// <p>To delete a fleet, specify the fleet ID to be terminated. During the deletion process the fleet status is changed to <code>DELETING</code>. When completed, the status switches to <code>TERMINATED</code> and the fleet event <code>FLEET_DELETED</code> is sent.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift Fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteFleet {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_fleet_input::Builder,
}
impl DeleteFleet {
/// Creates a new `DeleteFleet`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteFleet,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteFleetError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteFleetOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteFleetError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
}
/// Fluent builder constructing a request to `DeleteFleetLocations`.
///
/// <p>Removes locations from a multi-location fleet. When deleting a location, all game server process and all instances that are still active in the location are shut down. </p>
/// <p>To delete fleet locations, identify the fleet ID and provide a list of the locations to be deleted. </p>
/// <p>If successful, GameLift sets the location status to <code>DELETING</code>, and begins to shut down existing server processes and terminate instances in each location being deleted. When completed, the location status changes to <code>TERMINATED</code>.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteFleetLocations {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_fleet_locations_input::Builder,
}
impl DeleteFleetLocations {
/// Creates a new `DeleteFleetLocations`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteFleetLocations,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteFleetLocationsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteFleetLocationsOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteFleetLocationsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet to delete locations for. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to delete locations for. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// Appends an item to `Locations`.
///
/// To override the contents of this collection use [`set_locations`](Self::set_locations).
///
/// <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>
pub fn locations(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.locations(input.into());
self
}
/// <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>
pub fn set_locations(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_locations(input);
self
}
}
/// Fluent builder constructing a request to `DeleteGameServerGroup`.
///
/// <p> <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b> </p>
/// <p>Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete operation selected, this operation might affect these resources:</p>
/// <ul>
/// <li> <p>The game server group</p> </li>
/// <li> <p>The corresponding Auto Scaling group</p> </li>
/// <li> <p>All game servers that are currently running in the group</p> </li>
/// </ul>
/// <p>To delete a game server group, identify the game server group to delete and specify the type of delete operation to initiate. Game server groups can only be deleted if they are in <code>ACTIVE</code> or <code>ERROR</code> status.</p>
/// <p>If the delete request is successful, a series of operations are kicked off. The game server group status is changed to <code>DELETE_SCHEDULED</code>, which prevents new game servers from being registered and stops automatic scaling activity. Once all game servers in the game server group are deregistered, GameLift FleetIQ can begin deleting resources. If any of the delete operations fail, the game server group is placed in <code>ERROR</code> status.</p>
/// <p>GameLift FleetIQ emits delete events to Amazon CloudWatch.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ Guide</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteGameServerGroup {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_game_server_group_input::Builder,
}
impl DeleteGameServerGroup {
/// Creates a new `DeleteGameServerGroup`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteGameServerGroup,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteGameServerGroupError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteGameServerGroupOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteGameServerGroupError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
pub fn game_server_group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_group_name(input.into());
self
}
/// <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
pub fn set_game_server_group_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_group_name(input);
self
}
/// <p>The type of delete to perform. Options include the following:</p>
/// <ul>
/// <li> <p> <code>SAFE_DELETE</code> – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in <code>UTILIZED</code> status.</p> </li>
/// <li> <p> <code>FORCE_DELETE</code> – Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group. </p> </li>
/// <li> <p> <code>RETAIN</code> – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is.</p> </li>
/// </ul>
pub fn delete_option(mut self, input: crate::model::GameServerGroupDeleteOption) -> Self {
self.inner = self.inner.delete_option(input);
self
}
/// <p>The type of delete to perform. Options include the following:</p>
/// <ul>
/// <li> <p> <code>SAFE_DELETE</code> – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in <code>UTILIZED</code> status.</p> </li>
/// <li> <p> <code>FORCE_DELETE</code> – Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group. </p> </li>
/// <li> <p> <code>RETAIN</code> – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is.</p> </li>
/// </ul>
pub fn set_delete_option(
mut self,
input: std::option::Option<crate::model::GameServerGroupDeleteOption>,
) -> Self {
self.inner = self.inner.set_delete_option(input);
self
}
}
/// Fluent builder constructing a request to `DeleteGameSessionQueue`.
///
/// <p>Deletes a game session queue. Once a queue is successfully deleted, unfulfilled <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html">StartGameSessionPlacement</a> requests that reference the queue will fail. To delete a queue, specify the queue name.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteGameSessionQueue {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_game_session_queue_input::Builder,
}
impl DeleteGameSessionQueue {
/// Creates a new `DeleteGameSessionQueue`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteGameSessionQueue,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteGameSessionQueueError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteGameSessionQueueOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteGameSessionQueueError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value. </p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value. </p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
}
/// Fluent builder constructing a request to `DeleteLocation`.
///
/// <p>Deletes a custom location.</p>
/// <p>Before deleting a custom location, review any fleets currently using the custom location and deregister the location if it is in use. For more information see, <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeregisterCompute.html">DeregisterCompute</a>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteLocation {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_location_input::Builder,
}
impl DeleteLocation {
/// Creates a new `DeleteLocation`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteLocation,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteLocationError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteLocationOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteLocationError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The location name of the custom location to be deleted.</p>
pub fn location_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.location_name(input.into());
self
}
/// <p>The location name of the custom location to be deleted.</p>
pub fn set_location_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_location_name(input);
self
}
}
/// Fluent builder constructing a request to `DeleteMatchmakingConfiguration`.
///
/// <p>Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is being used in any active matchmaking tickets.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteMatchmakingConfiguration {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_matchmaking_configuration_input::Builder,
}
impl DeleteMatchmakingConfiguration {
/// Creates a new `DeleteMatchmakingConfiguration`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteMatchmakingConfiguration,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteMatchmakingConfigurationError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteMatchmakingConfigurationOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteMatchmakingConfigurationError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the matchmaking configuration. You can use either the configuration name or ARN value.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A unique identifier for the matchmaking configuration. You can use either the configuration name or ARN value.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
}
/// Fluent builder constructing a request to `DeleteMatchmakingRuleSet`.
///
/// <p>Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration. </p>
/// <p> <b>Learn more</b> </p>
/// <ul>
/// <li> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html">Build a rule set</a> </p> </li>
/// </ul>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteMatchmakingRuleSet {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_matchmaking_rule_set_input::Builder,
}
impl DeleteMatchmakingRuleSet {
/// Creates a new `DeleteMatchmakingRuleSet`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteMatchmakingRuleSet,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteMatchmakingRuleSetError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteMatchmakingRuleSetOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteMatchmakingRuleSetError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the matchmaking rule set to be deleted. (Note: The rule set name is different from the optional "name" field in the rule set body.) You can use either the rule set name or ARN value.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A unique identifier for the matchmaking rule set to be deleted. (Note: The rule set name is different from the optional "name" field in the rule set body.) You can use either the rule set name or ARN value.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
}
/// Fluent builder constructing a request to `DeleteScalingPolicy`.
///
/// <p>Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and GameLift removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.</p>
/// <p>To temporarily suspend scaling policies, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html">StopFleetActions</a>. This operation suspends all policies for the fleet.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteScalingPolicy {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_scaling_policy_input::Builder,
}
impl DeleteScalingPolicy {
/// Creates a new `DeleteScalingPolicy`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteScalingPolicy,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteScalingPolicyError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteScalingPolicyOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteScalingPolicyError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
}
/// Fluent builder constructing a request to `DeleteScript`.
///
/// <p>Deletes a Realtime script. This operation permanently deletes the script record. If script files were uploaded, they are also deleted (files stored in an S3 bucket are not deleted). </p>
/// <p>To delete a script, specify the script ID. Before deleting a script, be sure to terminate all fleets that are deployed with the script being deleted. Fleet instances periodically check for script updates, and if the script record no longer exists, the instance will go into an error state and be unable to host game sessions.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a> </p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteScript {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_script_input::Builder,
}
impl DeleteScript {
/// Creates a new `DeleteScript`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteScript,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteScriptError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteScriptOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteScriptError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the Realtime script to delete. You can use either the script ID or ARN value.</p>
pub fn script_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.script_id(input.into());
self
}
/// <p>A unique identifier for the Realtime script to delete. You can use either the script ID or ARN value.</p>
pub fn set_script_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_script_id(input);
self
}
}
/// Fluent builder constructing a request to `DeleteVpcPeeringAuthorization`.
///
/// <p>Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteVpcPeeringConnection.html">DeleteVpcPeeringConnection</a>.</p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteVpcPeeringAuthorization {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_vpc_peering_authorization_input::Builder,
}
impl DeleteVpcPeeringAuthorization {
/// Creates a new `DeleteVpcPeeringAuthorization`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteVpcPeeringAuthorization,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteVpcPeeringAuthorizationError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteVpcPeeringAuthorizationOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteVpcPeeringAuthorizationError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.</p>
pub fn game_lift_aws_account_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_lift_aws_account_id(input.into());
self
}
/// <p>A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet. You can find your Account ID in the Amazon Web Services Management Console under account settings.</p>
pub fn set_game_lift_aws_account_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_lift_aws_account_id(input);
self
}
/// <p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with GameLift Fleets</a>.</p>
pub fn peer_vpc_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.peer_vpc_id(input.into());
self
}
/// <p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with GameLift Fleets</a>.</p>
pub fn set_peer_vpc_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_peer_vpc_id(input);
self
}
}
/// Fluent builder constructing a request to `DeleteVpcPeeringConnection`.
///
/// <p>Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete.. </p>
/// <p>Once a valid authorization exists, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed. </p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeleteVpcPeeringConnection {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::delete_vpc_peering_connection_input::Builder,
}
impl DeleteVpcPeeringConnection {
/// Creates a new `DeleteVpcPeeringConnection`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeleteVpcPeeringConnection,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeleteVpcPeeringConnectionError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeleteVpcPeeringConnectionOutput,
aws_smithy_http::result::SdkError<crate::error::DeleteVpcPeeringConnectionError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet. This fleet specified must match the fleet referenced in the VPC peering connection record. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet. This fleet specified must match the fleet referenced in the VPC peering connection record. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>A unique identifier for a VPC peering connection.</p>
pub fn vpc_peering_connection_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.vpc_peering_connection_id(input.into());
self
}
/// <p>A unique identifier for a VPC peering connection.</p>
pub fn set_vpc_peering_connection_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_vpc_peering_connection_id(input);
self
}
}
/// Fluent builder constructing a request to `DeregisterCompute`.
///
/// <p>Removes a compute resource from the specified fleet. Deregister your compute resources before you delete the compute.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeregisterCompute {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::deregister_compute_input::Builder,
}
impl DeregisterCompute {
/// Creates a new `DeregisterCompute`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeregisterCompute,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeregisterComputeError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeregisterComputeOutput,
aws_smithy_http::result::SdkError<crate::error::DeregisterComputeError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>>A unique identifier for the fleet the compute resource is registered to.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>>A unique identifier for the fleet the compute resource is registered to.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>The name of the compute resource you want to delete.</p>
pub fn compute_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.compute_name(input.into());
self
}
/// <p>The name of the compute resource you want to delete.</p>
pub fn set_compute_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_compute_name(input);
self
}
}
/// Fluent builder constructing a request to `DeregisterGameServer`.
///
/// <p> <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b> </p>
/// <p>Removes the game server from a game server group. As a result of this operation, the deregistered game server can no longer be claimed and will not be returned in a list of active game servers. </p>
/// <p>To deregister a game server, specify the game server group and game server ID. If successful, this operation emits a CloudWatch event with termination timestamp and reason.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ Guide</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DeregisterGameServer {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::deregister_game_server_input::Builder,
}
impl DeregisterGameServer {
/// Creates a new `DeregisterGameServer`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DeregisterGameServer,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DeregisterGameServerError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DeregisterGameServerOutput,
aws_smithy_http::result::SdkError<crate::error::DeregisterGameServerError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the game server group where the game server is running.</p>
pub fn game_server_group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_group_name(input.into());
self
}
/// <p>A unique identifier for the game server group where the game server is running.</p>
pub fn set_game_server_group_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_group_name(input);
self
}
/// <p>A custom string that uniquely identifies the game server to deregister.</p>
pub fn game_server_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_id(input.into());
self
}
/// <p>A custom string that uniquely identifies the game server to deregister.</p>
pub fn set_game_server_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_id(input);
self
}
}
/// Fluent builder constructing a request to `DescribeAlias`.
///
/// <p>Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use <code>ResolveAlias</code>. </p>
/// <p>To get alias properties, specify the alias ID. If successful, the requested alias record is returned.</p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeAlias {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_alias_input::Builder,
}
impl DescribeAlias {
/// Creates a new `DescribeAlias`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeAlias,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeAliasError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeAliasOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeAliasError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN value. </p>
pub fn alias_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.alias_id(input.into());
self
}
/// <p>The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN value. </p>
pub fn set_alias_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_alias_id(input);
self
}
}
/// Fluent builder constructing a request to `DescribeBuild`.
///
/// <p>Retrieves properties for a custom game build. To request a build resource, specify a build ID. If successful, an object containing the build properties is returned.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html"> Upload a Custom Server Build</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeBuild {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_build_input::Builder,
}
impl DescribeBuild {
/// Creates a new `DescribeBuild`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeBuild,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeBuildError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeBuildOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeBuildError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the build to retrieve properties for. You can use either the build ID or ARN value. </p>
pub fn build_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.build_id(input.into());
self
}
/// <p>A unique identifier for the build to retrieve properties for. You can use either the build ID or ARN value. </p>
pub fn set_build_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_build_id(input);
self
}
}
/// Fluent builder constructing a request to `DescribeCompute`.
///
/// <p>Retrieves properties for a compute resource. To request a compute resource specify the fleet ID and compute name. If successful, GameLift returns an object containing the build properties.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeCompute {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_compute_input::Builder,
}
impl DescribeCompute {
/// Creates a new `DescribeCompute`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeCompute,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeComputeError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeComputeOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeComputeError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet the compute is registered to.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet the compute is registered to.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>A descriptive label that is associated with the compute resource registered to your fleet.</p>
pub fn compute_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.compute_name(input.into());
self
}
/// <p>A descriptive label that is associated with the compute resource registered to your fleet.</p>
pub fn set_compute_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_compute_name(input);
self
}
}
/// Fluent builder constructing a request to `DescribeEC2InstanceLimits`.
///
/// <p>Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per instance type, per location, that your Amazon Web Services account can use. Learn more at <a href="http://aws.amazon.com/ec2/instance-types/">Amazon EC2 Instance Types</a>. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your GameLift fleets. You can request a limit increase for your account by using the <b>Service limits</b> page in the GameLift console.</p>
/// <p>Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an Amazon Web Services Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results: </p>
/// <ul>
/// <li> <p>Request specifies the Region <code>ap-northeast-1</code> with no location. The result is limits and usage data on all instance types that are deployed in <code>us-east-2</code>, by all of the fleets that reside in <code>ap-northeast-1</code>. </p> </li>
/// <li> <p>Request specifies the Region <code>us-east-1</code> with location <code>ca-central-1</code>. The result is limits and usage data on all instance types that are deployed in <code>ca-central-1</code>, by all of the fleets that reside in <code>us-east-2</code>. These limits do not affect fleets in any other Regions that deploy instances to <code>ca-central-1</code>.</p> </li>
/// <li> <p>Request specifies the Region <code>eu-west-1</code> with location <code>ca-central-1</code>. The result is limits and usage data on all instance types that are deployed in <code>ca-central-1</code>, by all of the fleets that reside in <code>eu-west-1</code>.</p> </li>
/// </ul>
/// <p>This operation can be used in the following ways:</p>
/// <ul>
/// <li> <p>To get limit and usage data for all instance types that are deployed in an Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only. Optionally, specify a single instance type to retrieve information for.</p> </li>
/// <li> <p>To get limit and usage data for all instance types that are deployed to a remote location by fleets that reside in different Amazon Web Services Region: Provide both the Amazon Web Services Region and the remote location. Optionally, specify a single instance type to retrieve information for.</p> </li>
/// </ul>
/// <p>If successful, an <code>EC2InstanceLimits</code> object is returned with limits and usage data for each requested instance type.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeEC2InstanceLimits {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_ec2_instance_limits_input::Builder,
}
impl DescribeEC2InstanceLimits {
/// Creates a new `DescribeEC2InstanceLimits`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeEC2InstanceLimits,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeEC2InstanceLimitsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeEc2InstanceLimitsOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeEC2InstanceLimitsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>Name of an Amazon EC2 instance type that is supported in GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Do not specify a value for this parameter to retrieve limits for all instance types.</p>
pub fn ec2_instance_type(mut self, input: crate::model::Ec2InstanceType) -> Self {
self.inner = self.inner.ec2_instance_type(input);
self
}
/// <p>Name of an Amazon EC2 instance type that is supported in GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Do not specify a value for this parameter to retrieve limits for all instance types.</p>
pub fn set_ec2_instance_type(
mut self,
input: std::option::Option<crate::model::Ec2InstanceType>,
) -> Self {
self.inner = self.inner.set_ec2_instance_type(input);
self
}
/// <p>The name of a remote location to request instance limits for, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>.</p>
pub fn location(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.location(input.into());
self
}
/// <p>The name of a remote location to request instance limits for, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>.</p>
pub fn set_location(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_location(input);
self
}
}
/// Fluent builder constructing a request to `DescribeFleetAttributes`.
///
/// <p>Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all instances in the fleet.</p>
/// <p>This operation can be used in the following ways: </p>
/// <ul>
/// <li> <p>To get attributes for one or more specific fleets, provide a list of fleet IDs or fleet ARNs. </p> </li>
/// <li> <p>To get attributes for all fleets, do not provide a fleet identifier. </p> </li>
/// </ul>
/// <p>When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. </p>
/// <p>If successful, a <code>FleetAttributes</code> object is returned for each fleet requested, unless the fleet identifier is not found. </p> <note>
/// <p>Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.</p>
/// </note>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeFleetAttributes {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_fleet_attributes_input::Builder,
}
impl DescribeFleetAttributes {
/// Creates a new `DescribeFleetAttributes`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeFleetAttributes,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeFleetAttributesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeFleetAttributesOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeFleetAttributesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::DescribeFleetAttributesPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::DescribeFleetAttributesPaginator {
crate::paginator::DescribeFleetAttributesPaginator::new(self.handle, self.inner)
}
/// Appends an item to `FleetIds`.
///
/// To override the contents of this collection use [`set_fleet_ids`](Self::set_fleet_ids).
///
/// <p>A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. </p>
pub fn fleet_ids(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_ids(input.into());
self
}
/// <p>A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. </p>
pub fn set_fleet_ids(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_fleet_ids(input);
self
}
/// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `DescribeFleetCapacity`.
///
/// <p>Retrieves the resource capacity settings for one or more fleets. The data returned includes the current fleet capacity (number of EC2 instances), and settings that can control how capacity scaling. For fleets with remote locations, this operation retrieves data for the fleet's home Region only.</p>
/// <p>This operation can be used in the following ways: </p>
/// <ul>
/// <li> <p>To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs. </p> </li>
/// <li> <p>To get capacity data for all fleets, do not provide a fleet identifier. </p> </li>
/// </ul>
/// <p>When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. </p>
/// <p>If successful, a <code>FleetCapacity</code> object is returned for each requested fleet ID. Each FleetCapacity object includes a <code>Location</code> property, which is set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects are returned only for fleets that currently exist.</p> <note>
/// <p>Some API operations may limit the number of fleet IDs that are allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.</p>
/// </note>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift fleets</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift metrics for fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeFleetCapacity {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_fleet_capacity_input::Builder,
}
impl DescribeFleetCapacity {
/// Creates a new `DescribeFleetCapacity`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeFleetCapacity,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeFleetCapacityError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeFleetCapacityOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeFleetCapacityError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::DescribeFleetCapacityPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::DescribeFleetCapacityPaginator {
crate::paginator::DescribeFleetCapacityPaginator::new(self.handle, self.inner)
}
/// Appends an item to `FleetIds`.
///
/// To override the contents of this collection use [`set_fleet_ids`](Self::set_fleet_ids).
///
/// <p>A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.</p>
pub fn fleet_ids(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_ids(input.into());
self
}
/// <p>A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.</p>
pub fn set_fleet_ids(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_fleet_ids(input);
self
}
/// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `DescribeFleetEvents`.
///
/// <p>Retrieves entries from a fleet's event log. Fleet events are initiated by changes in status, such as during fleet creation and termination, changes in capacity, etc. If a fleet has multiple locations, events are also initiated by changes to status and capacity in remote locations. </p>
/// <p>You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. </p>
/// <p>If successful, a collection of event log entries matching the request are returned.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeFleetEvents {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_fleet_events_input::Builder,
}
impl DescribeFleetEvents {
/// Creates a new `DescribeFleetEvents`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeFleetEvents,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeFleetEventsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeFleetEventsOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeFleetEventsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::DescribeFleetEventsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::DescribeFleetEventsPaginator {
crate::paginator::DescribeFleetEventsPaginator::new(self.handle, self.inner)
}
/// <p>A unique identifier for the fleet to get event logs for. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to get event logs for. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>The earliest date to retrieve event logs for. If no start time is specified, this call returns entries starting from when the fleet was created to the specified end time. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").</p>
pub fn start_time(mut self, input: aws_smithy_types::DateTime) -> Self {
self.inner = self.inner.start_time(input);
self
}
/// <p>The earliest date to retrieve event logs for. If no start time is specified, this call returns entries starting from when the fleet was created to the specified end time. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").</p>
pub fn set_start_time(
mut self,
input: std::option::Option<aws_smithy_types::DateTime>,
) -> Self {
self.inner = self.inner.set_start_time(input);
self
}
/// <p>The most recent date to retrieve event logs for. If no end time is specified, this call returns entries from the specified start time up to the present. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").</p>
pub fn end_time(mut self, input: aws_smithy_types::DateTime) -> Self {
self.inner = self.inner.end_time(input);
self
}
/// <p>The most recent date to retrieve event logs for. If no end time is specified, this call returns entries from the specified start time up to the present. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").</p>
pub fn set_end_time(
mut self,
input: std::option::Option<aws_smithy_types::DateTime>,
) -> Self {
self.inner = self.inner.set_end_time(input);
self
}
/// <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>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <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>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `DescribeFleetLocationAttributes`.
///
/// <p>Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity. </p>
/// <p>This operation can be used in the following ways: </p>
/// <ul>
/// <li> <p>To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested. </p> </li>
/// <li> <p>To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order. </p> </li>
/// </ul>
/// <p>When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages. </p>
/// <p>If successful, a <code>LocationAttributes</code> object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, call <code>DescribeFleetAttributes</code>.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeFleetLocationAttributes {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_fleet_location_attributes_input::Builder,
}
impl DescribeFleetLocationAttributes {
/// Creates a new `DescribeFleetLocationAttributes`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeFleetLocationAttributes,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeFleetLocationAttributesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeFleetLocationAttributesOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeFleetLocationAttributesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::DescribeFleetLocationAttributesPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::DescribeFleetLocationAttributesPaginator {
crate::paginator::DescribeFleetLocationAttributesPaginator::new(self.handle, self.inner)
}
/// <p>A unique identifier for the fleet to retrieve remote locations for. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to retrieve remote locations for. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// Appends an item to `Locations`.
///
/// To override the contents of this collection use [`set_locations`](Self::set_locations).
///
/// <p>A list of fleet locations to retrieve information for. Specify locations in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
pub fn locations(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.locations(input.into());
self
}
/// <p>A list of fleet locations to retrieve information for. Specify locations in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
pub fn set_locations(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_locations(input);
self
}
/// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This limit is not currently enforced.</p>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This limit is not currently enforced.</p>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `DescribeFleetLocationCapacity`.
///
/// <p>Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling <code>DescribeFleetCapacity</code>).</p>
/// <p>To retrieve capacity data, identify a fleet and location. </p>
/// <p>If successful, a <code>FleetCapacity</code> object is returned for the requested fleet location. </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift fleets</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift metrics for fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeFleetLocationCapacity {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_fleet_location_capacity_input::Builder,
}
impl DescribeFleetLocationCapacity {
/// Creates a new `DescribeFleetLocationCapacity`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeFleetLocationCapacity,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeFleetLocationCapacityError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeFleetLocationCapacityOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeFleetLocationCapacityError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet to request location capacity for. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to request location capacity for. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>The fleet location to retrieve capacity information for. Specify a location in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
pub fn location(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.location(input.into());
self
}
/// <p>The fleet location to retrieve capacity information for. Specify a location in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
pub fn set_location(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_location(input);
self
}
}
/// Fluent builder constructing a request to `DescribeFleetLocationUtilization`.
///
/// <p>Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this operation to retrieve utilization information for a fleet's remote location or home Region (you can also retrieve home Region utilization by calling <code>DescribeFleetUtilization</code>).</p>
/// <p>To retrieve utilization data, identify a fleet and location. </p>
/// <p>If successful, a <code>FleetUtilization</code> object is returned for the requested fleet location. </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift fleets</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift metrics for fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeFleetLocationUtilization {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_fleet_location_utilization_input::Builder,
}
impl DescribeFleetLocationUtilization {
/// Creates a new `DescribeFleetLocationUtilization`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeFleetLocationUtilization,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeFleetLocationUtilizationError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeFleetLocationUtilizationOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeFleetLocationUtilizationError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet to request location utilization for. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to request location utilization for. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>The fleet location to retrieve utilization information for. Specify a location in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
pub fn location(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.location(input.into());
self
}
/// <p>The fleet location to retrieve utilization information for. Specify a location in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
pub fn set_location(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_location(input);
self
}
}
/// Fluent builder constructing a request to `DescribeFleetPortSettings`.
///
/// <p>Retrieves a fleet's inbound connection permissions. Connection permissions specify the range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game sessions that are running on instances in the fleet must use connections that fall in this range.</p>
/// <p>This operation can be used in the following ways: </p>
/// <ul>
/// <li> <p>To retrieve the inbound connection permissions for a fleet, identify the fleet's unique identifier. </p> </li>
/// <li> <p>To check the status of recent updates to a fleet remote location, specify the fleet ID and a location. Port setting updates can take time to propagate across all locations. </p> </li>
/// </ul>
/// <p>If successful, a set of <code>IpPermission</code> objects is returned for the requested fleet ID. When a location is specified, a pending status is included. If the requested fleet has been deleted, the result set is empty.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeFleetPortSettings {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_fleet_port_settings_input::Builder,
}
impl DescribeFleetPortSettings {
/// Creates a new `DescribeFleetPortSettings`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeFleetPortSettings,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeFleetPortSettingsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeFleetPortSettingsOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeFleetPortSettingsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet to retrieve port settings for. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to retrieve port settings for. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>A remote location to check for status of port setting updates. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>.</p>
pub fn location(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.location(input.into());
self
}
/// <p>A remote location to check for status of port setting updates. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>.</p>
pub fn set_location(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_location(input);
self
}
}
/// Fluent builder constructing a request to `DescribeFleetUtilization`.
///
/// <p>Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationUtilization.html">DescribeFleetLocationUtilization</a> to get utilization statistics for a fleet's remote locations.</p>
/// <p>This operation can be used in the following ways: </p>
/// <ul>
/// <li> <p>To get utilization data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs. </p> </li>
/// <li> <p>To get utilization data for all fleets, do not provide a fleet identifier. </p> </li>
/// </ul>
/// <p>When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. </p>
/// <p>If successful, a <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_FleetUtilization.html">FleetUtilization</a> object is returned for each requested fleet ID, unless the fleet identifier is not found. Each fleet utilization object includes a <code>Location</code> property, which is set to the fleet's home Region. </p> <note>
/// <p>Some API operations may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.</p>
/// </note>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift Fleets</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift Metrics for Fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeFleetUtilization {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_fleet_utilization_input::Builder,
}
impl DescribeFleetUtilization {
/// Creates a new `DescribeFleetUtilization`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeFleetUtilization,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeFleetUtilizationError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeFleetUtilizationOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeFleetUtilizationError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::DescribeFleetUtilizationPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::DescribeFleetUtilizationPaginator {
crate::paginator::DescribeFleetUtilizationPaginator::new(self.handle, self.inner)
}
/// Appends an item to `FleetIds`.
///
/// To override the contents of this collection use [`set_fleet_ids`](Self::set_fleet_ids).
///
/// <p>A unique identifier for the fleet to retrieve utilization data for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. </p>
pub fn fleet_ids(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_ids(input.into());
self
}
/// <p>A unique identifier for the fleet to retrieve utilization data for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. </p>
pub fn set_fleet_ids(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_fleet_ids(input);
self
}
/// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `DescribeGameServer`.
///
/// <p> <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b> </p>
/// <p>Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on. </p>
/// <p>To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned. </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ Guide</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeGameServer {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_game_server_input::Builder,
}
impl DescribeGameServer {
/// Creates a new `DescribeGameServer`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeGameServer,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeGameServerError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeGameServerOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeGameServerError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the game server group where the game server is running.</p>
pub fn game_server_group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_group_name(input.into());
self
}
/// <p>A unique identifier for the game server group where the game server is running.</p>
pub fn set_game_server_group_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_group_name(input);
self
}
/// <p>A custom string that uniquely identifies the game server information to be retrieved.</p>
pub fn game_server_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_id(input.into());
self
}
/// <p>A custom string that uniquely identifies the game server information to be retrieved.</p>
pub fn set_game_server_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_id(input);
self
}
}
/// Fluent builder constructing a request to `DescribeGameServerGroup`.
///
/// <p> <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b> </p>
/// <p>Retrieves information on a game server group. This operation returns only properties related to GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group, such as launch template, auto scaling policies, and maximum/minimum group size, access the Auto Scaling group directly.</p>
/// <p>To get attributes for a game server group, provide a group name or ARN value. If successful, a <code>GameServerGroup</code> object is returned.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ Guide</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeGameServerGroup {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_game_server_group_input::Builder,
}
impl DescribeGameServerGroup {
/// Creates a new `DescribeGameServerGroup`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeGameServerGroup,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeGameServerGroupError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeGameServerGroupOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeGameServerGroupError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
pub fn game_server_group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_group_name(input.into());
self
}
/// <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
pub fn set_game_server_group_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_group_name(input);
self
}
}
/// Fluent builder constructing a request to `DescribeGameServerInstances`.
///
/// <p> <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b> </p>
/// <p>Retrieves status information about the Amazon EC2 instances associated with a GameLift FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers.</p>
/// <p>To request status for all instances in the game server group, provide a game server group ID only. To request status for specific instances, provide the game server group ID and one or more instance IDs. Use the pagination parameters to retrieve results in sequential segments. If successful, a collection of <code>GameServerInstance</code> objects is returned. </p>
/// <p>This operation is not designed to be called with every game server claim request; this practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, cache the results and refresh your cache no more than once every 10 seconds.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ Guide</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeGameServerInstances {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_game_server_instances_input::Builder,
}
impl DescribeGameServerInstances {
/// Creates a new `DescribeGameServerInstances`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeGameServerInstances,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeGameServerInstancesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeGameServerInstancesOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeGameServerInstancesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::DescribeGameServerInstancesPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::DescribeGameServerInstancesPaginator {
crate::paginator::DescribeGameServerInstancesPaginator::new(self.handle, self.inner)
}
/// <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
pub fn game_server_group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_group_name(input.into());
self
}
/// <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
pub fn set_game_server_group_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_group_name(input);
self
}
/// Appends an item to `InstanceIds`.
///
/// To override the contents of this collection use [`set_instance_ids`](Self::set_instance_ids).
///
/// <p>The Amazon EC2 instance IDs that you want to retrieve status on. Amazon EC2 instance IDs use a 17-character format, for example: <code>i-1234567890abcdef0</code>. To retrieve all instances in the game server group, leave this parameter empty. </p>
pub fn instance_ids(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.instance_ids(input.into());
self
}
/// <p>The Amazon EC2 instance IDs that you want to retrieve status on. Amazon EC2 instance IDs use a 17-character format, for example: <code>i-1234567890abcdef0</code>. To retrieve all instances in the game server group, leave this parameter empty. </p>
pub fn set_instance_ids(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_instance_ids(input);
self
}
/// <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>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <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>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `DescribeGameSessionDetails`.
///
/// <p>Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status.</p>
/// <p>This operation can be used in the following ways: </p>
/// <ul>
/// <li> <p>To retrieve details for all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns details from the fleet's home Region and all remote locations.</p> </li>
/// <li> <p>To retrieve details for all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.</p> </li>
/// <li> <p>To retrieve details for a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.</p> </li>
/// </ul>
/// <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
/// <p>If successful, a <code>GameSessionDetail</code> object is returned for each game session that matches the request.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find">Find a game session</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeGameSessionDetails {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_game_session_details_input::Builder,
}
impl DescribeGameSessionDetails {
/// Creates a new `DescribeGameSessionDetails`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeGameSessionDetails,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeGameSessionDetailsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeGameSessionDetailsOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeGameSessionDetailsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::DescribeGameSessionDetailsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::DescribeGameSessionDetailsPaginator {
crate::paginator::DescribeGameSessionDetailsPaginator::new(self.handle, self.inner)
}
/// <p>A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>A unique identifier for the game session to retrieve. </p>
pub fn game_session_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_session_id(input.into());
self
}
/// <p>A unique identifier for the game session to retrieve. </p>
pub fn set_game_session_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_session_id(input);
self
}
/// <p>A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.</p>
pub fn alias_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.alias_id(input.into());
self
}
/// <p>A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.</p>
pub fn set_alias_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_alias_id(input);
self
}
/// <p>A fleet location to get game session details for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>. </p>
pub fn location(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.location(input.into());
self
}
/// <p>A fleet location to get game session details for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>. </p>
pub fn set_location(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_location(input);
self
}
/// <p>Game session status to filter results on. Possible game session statuses include <code>ACTIVE</code>, <code>TERMINATED</code>, <code>ACTIVATING</code> and <code>TERMINATING</code> (the last two are transitory). </p>
pub fn status_filter(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.status_filter(input.into());
self
}
/// <p>Game session status to filter results on. Possible game session statuses include <code>ACTIVE</code>, <code>TERMINATED</code>, <code>ACTIVATING</code> and <code>TERMINATING</code> (the last two are transitory). </p>
pub fn set_status_filter(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_status_filter(input);
self
}
/// <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>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <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>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `DescribeGameSessionPlacement`.
///
/// <p>Retrieves information, including current status, about a game session placement request. </p>
/// <p>To get game session placement details, specify the placement ID.</p>
/// <p>This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with <code>DescribeGameSessionPlacement</code> should only be used for games in development with low game session usage. </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeGameSessionPlacement {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_game_session_placement_input::Builder,
}
impl DescribeGameSessionPlacement {
/// Creates a new `DescribeGameSessionPlacement`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeGameSessionPlacement,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeGameSessionPlacementError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeGameSessionPlacementOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeGameSessionPlacementError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for a game session placement to retrieve.</p>
pub fn placement_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.placement_id(input.into());
self
}
/// <p>A unique identifier for a game session placement to retrieve.</p>
pub fn set_placement_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_placement_id(input);
self
}
}
/// Fluent builder constructing a request to `DescribeGameSessionQueues`.
///
/// <p>Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-console.html"> View Your Queues</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeGameSessionQueues {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_game_session_queues_input::Builder,
}
impl DescribeGameSessionQueues {
/// Creates a new `DescribeGameSessionQueues`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeGameSessionQueues,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeGameSessionQueuesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeGameSessionQueuesOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeGameSessionQueuesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::DescribeGameSessionQueuesPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::DescribeGameSessionQueuesPaginator {
crate::paginator::DescribeGameSessionQueuesPaginator::new(self.handle, self.inner)
}
/// Appends an item to `Names`.
///
/// To override the contents of this collection use [`set_names`](Self::set_names).
///
/// <p>A list of queue names to retrieve information for. You can use either the queue ID or ARN value. To request settings for all queues, leave this parameter empty. </p>
pub fn names(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.names(input.into());
self
}
/// <p>A list of queue names to retrieve information for. You can use either the queue ID or ARN value. To request settings for all queues, leave this parameter empty. </p>
pub fn set_names(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_names(input);
self
}
/// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. You can request up to 50 results.</p>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. You can request up to 50 results.</p>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `DescribeGameSessions`.
///
/// <p>Retrieves a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status.</p>
/// <p>This operation can be used in the following ways: </p>
/// <ul>
/// <li> <p>To retrieve all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns all game sessions in the fleet's home Region and all remote locations.</p> </li>
/// <li> <p>To retrieve all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.</p> </li>
/// <li> <p>To retrieve a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.</p> </li>
/// </ul>
/// <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
/// <p>If successful, a <code>GameSession</code> object is returned for each game session that matches the request.</p>
/// <p>This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with <code>DescribeGameSessions</code> should only be used for games in development with low game session usage. </p>
/// <p> <i>Available in Amazon GameLift Local.</i> </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find">Find a game session</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeGameSessions {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_game_sessions_input::Builder,
}
impl DescribeGameSessions {
/// Creates a new `DescribeGameSessions`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeGameSessions,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeGameSessionsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeGameSessionsOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeGameSessionsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::DescribeGameSessionsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::DescribeGameSessionsPaginator {
crate::paginator::DescribeGameSessionsPaginator::new(self.handle, self.inner)
}
/// <p>A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value. </p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value. </p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>A unique identifier for the game session to retrieve. </p>
pub fn game_session_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_session_id(input.into());
self
}
/// <p>A unique identifier for the game session to retrieve. </p>
pub fn set_game_session_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_session_id(input);
self
}
/// <p>A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the alias ID or ARN value.</p>
pub fn alias_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.alias_id(input.into());
self
}
/// <p>A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the alias ID or ARN value.</p>
pub fn set_alias_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_alias_id(input);
self
}
/// <p>A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>. </p>
pub fn location(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.location(input.into());
self
}
/// <p>A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>. </p>
pub fn set_location(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_location(input);
self
}
/// <p>Game session status to filter results on. You can filter on the following states: <code>ACTIVE</code>, <code>TERMINATED</code>, <code>ACTIVATING</code>, and <code>TERMINATING</code>. The last two are transitory and used for only very brief periods of time. </p>
pub fn status_filter(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.status_filter(input.into());
self
}
/// <p>Game session status to filter results on. You can filter on the following states: <code>ACTIVE</code>, <code>TERMINATED</code>, <code>ACTIVATING</code>, and <code>TERMINATING</code>. The last two are transitory and used for only very brief periods of time. </p>
pub fn set_status_filter(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_status_filter(input);
self
}
/// <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>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <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>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `DescribeInstances`.
///
/// <p>Retrieves information about a fleet's instances, including instance IDs, connection data, and status. </p>
/// <p>This operation can be used in the following ways:</p>
/// <ul>
/// <li> <p>To get information on all instances that are deployed to a fleet's home Region, provide the fleet ID.</p> </li>
/// <li> <p>To get information on all instances that are deployed to a fleet's remote location, provide the fleet ID and location name.</p> </li>
/// <li> <p>To get information on a specific instance in a fleet, provide the fleet ID and instance ID.</p> </li>
/// </ul>
/// <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
/// <p>If successful, an <code>Instance</code> object is returned for each requested instance. Instances are not returned in any particular order. </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html">Remotely Access Fleet Instances</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html">Debug Fleet Issues</a> </p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeInstances {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_instances_input::Builder,
}
impl DescribeInstances {
/// Creates a new `DescribeInstances`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeInstances,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeInstancesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeInstancesOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeInstancesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::DescribeInstancesPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::DescribeInstancesPaginator {
crate::paginator::DescribeInstancesPaginator::new(self.handle, self.inner)
}
/// <p>A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.</p>
pub fn instance_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.instance_id(input.into());
self
}
/// <p>A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.</p>
pub fn set_instance_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_instance_id(input);
self
}
/// <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>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <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>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <p>The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>. </p>
pub fn location(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.location(input.into());
self
}
/// <p>The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>. </p>
pub fn set_location(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_location(input);
self
}
}
/// Fluent builder constructing a request to `DescribeMatchmaking`.
///
/// <p>Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection information for the resulting new game session. </p>
/// <p>To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.</p>
/// <p>This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration.</p>
/// <p></p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html"> Add FlexMatch to a game client</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Set Up FlexMatch event notification</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeMatchmaking {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_matchmaking_input::Builder,
}
impl DescribeMatchmaking {
/// Creates a new `DescribeMatchmaking`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeMatchmaking,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeMatchmakingError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeMatchmakingOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeMatchmakingError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Appends an item to `TicketIds`.
///
/// To override the contents of this collection use [`set_ticket_ids`](Self::set_ticket_ids).
///
/// <p>A unique identifier for a matchmaking ticket. You can include up to 10 ID values. </p>
pub fn ticket_ids(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.ticket_ids(input.into());
self
}
/// <p>A unique identifier for a matchmaking ticket. You can include up to 10 ID values. </p>
pub fn set_ticket_ids(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_ticket_ids(input);
self
}
}
/// Fluent builder constructing a request to `DescribeMatchmakingConfigurations`.
///
/// <p>Retrieves the details of FlexMatch matchmaking configurations. </p>
/// <p>This operation offers the following options: (1) retrieve all matchmaking configurations, (2) retrieve configurations for a specified list, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. </p>
/// <p>If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned. </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/matchmaker-build.html"> Setting up FlexMatch matchmakers</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeMatchmakingConfigurations {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_matchmaking_configurations_input::Builder,
}
impl DescribeMatchmakingConfigurations {
/// Creates a new `DescribeMatchmakingConfigurations`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeMatchmakingConfigurations,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeMatchmakingConfigurationsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeMatchmakingConfigurationsOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeMatchmakingConfigurationsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::DescribeMatchmakingConfigurationsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(
self,
) -> crate::paginator::DescribeMatchmakingConfigurationsPaginator {
crate::paginator::DescribeMatchmakingConfigurationsPaginator::new(
self.handle,
self.inner,
)
}
/// Appends an item to `Names`.
///
/// To override the contents of this collection use [`set_names`](Self::set_names).
///
/// <p>A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration name or ARN value. To request all existing configurations, leave this parameter empty.</p>
pub fn names(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.names(input.into());
self
}
/// <p>A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration name or ARN value. To request all existing configurations, leave this parameter empty.</p>
pub fn set_names(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_names(input);
self
}
/// <p>A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use this parameter to retrieve all matchmaking configurations that use this rule set.</p>
pub fn rule_set_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.rule_set_name(input.into());
self
}
/// <p>A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use this parameter to retrieve all matchmaking configurations that use this rule set.</p>
pub fn set_rule_set_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_rule_set_name(input);
self
}
/// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This parameter is limited to 10.</p>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This parameter is limited to 10.</p>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `DescribeMatchmakingRuleSets`.
///
/// <p>Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the Region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name. </p>
/// <p> <b>Learn more</b> </p>
/// <ul>
/// <li> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html">Build a rule set</a> </p> </li>
/// </ul>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeMatchmakingRuleSets {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_matchmaking_rule_sets_input::Builder,
}
impl DescribeMatchmakingRuleSets {
/// Creates a new `DescribeMatchmakingRuleSets`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeMatchmakingRuleSets,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeMatchmakingRuleSetsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeMatchmakingRuleSetsOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeMatchmakingRuleSetsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::DescribeMatchmakingRuleSetsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::DescribeMatchmakingRuleSetsPaginator {
crate::paginator::DescribeMatchmakingRuleSetsPaginator::new(self.handle, self.inner)
}
/// Appends an item to `Names`.
///
/// To override the contents of this collection use [`set_names`](Self::set_names).
///
/// <p>A list of one or more matchmaking rule set names to retrieve details for. (Note: The rule set name is different from the optional "name" field in the rule set body.) You can use either the rule set name or ARN value. </p>
pub fn names(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.names(input.into());
self
}
/// <p>A list of one or more matchmaking rule set names to retrieve details for. (Note: The rule set name is different from the optional "name" field in the rule set body.) You can use either the rule set name or ARN value. </p>
pub fn set_names(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_names(input);
self
}
/// <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>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <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>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `DescribePlayerSessions`.
///
/// <p>Retrieves properties for one or more player sessions. </p>
/// <p>This action can be used in the following ways: </p>
/// <ul>
/// <li> <p>To retrieve a specific player session, provide the player session ID only.</p> </li>
/// <li> <p>To retrieve all player sessions in a game session, provide the game session ID only.</p> </li>
/// <li> <p>To retrieve all player sessions for a specific player, provide a player ID only.</p> </li>
/// </ul>
/// <p>To request player sessions, specify either a player session ID, game session ID, or player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. </p>
/// <p>If successful, a <code>PlayerSession</code> object is returned for each session that matches the request.</p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribePlayerSessions {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_player_sessions_input::Builder,
}
impl DescribePlayerSessions {
/// Creates a new `DescribePlayerSessions`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribePlayerSessions,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribePlayerSessionsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribePlayerSessionsOutput,
aws_smithy_http::result::SdkError<crate::error::DescribePlayerSessionsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::DescribePlayerSessionsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::DescribePlayerSessionsPaginator {
crate::paginator::DescribePlayerSessionsPaginator::new(self.handle, self.inner)
}
/// <p>A unique identifier for the game session to retrieve player sessions for.</p>
pub fn game_session_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_session_id(input.into());
self
}
/// <p>A unique identifier for the game session to retrieve player sessions for.</p>
pub fn set_game_session_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_session_id(input);
self
}
/// <p>A unique identifier for a player to retrieve player sessions for.</p>
pub fn player_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.player_id(input.into());
self
}
/// <p>A unique identifier for a player to retrieve player sessions for.</p>
pub fn set_player_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_player_id(input);
self
}
/// <p>A unique identifier for a player session to retrieve.</p>
pub fn player_session_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.player_session_id(input.into());
self
}
/// <p>A unique identifier for a player session to retrieve.</p>
pub fn set_player_session_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_player_session_id(input);
self
}
/// <p>Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.</p>
/// <p>Possible player session statuses include the following:</p>
/// <ul>
/// <li> <p> <b>RESERVED</b> -- The player session request has been received, but the player has not yet connected to the server process and/or been validated. </p> </li>
/// <li> <p> <b>ACTIVE</b> -- The player has been validated by the server process and is currently connected.</p> </li>
/// <li> <p> <b>COMPLETED</b> -- The player connection has been dropped.</p> </li>
/// <li> <p> <b>TIMEDOUT</b> -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).</p> </li>
/// </ul>
pub fn player_session_status_filter(
mut self,
input: impl Into<std::string::String>,
) -> Self {
self.inner = self.inner.player_session_status_filter(input.into());
self
}
/// <p>Player session status to filter results on. Note that when a PlayerSessionId or PlayerId is provided in a DescribePlayerSessions request, then the PlayerSessionStatusFilter has no effect on the response.</p>
/// <p>Possible player session statuses include the following:</p>
/// <ul>
/// <li> <p> <b>RESERVED</b> -- The player session request has been received, but the player has not yet connected to the server process and/or been validated. </p> </li>
/// <li> <p> <b>ACTIVE</b> -- The player has been validated by the server process and is currently connected.</p> </li>
/// <li> <p> <b>COMPLETED</b> -- The player connection has been dropped.</p> </li>
/// <li> <p> <b>TIMEDOUT</b> -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).</p> </li>
/// </ul>
pub fn set_player_session_status_filter(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_player_session_status_filter(input);
self
}
/// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.</p>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.</p>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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. If a player session ID is specified, this parameter is ignored.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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. If a player session ID is specified, this parameter is ignored.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `DescribeRuntimeConfiguration`.
///
/// <p>Retrieves a fleet's runtime configuration settings. The runtime configuration tells GameLift which server processes to run (and how) on each instance in the fleet.</p>
/// <p>To get the runtime configuration that is currently in forces for a fleet, provide the fleet ID. </p>
/// <p>If successful, a <code>RuntimeConfiguration</code> object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift fleets</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html">Running multiple processes on a fleet</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeRuntimeConfiguration {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_runtime_configuration_input::Builder,
}
impl DescribeRuntimeConfiguration {
/// Creates a new `DescribeRuntimeConfiguration`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeRuntimeConfiguration,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeRuntimeConfigurationError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeRuntimeConfigurationOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeRuntimeConfigurationError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet to get the runtime configuration for. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to get the runtime configuration for. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
}
/// Fluent builder constructing a request to `DescribeScalingPolicies`.
///
/// <p>Retrieves all scaling policies applied to a fleet.</p>
/// <p>To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of <code>ScalingPolicy</code> objects is returned for the fleet.</p>
/// <p>A fleet may have all of its scaling policies suspended. This operation does not affect the status of the scaling policies, which remains ACTIVE.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeScalingPolicies {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_scaling_policies_input::Builder,
}
impl DescribeScalingPolicies {
/// Creates a new `DescribeScalingPolicies`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeScalingPolicies,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeScalingPoliciesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeScalingPoliciesOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeScalingPoliciesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::DescribeScalingPoliciesPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::DescribeScalingPoliciesPaginator {
crate::paginator::DescribeScalingPoliciesPaginator::new(self.handle, self.inner)
}
/// <p>A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>Scaling policy status to filter results on. A scaling policy is only in force when in an <code>ACTIVE</code> status.</p>
/// <ul>
/// <li> <p> <b>ACTIVE</b> -- The scaling policy is currently in force.</p> </li>
/// <li> <p> <b>UPDATEREQUESTED</b> -- A request to update the scaling policy has been received.</p> </li>
/// <li> <p> <b>UPDATING</b> -- A change is being made to the scaling policy.</p> </li>
/// <li> <p> <b>DELETEREQUESTED</b> -- A request to delete the scaling policy has been received.</p> </li>
/// <li> <p> <b>DELETING</b> -- The scaling policy is being deleted.</p> </li>
/// <li> <p> <b>DELETED</b> -- The scaling policy has been deleted.</p> </li>
/// <li> <p> <b>ERROR</b> -- An error occurred in creating the policy. It should be removed and recreated.</p> </li>
/// </ul>
pub fn status_filter(mut self, input: crate::model::ScalingStatusType) -> Self {
self.inner = self.inner.status_filter(input);
self
}
/// <p>Scaling policy status to filter results on. A scaling policy is only in force when in an <code>ACTIVE</code> status.</p>
/// <ul>
/// <li> <p> <b>ACTIVE</b> -- The scaling policy is currently in force.</p> </li>
/// <li> <p> <b>UPDATEREQUESTED</b> -- A request to update the scaling policy has been received.</p> </li>
/// <li> <p> <b>UPDATING</b> -- A change is being made to the scaling policy.</p> </li>
/// <li> <p> <b>DELETEREQUESTED</b> -- A request to delete the scaling policy has been received.</p> </li>
/// <li> <p> <b>DELETING</b> -- The scaling policy is being deleted.</p> </li>
/// <li> <p> <b>DELETED</b> -- The scaling policy has been deleted.</p> </li>
/// <li> <p> <b>ERROR</b> -- An error occurred in creating the policy. It should be removed and recreated.</p> </li>
/// </ul>
pub fn set_status_filter(
mut self,
input: std::option::Option<crate::model::ScalingStatusType>,
) -> Self {
self.inner = self.inner.set_status_filter(input);
self
}
/// <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>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <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>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <p> The fleet location. If you don't specify this value, the response contains the scaling policies of every location in the fleet. </p>
pub fn location(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.location(input.into());
self
}
/// <p> The fleet location. If you don't specify this value, the response contains the scaling policies of every location in the fleet. </p>
pub fn set_location(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_location(input);
self
}
}
/// Fluent builder constructing a request to `DescribeScript`.
///
/// <p>Retrieves properties for a Realtime script. </p>
/// <p>To request a script record, specify the script ID. If successful, an object containing the script properties is returned.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a> </p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeScript {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_script_input::Builder,
}
impl DescribeScript {
/// Creates a new `DescribeScript`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeScript,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeScriptError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeScriptOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeScriptError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the Realtime script to retrieve properties for. You can use either the script ID or ARN value.</p>
pub fn script_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.script_id(input.into());
self
}
/// <p>A unique identifier for the Realtime script to retrieve properties for. You can use either the script ID or ARN value.</p>
pub fn set_script_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_script_id(input);
self
}
}
/// Fluent builder constructing a request to `DescribeVpcPeeringAuthorizations`.
///
/// <p>Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account. </p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeVpcPeeringAuthorizations {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_vpc_peering_authorizations_input::Builder,
}
impl DescribeVpcPeeringAuthorizations {
/// Creates a new `DescribeVpcPeeringAuthorizations`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeVpcPeeringAuthorizations,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeVpcPeeringAuthorizationsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeVpcPeeringAuthorizationsOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeVpcPeeringAuthorizationsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
}
/// Fluent builder constructing a request to `DescribeVpcPeeringConnections`.
///
/// <p>Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID. </p>
/// <p>To retrieve connection information, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect. </p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeVpcPeeringConnections {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::describe_vpc_peering_connections_input::Builder,
}
impl DescribeVpcPeeringConnections {
/// Creates a new `DescribeVpcPeeringConnections`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::DescribeVpcPeeringConnections,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::DescribeVpcPeeringConnectionsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::DescribeVpcPeeringConnectionsOutput,
aws_smithy_http::result::SdkError<crate::error::DescribeVpcPeeringConnectionsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
}
/// Fluent builder constructing a request to `GetComputeAccess`.
///
/// <p>Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time. </p>
/// <p>To remotely access an instance, you need credentials that match the operating system of the instance. For a Windows instance, GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a <code>.pem</code> file before using. If you're making this request using the CLI, saving the secret can be handled as part of the <code>GetInstanceAccess</code> request, as shown in one of the examples for this operation. </p>
/// <p>To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html">Remotely Access Fleet Instances</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html">Debug Fleet Issues</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetComputeAccess {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_compute_access_input::Builder,
}
impl GetComputeAccess {
/// Creates a new `GetComputeAccess`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetComputeAccess,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetComputeAccessError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetComputeAccessOutput,
aws_smithy_http::result::SdkError<crate::error::GetComputeAccessError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet that the compute resource is registered to.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet that the compute resource is registered to.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>The name of the compute resource you are requesting credentials for.</p>
pub fn compute_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.compute_name(input.into());
self
}
/// <p>The name of the compute resource you are requesting credentials for.</p>
pub fn set_compute_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_compute_name(input);
self
}
}
/// Fluent builder constructing a request to `GetComputeAuthToken`.
///
/// <p>Requests an authorization token from GameLift. The authorization token is used by your game server to authenticate with GameLift. Each authentication token has an expiration token. To continue using the compute resource to host your game server, regularly retrieve a new authorization token.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetComputeAuthToken {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_compute_auth_token_input::Builder,
}
impl GetComputeAuthToken {
/// Creates a new `GetComputeAuthToken`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetComputeAuthToken,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetComputeAuthTokenError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetComputeAuthTokenOutput,
aws_smithy_http::result::SdkError<crate::error::GetComputeAuthTokenError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet that the compute is registered to.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet that the compute is registered to.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>The name of the compute resource you are requesting the authorization token for.</p>
pub fn compute_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.compute_name(input.into());
self
}
/// <p>The name of the compute resource you are requesting the authorization token for.</p>
pub fn set_compute_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_compute_name(input);
self
}
}
/// Fluent builder constructing a request to `GetGameSessionLogUrl`.
///
/// <p>Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs.</p> <note>
/// <p>See the <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_gamelift">Amazon Web Services Service Limits</a> page for maximum log file sizes. Log files that exceed this limit are not saved.</p>
/// </note>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetGameSessionLogUrl {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_game_session_log_url_input::Builder,
}
impl GetGameSessionLogUrl {
/// Creates a new `GetGameSessionLogUrl`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetGameSessionLogUrl,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetGameSessionLogUrlError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetGameSessionLogUrlOutput,
aws_smithy_http::result::SdkError<crate::error::GetGameSessionLogUrlError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the game session to get logs for. </p>
pub fn game_session_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_session_id(input.into());
self
}
/// <p>A unique identifier for the game session to get logs for. </p>
pub fn set_game_session_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_session_id(input);
self
}
}
/// Fluent builder constructing a request to `GetInstanceAccess`.
///
/// <p>Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time. </p>
/// <p>To remotely access an instance, you need credentials that match the operating system of the instance. For a Windows instance, GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a <code>.pem</code> file before using. If you're making this request using the CLI, saving the secret can be handled as part of the <code>GetInstanceAccess</code> request, as shown in one of the examples for this operation. </p>
/// <p>To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeInstances.html">DescribeInstances</a>. </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html">Remotely Access Fleet Instances</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html">Debug Fleet Issues</a> </p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetInstanceAccess {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::get_instance_access_input::Builder,
}
impl GetInstanceAccess {
/// Creates a new `GetInstanceAccess`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::GetInstanceAccess,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::GetInstanceAccessError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::GetInstanceAccessOutput,
aws_smithy_http::result::SdkError<crate::error::GetInstanceAccessError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet that contains the instance you want access to. You can use either the fleet ID or ARN value. The fleet can be in any of the following statuses: <code>ACTIVATING</code>, <code>ACTIVE</code>, or <code>ERROR</code>. Fleets with an <code>ERROR</code> status may be accessible for a short time before they are deleted.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet that contains the instance you want access to. You can use either the fleet ID or ARN value. The fleet can be in any of the following statuses: <code>ACTIVATING</code>, <code>ACTIVE</code>, or <code>ERROR</code>. Fleets with an <code>ERROR</code> status may be accessible for a short time before they are deleted.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>A unique identifier for the instance you want to get access to. You can access an instance in any status.</p>
pub fn instance_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.instance_id(input.into());
self
}
/// <p>A unique identifier for the instance you want to get access to. You can access an instance in any status.</p>
pub fn set_instance_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_instance_id(input);
self
}
}
/// Fluent builder constructing a request to `ListAliases`.
///
/// <p>Retrieves all aliases for this Amazon Web Services account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.</p> <note>
/// <p>Returned aliases are not listed in any particular order.</p>
/// </note>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListAliases {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_aliases_input::Builder,
}
impl ListAliases {
/// Creates a new `ListAliases`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListAliases,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListAliasesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListAliasesOutput,
aws_smithy_http::result::SdkError<crate::error::ListAliasesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListAliasesPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListAliasesPaginator {
crate::paginator::ListAliasesPaginator::new(self.handle, self.inner)
}
/// <p>The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing type. To retrieve all aliases, leave this parameter empty.</p>
/// <p>Possible routing types include the following:</p>
/// <ul>
/// <li> <p> <b>SIMPLE</b> -- The alias resolves to one specific fleet. Use this type when routing to active fleets.</p> </li>
/// <li> <p> <b>TERMINAL</b> -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_RoutingStrategy.html">RoutingStrategy</a> message embedded.</p> </li>
/// </ul>
pub fn routing_strategy_type(mut self, input: crate::model::RoutingStrategyType) -> Self {
self.inner = self.inner.routing_strategy_type(input);
self
}
/// <p>The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing type. To retrieve all aliases, leave this parameter empty.</p>
/// <p>Possible routing types include the following:</p>
/// <ul>
/// <li> <p> <b>SIMPLE</b> -- The alias resolves to one specific fleet. Use this type when routing to active fleets.</p> </li>
/// <li> <p> <b>TERMINAL</b> -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_RoutingStrategy.html">RoutingStrategy</a> message embedded.</p> </li>
/// </ul>
pub fn set_routing_strategy_type(
mut self,
input: std::option::Option<crate::model::RoutingStrategyType>,
) -> Self {
self.inner = self.inner.set_routing_strategy_type(input);
self
}
/// <p>A descriptive label that is associated with an alias. Alias names do not need to be unique.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A descriptive label that is associated with an alias. Alias names do not need to be unique.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <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>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <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>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ListBuilds`.
///
/// <p>Retrieves build resources for all builds associated with the Amazon Web Services account in use. You can limit results to builds that are in a specific status by using the <code>Status</code> parameter. Use the pagination parameters to retrieve results in a set of sequential pages. </p> <note>
/// <p>Build resources are not listed in any particular order.</p>
/// </note>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html"> Upload a Custom Server Build</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListBuilds {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_builds_input::Builder,
}
impl ListBuilds {
/// Creates a new `ListBuilds`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListBuilds,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListBuildsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListBuildsOutput,
aws_smithy_http::result::SdkError<crate::error::ListBuildsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListBuildsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListBuildsPaginator {
crate::paginator::ListBuildsPaginator::new(self.handle, self.inner)
}
/// <p>Build status to filter results by. To retrieve all builds, leave this parameter empty.</p>
/// <p>Possible build statuses include the following:</p>
/// <ul>
/// <li> <p> <b>INITIALIZED</b> -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value. </p> </li>
/// <li> <p> <b>READY</b> -- The game build has been successfully uploaded. You can now create new fleets for this build.</p> </li>
/// <li> <p> <b>FAILED</b> -- The game build upload failed. You cannot create new fleets for this build. </p> </li>
/// </ul>
pub fn status(mut self, input: crate::model::BuildStatus) -> Self {
self.inner = self.inner.status(input);
self
}
/// <p>Build status to filter results by. To retrieve all builds, leave this parameter empty.</p>
/// <p>Possible build statuses include the following:</p>
/// <ul>
/// <li> <p> <b>INITIALIZED</b> -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value. </p> </li>
/// <li> <p> <b>READY</b> -- The game build has been successfully uploaded. You can now create new fleets for this build.</p> </li>
/// <li> <p> <b>FAILED</b> -- The game build upload failed. You cannot create new fleets for this build. </p> </li>
/// </ul>
pub fn set_status(mut self, input: std::option::Option<crate::model::BuildStatus>) -> Self {
self.inner = self.inner.set_status(input);
self
}
/// <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>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <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>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ListCompute`.
///
/// <p>Retrieves all compute resources registered to a fleet in your Amazon Web Services account. You can filter the result set by location.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListCompute {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_compute_input::Builder,
}
impl ListCompute {
/// Creates a new `ListCompute`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListCompute,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListComputeError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListComputeOutput,
aws_smithy_http::result::SdkError<crate::error::ListComputeError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListComputePaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListComputePaginator {
crate::paginator::ListComputePaginator::new(self.handle, self.inner)
}
/// <p>A unique identifier for the fleet the compute resources are registered to.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet the compute resources are registered to.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>The name of the custom location that the compute resources are assigned to.</p>
pub fn location(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.location(input.into());
self
}
/// <p>The name of the custom location that the compute resources are assigned to.</p>
pub fn set_location(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_location(input);
self
}
/// <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>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <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>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ListFleets`.
///
/// <p>Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this operation to get fleets in a previously selected default Region (see <a href="https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.html">https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.html</a>or specify a Region in your request. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.</p>
/// <p>This operation can be used in the following ways: </p>
/// <ul>
/// <li> <p>To get a list of all fleets in a Region, don't provide a build or script identifier. </p> </li>
/// <li> <p>To get a list of all fleets where a specific custom game build is deployed, provide the build ID.</p> </li>
/// <li> <p>To get a list of all Realtime Servers fleets with a specific configuration script, provide the script ID. </p> </li>
/// </ul>
/// <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
/// <p>If successful, a list of fleet IDs that match the request parameters is returned. A NextToken value is also returned if there are more result pages to retrieve.</p> <note>
/// <p>Fleet resources are not listed in a particular order.</p>
/// </note>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListFleets {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_fleets_input::Builder,
}
impl ListFleets {
/// Creates a new `ListFleets`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListFleets,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListFleetsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListFleetsOutput,
aws_smithy_http::result::SdkError<crate::error::ListFleetsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListFleetsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListFleetsPaginator {
crate::paginator::ListFleetsPaginator::new(self.handle, self.inner)
}
/// <p>A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value.</p>
pub fn build_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.build_id(input.into());
self
}
/// <p>A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value.</p>
pub fn set_build_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_build_id(input);
self
}
/// <p>A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value.</p>
pub fn script_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.script_id(input.into());
self
}
/// <p>A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value.</p>
pub fn set_script_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_script_id(input);
self
}
/// <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>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <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>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ListGameServerGroups`.
///
/// <p>Lists a game server groups.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListGameServerGroups {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_game_server_groups_input::Builder,
}
impl ListGameServerGroups {
/// Creates a new `ListGameServerGroups`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListGameServerGroups,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListGameServerGroupsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListGameServerGroupsOutput,
aws_smithy_http::result::SdkError<crate::error::ListGameServerGroupsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListGameServerGroupsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListGameServerGroupsPaginator {
crate::paginator::ListGameServerGroupsPaginator::new(self.handle, self.inner)
}
/// <p>The game server groups' limit.</p>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <p>The game server groups' limit.</p>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ListGameServers`.
///
/// <p> <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b> </p>
/// <p>Retrieves information on all game servers that are currently active in a specified game server group. You can opt to sort the list by game server age. Use the pagination parameters to retrieve results in a set of sequential segments. </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ Guide</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListGameServers {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_game_servers_input::Builder,
}
impl ListGameServers {
/// Creates a new `ListGameServers`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListGameServers,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListGameServersError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListGameServersOutput,
aws_smithy_http::result::SdkError<crate::error::ListGameServersError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListGameServersPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListGameServersPaginator {
crate::paginator::ListGameServersPaginator::new(self.handle, self.inner)
}
/// <p>An identifier for the game server group to retrieve a list of game servers from. Use either the name or ARN value.</p>
pub fn game_server_group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_group_name(input.into());
self
}
/// <p>An identifier for the game server group to retrieve a list of game servers from. Use either the name or ARN value.</p>
pub fn set_game_server_group_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_group_name(input);
self
}
/// <p>Indicates how to sort the returned data based on game server registration timestamp. Use <code>ASCENDING</code> to retrieve oldest game servers first, or use <code>DESCENDING</code> to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.</p>
pub fn sort_order(mut self, input: crate::model::SortOrder) -> Self {
self.inner = self.inner.sort_order(input);
self
}
/// <p>Indicates how to sort the returned data based on game server registration timestamp. Use <code>ASCENDING</code> to retrieve oldest game servers first, or use <code>DESCENDING</code> to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.</p>
pub fn set_sort_order(
mut self,
input: std::option::Option<crate::model::SortOrder>,
) -> Self {
self.inner = self.inner.set_sort_order(input);
self
}
/// <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>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <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>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ListLocations`.
///
/// <p>Lists all custom and Amazon Web Services locations.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListLocations {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_locations_input::Builder,
}
impl ListLocations {
/// Creates a new `ListLocations`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListLocations,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListLocationsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListLocationsOutput,
aws_smithy_http::result::SdkError<crate::error::ListLocationsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListLocationsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListLocationsPaginator {
crate::paginator::ListLocationsPaginator::new(self.handle, self.inner)
}
/// Appends an item to `Filters`.
///
/// To override the contents of this collection use [`set_filters`](Self::set_filters).
///
/// <p>Filters the list for <code>AWS</code> or <code>CUSTOM</code> locations.</p>
pub fn filters(mut self, input: crate::model::LocationFilter) -> Self {
self.inner = self.inner.filters(input);
self
}
/// <p>Filters the list for <code>AWS</code> or <code>CUSTOM</code> locations.</p>
pub fn set_filters(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::LocationFilter>>,
) -> Self {
self.inner = self.inner.set_filters(input);
self
}
/// <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>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <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>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ListScripts`.
///
/// <p>Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use. </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a> </p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListScripts {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_scripts_input::Builder,
}
impl ListScripts {
/// Creates a new `ListScripts`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListScripts,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListScriptsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListScriptsOutput,
aws_smithy_http::result::SdkError<crate::error::ListScriptsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::ListScriptsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::ListScriptsPaginator {
crate::paginator::ListScriptsPaginator::new(self.handle, self.inner)
}
/// <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>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <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>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `ListTagsForResource`.
///
/// <p>Retrieves all tags that are assigned to a GameLift resource. Resource tags are used to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:</p>
/// <ul>
/// <li> <p>Build</p> </li>
/// <li> <p>Script</p> </li>
/// <li> <p>Fleet</p> </li>
/// <li> <p>Alias</p> </li>
/// <li> <p>GameSessionQueue</p> </li>
/// <li> <p>MatchmakingConfiguration</p> </li>
/// <li> <p>MatchmakingRuleSet</p> </li>
/// </ul>
/// <p>To list tags for a resource, specify the unique ARN value for the resource.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i> </p>
/// <p> <a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/"> Amazon Web Services Tagging Strategies</a> </p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ListTagsForResource {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::list_tags_for_resource_input::Builder,
}
impl ListTagsForResource {
/// Creates a new `ListTagsForResource`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ListTagsForResource,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ListTagsForResourceError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ListTagsForResourceOutput,
aws_smithy_http::result::SdkError<crate::error::ListTagsForResourceError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <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 and uniquely identifies the GameLift resource that you want to retrieve tags for. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type. </p>
pub fn resource_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.resource_arn(input.into());
self
}
/// <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 and uniquely identifies the GameLift resource that you want to retrieve tags for. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type. </p>
pub fn set_resource_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_resource_arn(input);
self
}
}
/// Fluent builder constructing a request to `PutScalingPolicy`.
///
/// <p>Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling. </p>
/// <p>Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences.</p>
/// <p>Learn more about how to work with auto-scaling in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-autoscaling.html">Set Up Fleet Automatic Scaling</a>.</p>
/// <p> <b>Target-based policy</b> </p>
/// <p>A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target. </p>
/// <p>For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer. </p>
/// <p>To create or update a target-based policy, specify a fleet ID and name, and set the policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) and reference a <code>TargetConfiguration</code> object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.</p>
/// <p> <b>Rule-based policy</b> </p>
/// <p>A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action. </p>
/// <p>For example, a policy may make the following statement: "If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%."</p>
/// <p>A policy's rule statement has the following structure:</p>
/// <p>If <code>[MetricName]</code> is <code>[ComparisonOperator]</code> <code>[Threshold]</code> for <code>[EvaluationPeriods]</code> minutes, then <code>[ScalingAdjustmentType]</code> to/by <code>[ScalingAdjustment]</code>.</p>
/// <p>To implement the example, the rule statement would look like this:</p>
/// <p>If <code>[PercentIdleInstances]</code> is <code>[GreaterThanThreshold]</code> <code>[20]</code> for <code>[15]</code> minutes, then <code>[PercentChangeInCapacity]</code> to/by <code>[10]</code>.</p>
/// <p>To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to "RuleBased". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct PutScalingPolicy {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::put_scaling_policy_input::Builder,
}
impl PutScalingPolicy {
/// Creates a new `PutScalingPolicy`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::PutScalingPolicy,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::PutScalingPolicyError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::PutScalingPolicyOutput,
aws_smithy_http::result::SdkError<crate::error::PutScalingPolicyError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>A unique identifier for the fleet to apply this policy to. You can use either the fleet ID or ARN value. The fleet cannot be in any of the following statuses: ERROR or DELETING.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to apply this policy to. You can use either the fleet ID or ARN value. The fleet cannot be in any of the following statuses: ERROR or DELETING.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>Amount of adjustment to make, based on the scaling adjustment type.</p>
pub fn scaling_adjustment(mut self, input: i32) -> Self {
self.inner = self.inner.scaling_adjustment(input);
self
}
/// <p>Amount of adjustment to make, based on the scaling adjustment type.</p>
pub fn set_scaling_adjustment(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_scaling_adjustment(input);
self
}
/// <p>The type of adjustment to make to a fleet's instance count:</p>
/// <ul>
/// <li> <p> <b>ChangeInCapacity</b> -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.</p> </li>
/// <li> <p> <b>ExactCapacity</b> -- set the instance count to the scaling adjustment value.</p> </li>
/// <li> <p> <b>PercentChangeInCapacity</b> -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down; for example, a value of "-10" scales the fleet down by 10%.</p> </li>
/// </ul>
pub fn scaling_adjustment_type(
mut self,
input: crate::model::ScalingAdjustmentType,
) -> Self {
self.inner = self.inner.scaling_adjustment_type(input);
self
}
/// <p>The type of adjustment to make to a fleet's instance count:</p>
/// <ul>
/// <li> <p> <b>ChangeInCapacity</b> -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.</p> </li>
/// <li> <p> <b>ExactCapacity</b> -- set the instance count to the scaling adjustment value.</p> </li>
/// <li> <p> <b>PercentChangeInCapacity</b> -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down; for example, a value of "-10" scales the fleet down by 10%.</p> </li>
/// </ul>
pub fn set_scaling_adjustment_type(
mut self,
input: std::option::Option<crate::model::ScalingAdjustmentType>,
) -> Self {
self.inner = self.inner.set_scaling_adjustment_type(input);
self
}
/// <p>Metric value used to trigger a scaling event.</p>
pub fn threshold(mut self, input: f64) -> Self {
self.inner = self.inner.threshold(input);
self
}
/// <p>Metric value used to trigger a scaling event.</p>
pub fn set_threshold(mut self, input: std::option::Option<f64>) -> Self {
self.inner = self.inner.set_threshold(input);
self
}
/// <p>Comparison operator to use when measuring the metric against the threshold value.</p>
pub fn comparison_operator(mut self, input: crate::model::ComparisonOperatorType) -> Self {
self.inner = self.inner.comparison_operator(input);
self
}
/// <p>Comparison operator to use when measuring the metric against the threshold value.</p>
pub fn set_comparison_operator(
mut self,
input: std::option::Option<crate::model::ComparisonOperatorType>,
) -> Self {
self.inner = self.inner.set_comparison_operator(input);
self
}
/// <p>Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.</p>
pub fn evaluation_periods(mut self, input: i32) -> Self {
self.inner = self.inner.evaluation_periods(input);
self
}
/// <p>Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.</p>
pub fn set_evaluation_periods(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_evaluation_periods(input);
self
}
/// <p>Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html">Monitor Amazon GameLift with Amazon CloudWatch</a>. </p>
/// <ul>
/// <li> <p> <b>ActivatingGameSessions</b> -- Game sessions in the process of being created.</p> </li>
/// <li> <p> <b>ActiveGameSessions</b> -- Game sessions that are currently running.</p> </li>
/// <li> <p> <b>ActiveInstances</b> -- Fleet instances that are currently running at least one game session.</p> </li>
/// <li> <p> <b>AvailableGameSessions</b> -- Additional game sessions that fleet could host simultaneously, given current capacity.</p> </li>
/// <li> <p> <b>AvailablePlayerSessions</b> -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.</p> </li>
/// <li> <p> <b>CurrentPlayerSessions</b> -- Player slots in active game sessions that are being used by a player or are reserved for a player. </p> </li>
/// <li> <p> <b>IdleInstances</b> -- Active instances that are currently hosting zero game sessions. </p> </li>
/// <li> <p> <b>PercentAvailableGameSessions</b> -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.</p> </li>
/// <li> <p> <b>PercentIdleInstances</b> -- Percentage of the total number of active instances that are hosting zero game sessions.</p> </li>
/// <li> <p> <b>QueueDepth</b> -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.</p> </li>
/// <li> <p> <b>WaitTime</b> -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination. </p> </li>
/// </ul>
pub fn metric_name(mut self, input: crate::model::MetricName) -> Self {
self.inner = self.inner.metric_name(input);
self
}
/// <p>Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html">Monitor Amazon GameLift with Amazon CloudWatch</a>. </p>
/// <ul>
/// <li> <p> <b>ActivatingGameSessions</b> -- Game sessions in the process of being created.</p> </li>
/// <li> <p> <b>ActiveGameSessions</b> -- Game sessions that are currently running.</p> </li>
/// <li> <p> <b>ActiveInstances</b> -- Fleet instances that are currently running at least one game session.</p> </li>
/// <li> <p> <b>AvailableGameSessions</b> -- Additional game sessions that fleet could host simultaneously, given current capacity.</p> </li>
/// <li> <p> <b>AvailablePlayerSessions</b> -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.</p> </li>
/// <li> <p> <b>CurrentPlayerSessions</b> -- Player slots in active game sessions that are being used by a player or are reserved for a player. </p> </li>
/// <li> <p> <b>IdleInstances</b> -- Active instances that are currently hosting zero game sessions. </p> </li>
/// <li> <p> <b>PercentAvailableGameSessions</b> -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.</p> </li>
/// <li> <p> <b>PercentIdleInstances</b> -- Percentage of the total number of active instances that are hosting zero game sessions.</p> </li>
/// <li> <p> <b>QueueDepth</b> -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.</p> </li>
/// <li> <p> <b>WaitTime</b> -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination. </p> </li>
/// </ul>
pub fn set_metric_name(
mut self,
input: std::option::Option<crate::model::MetricName>,
) -> Self {
self.inner = self.inner.set_metric_name(input);
self
}
/// <p>The type of scaling policy to create. For a target-based policy, set the parameter <i>MetricName</i> to 'PercentAvailableGameSessions' and specify a <i>TargetConfiguration</i>. For a rule-based policy set the following parameters: <i>MetricName</i>, <i>ComparisonOperator</i>, <i>Threshold</i>, <i>EvaluationPeriods</i>, <i>ScalingAdjustmentType</i>, and <i>ScalingAdjustment</i>.</p>
pub fn policy_type(mut self, input: crate::model::PolicyType) -> Self {
self.inner = self.inner.policy_type(input);
self
}
/// <p>The type of scaling policy to create. For a target-based policy, set the parameter <i>MetricName</i> to 'PercentAvailableGameSessions' and specify a <i>TargetConfiguration</i>. For a rule-based policy set the following parameters: <i>MetricName</i>, <i>ComparisonOperator</i>, <i>Threshold</i>, <i>EvaluationPeriods</i>, <i>ScalingAdjustmentType</i>, and <i>ScalingAdjustment</i>.</p>
pub fn set_policy_type(
mut self,
input: std::option::Option<crate::model::PolicyType>,
) -> Self {
self.inner = self.inner.set_policy_type(input);
self
}
/// <p>An object that contains settings for a target-based scaling policy.</p>
pub fn target_configuration(mut self, input: crate::model::TargetConfiguration) -> Self {
self.inner = self.inner.target_configuration(input);
self
}
/// <p>An object that contains settings for a target-based scaling policy.</p>
pub fn set_target_configuration(
mut self,
input: std::option::Option<crate::model::TargetConfiguration>,
) -> Self {
self.inner = self.inner.set_target_configuration(input);
self
}
}
/// Fluent builder constructing a request to `RegisterCompute`.
///
/// <p>Registers your compute resources in a fleet you previously created. After you register a compute to your fleet, you can monitor and manage your compute using GameLift. The operation returns the compute resource containing SDK endpoint you can use to connect your game server to GameLift.</p>
/// <p> <b>Learn more</b> </p>
/// <ul>
/// <li> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-anywhere.html">Create an Anywhere fleet</a> </p> </li>
/// <li> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-testing.html">Test your integration</a> </p> </li>
/// </ul>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct RegisterCompute {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::register_compute_input::Builder,
}
impl RegisterCompute {
/// Creates a new `RegisterCompute`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::RegisterCompute,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::RegisterComputeError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::RegisterComputeOutput,
aws_smithy_http::result::SdkError<crate::error::RegisterComputeError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet to register the compute to. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to register the compute to. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>A descriptive label that is associated with the compute resource registered to your fleet.</p>
pub fn compute_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.compute_name(input.into());
self
}
/// <p>A descriptive label that is associated with the compute resource registered to your fleet.</p>
pub fn set_compute_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_compute_name(input);
self
}
/// <p>The path to the TLS certificate on your compute resource. The path and certificate are not validated by GameLift.</p>
pub fn certificate_path(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.certificate_path(input.into());
self
}
/// <p>The path to the TLS certificate on your compute resource. The path and certificate are not validated by GameLift.</p>
pub fn set_certificate_path(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_certificate_path(input);
self
}
/// <p>The DNS name of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.</p>
pub fn dns_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.dns_name(input.into());
self
}
/// <p>The DNS name of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.</p>
pub fn set_dns_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_dns_name(input);
self
}
/// <p>The IP address of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.</p>
pub fn ip_address(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.ip_address(input.into());
self
}
/// <p>The IP address of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.</p>
pub fn set_ip_address(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_ip_address(input);
self
}
/// <p>The name of the custom location you added to the fleet you are registering this compute resource to.</p>
pub fn location(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.location(input.into());
self
}
/// <p>The name of the custom location you added to the fleet you are registering this compute resource to.</p>
pub fn set_location(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_location(input);
self
}
}
/// Fluent builder constructing a request to `RegisterGameServer`.
///
/// <p> <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b> </p>
/// <p>Creates a new game server resource and notifies GameLift FleetIQ that the game server is ready to host gameplay and players. This operation is called by a game server process that is running on an instance in a game server group. Registering game servers enables GameLift FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session. </p>
/// <p>To register a game server, identify the game server group and instance where the game server is running, and provide a unique identifier for the game server. You can also include connection and game server data.</p>
/// <p>Once a game server is successfully registered, it is put in status <code>AVAILABLE</code>. A request to register a game server may fail if the instance it is running on is in the process of shutting down as part of instance balancing or scale-down activity. </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ Guide</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct RegisterGameServer {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::register_game_server_input::Builder,
}
impl RegisterGameServer {
/// Creates a new `RegisterGameServer`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::RegisterGameServer,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::RegisterGameServerError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::RegisterGameServerOutput,
aws_smithy_http::result::SdkError<crate::error::RegisterGameServerError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the game server group where the game server is running.</p>
pub fn game_server_group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_group_name(input.into());
self
}
/// <p>A unique identifier for the game server group where the game server is running.</p>
pub fn set_game_server_group_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_group_name(input);
self
}
/// <p>A custom string that uniquely identifies the game server to register. Game server IDs are developer-defined and must be unique across all game server groups in your Amazon Web Services account.</p>
pub fn game_server_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_id(input.into());
self
}
/// <p>A custom string that uniquely identifies the game server to register. Game server IDs are developer-defined and must be unique across all game server groups in your Amazon Web Services account.</p>
pub fn set_game_server_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_id(input);
self
}
/// <p>The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: <code>i-1234567890abcdef0</code>.</p>
pub fn instance_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.instance_id(input.into());
self
}
/// <p>The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: <code>i-1234567890abcdef0</code>.</p>
pub fn set_instance_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_instance_id(input);
self
}
/// <p>Information that is needed to make inbound client connections to the game server. This might include the IP address and port, DNS name, and other information.</p>
pub fn connection_info(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.connection_info(input.into());
self
}
/// <p>Information that is needed to make inbound client connections to the game server. This might include the IP address and port, DNS name, and other information.</p>
pub fn set_connection_info(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_connection_info(input);
self
}
/// <p>A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers. </p>
pub fn game_server_data(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_data(input.into());
self
}
/// <p>A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers. </p>
pub fn set_game_server_data(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_data(input);
self
}
}
/// Fluent builder constructing a request to `RequestUploadCredentials`.
///
/// <p>Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html">GameSession</a>.</p>
/// <p>To request new credentials, specify the build ID as returned with an initial <code>CreateBuild</code> request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build"> Create a Build with Files in S3</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct RequestUploadCredentials {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::request_upload_credentials_input::Builder,
}
impl RequestUploadCredentials {
/// Creates a new `RequestUploadCredentials`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::RequestUploadCredentials,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::RequestUploadCredentialsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::RequestUploadCredentialsOutput,
aws_smithy_http::result::SdkError<crate::error::RequestUploadCredentialsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the build to get credentials for. You can use either the build ID or ARN value. </p>
pub fn build_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.build_id(input.into());
self
}
/// <p>A unique identifier for the build to get credentials for. You can use either the build ID or ARN value. </p>
pub fn set_build_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_build_id(input);
self
}
}
/// Fluent builder constructing a request to `ResolveAlias`.
///
/// <p>Retrieves the fleet ID that an alias is currently pointing to.</p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ResolveAlias {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::resolve_alias_input::Builder,
}
impl ResolveAlias {
/// Creates a new `ResolveAlias`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ResolveAlias,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ResolveAliasError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ResolveAliasOutput,
aws_smithy_http::result::SdkError<crate::error::ResolveAliasError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The unique identifier of the alias that you want to retrieve a fleet ID for. You can use either the alias ID or ARN value.</p>
pub fn alias_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.alias_id(input.into());
self
}
/// <p>The unique identifier of the alias that you want to retrieve a fleet ID for. You can use either the alias ID or ARN value.</p>
pub fn set_alias_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_alias_id(input);
self
}
}
/// Fluent builder constructing a request to `ResumeGameServerGroup`.
///
/// <p> <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b> </p>
/// <p>Reinstates activity on a game server group after it has been suspended. A game server group might be suspended by the <a href="gamelift/latest/apireference/API_SuspendGameServerGroup.html">SuspendGameServerGroup</a> operation, or it might be suspended involuntarily due to a configuration problem. In the second case, you can manually resume activity on the group once the configuration problem has been resolved. Refer to the game server group status and status reason for more information on why group activity is suspended.</p>
/// <p>To resume activity, specify a game server group ARN and the type of activity to be resumed. If successful, a <code>GameServerGroup</code> object is returned showing that the resumed activity is no longer listed in <code>SuspendedActions</code>. </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ Guide</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ResumeGameServerGroup {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::resume_game_server_group_input::Builder,
}
impl ResumeGameServerGroup {
/// Creates a new `ResumeGameServerGroup`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ResumeGameServerGroup,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ResumeGameServerGroupError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ResumeGameServerGroupOutput,
aws_smithy_http::result::SdkError<crate::error::ResumeGameServerGroupError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
pub fn game_server_group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_group_name(input.into());
self
}
/// <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
pub fn set_game_server_group_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_group_name(input);
self
}
/// Appends an item to `ResumeActions`.
///
/// To override the contents of this collection use [`set_resume_actions`](Self::set_resume_actions).
///
/// <p>The activity to resume for this game server group.</p>
pub fn resume_actions(mut self, input: crate::model::GameServerGroupAction) -> Self {
self.inner = self.inner.resume_actions(input);
self
}
/// <p>The activity to resume for this game server group.</p>
pub fn set_resume_actions(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::GameServerGroupAction>>,
) -> Self {
self.inner = self.inner.set_resume_actions(input);
self
}
}
/// Fluent builder constructing a request to `SearchGameSessions`.
///
/// <p>Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order. </p>
/// <p>This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling game session status with <code>DescribeGameSessions</code> should only be used for games in development with low game session usage. </p>
/// <p>When searching for game sessions, you specify exactly where you want to search and provide a search filter expression, a sort expression, or both. A search request can search only one fleet, but it can search all of a fleet's locations. </p>
/// <p>This operation can be used in the following ways: </p>
/// <ul>
/// <li> <p>To search all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID. This approach returns game sessions in the fleet's home Region and all remote locations that fit the search criteria.</p> </li>
/// <li> <p>To search all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name. For location, you can specify a fleet's home Region or any remote location.</p> </li>
/// </ul>
/// <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
/// <p>If successful, a <code>GameSession</code> object is returned for each game session that matches the request. Search finds game sessions that are in <code>ACTIVE</code> status only. To retrieve information on game sessions in other statuses, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessions.html">DescribeGameSessions</a> .</p>
/// <p>You can search or sort by the following game session attributes:</p>
/// <ul>
/// <li> <p> <b>gameSessionId</b> -- A unique identifier for the game session. You can use either a <code>GameSessionId</code> or <code>GameSessionArn</code> value. </p> </li>
/// <li> <p> <b>gameSessionName</b> -- Name assigned to a game session. Game session names do not need to be unique to a game session.</p> </li>
/// <li> <p> <b>gameSessionProperties</b> -- Custom data defined in a game session's <code>GameProperty</code> parameter. <code>GameProperty</code> values are stored as key:value pairs; the filter expression must indicate the key and a string to search the data values for. For example, to search for game sessions with custom data containing the key:value pair "gameMode:brawl", specify the following: <code>gameSessionProperties.gameMode = "brawl"</code>. All custom data values are searched as strings.</p> </li>
/// <li> <p> <b>maximumSessions</b> -- Maximum number of player sessions allowed for a game session.</p> </li>
/// <li> <p> <b>creationTimeMillis</b> -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds.</p> </li>
/// <li> <p> <b>playerSessionCount</b> -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out.</p> </li>
/// <li> <p> <b>hasAvailablePlayerSessions</b> -- Boolean value indicating whether a game session has reached its maximum number of players. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join. </p> </li>
/// </ul> <note>
/// <p>Returned values for <code>playerSessionCount</code> and <code>hasAvailablePlayerSessions</code> change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join. </p>
/// </note>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct SearchGameSessions {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::search_game_sessions_input::Builder,
}
impl SearchGameSessions {
/// Creates a new `SearchGameSessions`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::SearchGameSessions,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::SearchGameSessionsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::SearchGameSessionsOutput,
aws_smithy_http::result::SdkError<crate::error::SearchGameSessionsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::paginator::SearchGameSessionsPaginator::send) which returns a [`Stream`](tokio_stream::Stream).
pub fn into_paginator(self) -> crate::paginator::SearchGameSessionsPaginator {
crate::paginator::SearchGameSessionsPaginator::new(self.handle, self.inner)
}
/// <p>A unique identifier for the fleet to search for active game sessions. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to search for active game sessions. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>A unique identifier for the alias associated with the fleet to search for active game sessions. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.</p>
pub fn alias_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.alias_id(input.into());
self
}
/// <p>A unique identifier for the alias associated with the fleet to search for active game sessions. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.</p>
pub fn set_alias_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_alias_id(input);
self
}
/// <p>A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>. </p>
pub fn location(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.location(input.into());
self
}
/// <p>A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>. </p>
pub fn set_location(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_location(input);
self
}
/// <p>String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in <code>ACTIVE</code> status.</p>
/// <p>A filter expression can contain one or multiple conditions. Each condition consists of the following:</p>
/// <ul>
/// <li> <p> <b>Operand</b> -- Name of a game session attribute. Valid values are <code>gameSessionName</code>, <code>gameSessionId</code>, <code>gameSessionProperties</code>, <code>maximumSessions</code>, <code>creationTimeMillis</code>, <code>playerSessionCount</code>, <code>hasAvailablePlayerSessions</code>.</p> </li>
/// <li> <p> <b>Comparator</b> -- Valid comparators are: <code>=</code>, <code><></code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>. </p> </li>
/// <li> <p> <b>Value</b> -- Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators <code>=</code> and <code><></code>. For example, the following filter expression searches on <code>gameSessionName</code>: "<code>FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'"</code>. </p> </li>
/// </ul>
/// <p>To chain multiple conditions in a single expression, use the logical keywords <code>AND</code>, <code>OR</code>, and <code>NOT</code> and parentheses as needed. For example: <code>x AND y AND NOT z</code>, <code>NOT (x OR y)</code>.</p>
/// <p>Session search evaluates conditions from left to right using the following precedence rules:</p>
/// <ol>
/// <li> <p> <code>=</code>, <code><></code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code> </p> </li>
/// <li> <p>Parentheses</p> </li>
/// <li> <p>NOT</p> </li>
/// <li> <p>AND</p> </li>
/// <li> <p>OR</p> </li>
/// </ol>
/// <p>For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: <code>"maximumSessions>=10 AND hasAvailablePlayerSessions=true"</code>. </p>
pub fn filter_expression(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.filter_expression(input.into());
self
}
/// <p>String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in <code>ACTIVE</code> status.</p>
/// <p>A filter expression can contain one or multiple conditions. Each condition consists of the following:</p>
/// <ul>
/// <li> <p> <b>Operand</b> -- Name of a game session attribute. Valid values are <code>gameSessionName</code>, <code>gameSessionId</code>, <code>gameSessionProperties</code>, <code>maximumSessions</code>, <code>creationTimeMillis</code>, <code>playerSessionCount</code>, <code>hasAvailablePlayerSessions</code>.</p> </li>
/// <li> <p> <b>Comparator</b> -- Valid comparators are: <code>=</code>, <code><></code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>. </p> </li>
/// <li> <p> <b>Value</b> -- Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators <code>=</code> and <code><></code>. For example, the following filter expression searches on <code>gameSessionName</code>: "<code>FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'"</code>. </p> </li>
/// </ul>
/// <p>To chain multiple conditions in a single expression, use the logical keywords <code>AND</code>, <code>OR</code>, and <code>NOT</code> and parentheses as needed. For example: <code>x AND y AND NOT z</code>, <code>NOT (x OR y)</code>.</p>
/// <p>Session search evaluates conditions from left to right using the following precedence rules:</p>
/// <ol>
/// <li> <p> <code>=</code>, <code><></code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code> </p> </li>
/// <li> <p>Parentheses</p> </li>
/// <li> <p>NOT</p> </li>
/// <li> <p>AND</p> </li>
/// <li> <p>OR</p> </li>
/// </ol>
/// <p>For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: <code>"maximumSessions>=10 AND hasAvailablePlayerSessions=true"</code>. </p>
pub fn set_filter_expression(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_filter_expression(input);
self
}
/// <p>Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:</p>
/// <ul>
/// <li> <p> <b>Operand</b> -- Name of a game session attribute. Valid values are <code>gameSessionName</code>, <code>gameSessionId</code>, <code>gameSessionProperties</code>, <code>maximumSessions</code>, <code>creationTimeMillis</code>, <code>playerSessionCount</code>, <code>hasAvailablePlayerSessions</code>.</p> </li>
/// <li> <p> <b>Order</b> -- Valid sort orders are <code>ASC</code> (ascending) and <code>DESC</code> (descending).</p> </li>
/// </ul>
/// <p>For example, this sort expression returns the oldest active sessions first: <code>"SortExpression": "creationTimeMillis ASC"</code>. Results with a null value for the sort operand are returned at the end of the list.</p>
pub fn sort_expression(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.sort_expression(input.into());
self
}
/// <p>Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:</p>
/// <ul>
/// <li> <p> <b>Operand</b> -- Name of a game session attribute. Valid values are <code>gameSessionName</code>, <code>gameSessionId</code>, <code>gameSessionProperties</code>, <code>maximumSessions</code>, <code>creationTimeMillis</code>, <code>playerSessionCount</code>, <code>hasAvailablePlayerSessions</code>.</p> </li>
/// <li> <p> <b>Order</b> -- Valid sort orders are <code>ASC</code> (ascending) and <code>DESC</code> (descending).</p> </li>
/// </ul>
/// <p>For example, this sort expression returns the oldest active sessions first: <code>"SortExpression": "creationTimeMillis ASC"</code>. Results with a null value for the sort operand are returned at the end of the list.</p>
pub fn set_sort_expression(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_sort_expression(input);
self
}
/// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher than 20. </p>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher than 20. </p>
pub fn set_limit(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <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>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <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>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
}
/// Fluent builder constructing a request to `StartFleetActions`.
///
/// <p>Resumes certain types of activity on fleet instances that were suspended with <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html">StopFleetActions</a>. For multi-location fleets, fleet actions are managed separately for each location. Currently, this operation is used to restart a fleet's auto-scaling activity.</p>
/// <p>This operation can be used in the following ways: </p>
/// <ul>
/// <li> <p>To restart actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to resume. </p> </li>
/// <li> <p>To restart actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to resume. </p> </li>
/// </ul>
/// <p>If successful, GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet location were never stopped, this operation will have no effect.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct StartFleetActions {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::start_fleet_actions_input::Builder,
}
impl StartFleetActions {
/// Creates a new `StartFleetActions`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::StartFleetActions,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::StartFleetActionsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::StartFleetActionsOutput,
aws_smithy_http::result::SdkError<crate::error::StartFleetActionsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet to restart actions on. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to restart actions on. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// Appends an item to `Actions`.
///
/// To override the contents of this collection use [`set_actions`](Self::set_actions).
///
/// <p>List of actions to restart on the fleet.</p>
pub fn actions(mut self, input: crate::model::FleetAction) -> Self {
self.inner = self.inner.actions(input);
self
}
/// <p>List of actions to restart on the fleet.</p>
pub fn set_actions(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::FleetAction>>,
) -> Self {
self.inner = self.inner.set_actions(input);
self
}
/// <p>The fleet location to restart fleet actions for. Specify a location in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
pub fn location(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.location(input.into());
self
}
/// <p>The fleet location to restart fleet actions for. Specify a location in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
pub fn set_location(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_location(input);
self
}
}
/// Fluent builder constructing a request to `StartGameSessionPlacement`.
///
/// <p>Places a request for a new game session in a queue. When processing a placement request, Amazon GameLift searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out.</p>
/// <p>A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request.</p>
/// <p>When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order.</p>
/// <p>Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant Regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a Region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each Region's average lag for all players and reorders to get the best game play across all players. </p>
/// <p>To place a new game session request, specify the following:</p>
/// <ul>
/// <li> <p>The queue name and a set of game session properties and settings</p> </li>
/// <li> <p>A unique ID (such as a UUID) for the placement. You use this ID to track the status of the placement request</p> </li>
/// <li> <p>(Optional) A set of player data and a unique player ID for each player that you are joining to the new game session (player data is optional, but if you include it, you must also provide a unique ID for each player)</p> </li>
/// <li> <p>Latency data for all players (if you want to optimize game play for the players)</p> </li>
/// </ul>
/// <p>If successful, a new game session placement is created.</p>
/// <p>To track the status of a placement request, call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html">DescribeGameSessionPlacement</a> and check the request's status. If the status is <code>FULFILLED</code>, a new game session has been created and a game session ARN and Region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue. </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct StartGameSessionPlacement {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::start_game_session_placement_input::Builder,
}
impl StartGameSessionPlacement {
/// Creates a new `StartGameSessionPlacement`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::StartGameSessionPlacement,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::StartGameSessionPlacementError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::StartGameSessionPlacementOutput,
aws_smithy_http::result::SdkError<crate::error::StartGameSessionPlacementError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all Regions and cannot be reused.</p>
pub fn placement_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.placement_id(input.into());
self
}
/// <p>A unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all Regions and cannot be reused.</p>
pub fn set_placement_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_placement_id(input);
self
}
/// <p>Name of the queue to use to place the new game session. You can use either the queue name or ARN value. </p>
pub fn game_session_queue_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_session_queue_name(input.into());
self
}
/// <p>Name of the queue to use to place the new game session. You can use either the queue name or ARN value. </p>
pub fn set_game_session_queue_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_session_queue_name(input);
self
}
/// Appends an item to `GameProperties`.
///
/// To override the contents of this collection use [`set_game_properties`](Self::set_game_properties).
///
/// <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</p>
pub fn game_properties(mut self, input: crate::model::GameProperty) -> Self {
self.inner = self.inner.game_properties(input);
self
}
/// <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</p>
pub fn set_game_properties(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::GameProperty>>,
) -> Self {
self.inner = self.inner.set_game_properties(input);
self
}
/// <p>The maximum number of players that can be connected simultaneously to the game session.</p>
pub fn maximum_player_session_count(mut self, input: i32) -> Self {
self.inner = self.inner.maximum_player_session_count(input);
self
}
/// <p>The maximum number of players that can be connected simultaneously to the game session.</p>
pub fn set_maximum_player_session_count(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_maximum_player_session_count(input);
self
}
/// <p>A descriptive label that is associated with a game session. Session names do not need to be unique.</p>
pub fn game_session_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_session_name(input.into());
self
}
/// <p>A descriptive label that is associated with a game session. Session names do not need to be unique.</p>
pub fn set_game_session_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_session_name(input);
self
}
/// Appends an item to `PlayerLatencies`.
///
/// To override the contents of this collection use [`set_player_latencies`](Self::set_player_latencies).
///
/// <p>A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players. </p>
pub fn player_latencies(mut self, input: crate::model::PlayerLatency) -> Self {
self.inner = self.inner.player_latencies(input);
self
}
/// <p>A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players. </p>
pub fn set_player_latencies(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::PlayerLatency>>,
) -> Self {
self.inner = self.inner.set_player_latencies(input);
self
}
/// Appends an item to `DesiredPlayerSessions`.
///
/// To override the contents of this collection use [`set_desired_player_sessions`](Self::set_desired_player_sessions).
///
/// <p>Set of information on each player to create a player session for.</p>
pub fn desired_player_sessions(
mut self,
input: crate::model::DesiredPlayerSession,
) -> Self {
self.inner = self.inner.desired_player_sessions(input);
self
}
/// <p>Set of information on each player to create a player session for.</p>
pub fn set_desired_player_sessions(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::DesiredPlayerSession>>,
) -> Self {
self.inner = self.inner.set_desired_player_sessions(input);
self
}
/// <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the <code>GameSession</code> object with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</p>
pub fn game_session_data(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_session_data(input.into());
self
}
/// <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the <code>GameSession</code> object with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</p>
pub fn set_game_session_data(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_session_data(input);
self
}
}
/// Fluent builder constructing a request to `StartMatchBackfill`.
///
/// <p>Finds new players to fill open slots in currently running game sessions. The backfill match process is essentially identical to the process of forming new matches. Backfill requests use the same matchmaker that was used to make the original match, and they provide matchmaking data for all players currently in the game session. FlexMatch uses this information to select new players so that backfilled match continues to meet the original match requirements. </p>
/// <p>When using FlexMatch with GameLift managed hosting, you can request a backfill match from a client service by calling this operation with a <code>GameSessions</code> ID. You also have the option of making backfill requests directly from your game server. In response to a request, FlexMatch creates player sessions for the new players, updates the <code>GameSession</code> resource, and sends updated matchmaking data to the game server. You can request a backfill match at any point after a game session is started. Each game session can have only one active backfill request at a time; a subsequent request automatically replaces the earlier request.</p>
/// <p>When using FlexMatch as a standalone component, request a backfill match by calling this operation without a game session identifier. As with newly formed matches, matchmaking results are returned in a matchmaking event so that your game can update the game session that is being backfilled.</p>
/// <p>To request a backfill match, specify a unique ticket ID, the original matchmaking configuration, and matchmaking data for all current players in the game session being backfilled. Optionally, specify the <code>GameSession</code> ARN. If successful, a match backfill ticket is created and returned with status set to QUEUED. Track the status of backfill tickets using the same method for tracking tickets for new matches.</p>
/// <p>Only game sessions created by FlexMatch are supported for match backfill.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html"> Backfill existing games with FlexMatch</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html"> Matchmaking events</a> (reference)</p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html"> How GameLift FlexMatch works</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct StartMatchBackfill {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::start_match_backfill_input::Builder,
}
impl StartMatchBackfill {
/// Creates a new `StartMatchBackfill`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::StartMatchBackfill,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::StartMatchBackfillError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::StartMatchBackfillOutput,
aws_smithy_http::result::SdkError<crate::error::StartMatchBackfillError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.</p>
pub fn ticket_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.ticket_id(input.into());
self
}
/// <p>A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.</p>
pub fn set_ticket_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_ticket_id(input);
self
}
/// <p>Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the <code>GameSession</code> object, <code>MatchmakerData</code> property.</p>
pub fn configuration_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.configuration_name(input.into());
self
}
/// <p>Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the <code>GameSession</code> object, <code>MatchmakerData</code> property.</p>
pub fn set_configuration_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_configuration_name(input);
self
}
/// <p>A unique identifier for the game session. Use the game session ID. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed. </p>
pub fn game_session_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_session_arn(input.into());
self
}
/// <p>A unique identifier for the game session. Use the game session ID. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed. </p>
pub fn set_game_session_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_session_arn(input);
self
}
/// Appends an item to `Players`.
///
/// To override the contents of this collection use [`set_players`](Self::set_players).
///
/// <p>Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.</p>
/// <p>You can include up to 199 <code>Players</code> in a <code>StartMatchBackfill</code> request.</p>
/// <ul>
/// <li> <p>PlayerID, PlayerAttributes, Team -- This information is maintained in the <code>GameSession</code> object, <code>MatchmakerData</code> property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data"> Match Data</a>. </p> <p>The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.</p> </li>
/// <li> <p>LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.</p> </li>
/// </ul>
pub fn players(mut self, input: crate::model::Player) -> Self {
self.inner = self.inner.players(input);
self
}
/// <p>Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.</p>
/// <p>You can include up to 199 <code>Players</code> in a <code>StartMatchBackfill</code> request.</p>
/// <ul>
/// <li> <p>PlayerID, PlayerAttributes, Team -- This information is maintained in the <code>GameSession</code> object, <code>MatchmakerData</code> property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data"> Match Data</a>. </p> <p>The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.</p> </li>
/// <li> <p>LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.</p> </li>
/// </ul>
pub fn set_players(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::Player>>,
) -> Self {
self.inner = self.inner.set_players(input);
self
}
}
/// Fluent builder constructing a request to `StartMatchmaking`.
///
/// <p>Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use GameLift managed hosting, this operation also triggers GameLift to find hosting resources and start a new game session for the new match. Each matchmaking request includes information on one or more players and specifies the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to build a match that includes all players in the request, placing them in the same team and finding additional players as needed to fill the match. </p>
/// <p>To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include any player attributes that are required by the matchmaking configuration's rule set. If successful, a matchmaking ticket is returned with status set to <code>QUEUED</code>. </p>
/// <p>Track matchmaking events to respond as needed and acquire game session connection information for successfully completed matches. Ticket status updates are tracked using event notification through Amazon Simple Notification Service, which is defined in the matchmaking configuration.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html"> Add FlexMatch to a game client</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Set Up FlexMatch event notification</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html"> How GameLift FlexMatch works</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct StartMatchmaking {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::start_matchmaking_input::Builder,
}
impl StartMatchmaking {
/// Creates a new `StartMatchmaking`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::StartMatchmaking,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::StartMatchmakingError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::StartMatchmakingOutput,
aws_smithy_http::result::SdkError<crate::error::StartMatchmakingError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.</p>
pub fn ticket_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.ticket_id(input.into());
self
}
/// <p>A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.</p>
pub fn set_ticket_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_ticket_id(input);
self
}
/// <p>Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same Region as this request. You can use either the configuration name or ARN value.</p>
pub fn configuration_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.configuration_name(input.into());
self
}
/// <p>Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same Region as this request. You can use either the configuration name or ARN value.</p>
pub fn set_configuration_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_configuration_name(input);
self
}
/// Appends an item to `Players`.
///
/// To override the contents of this collection use [`set_players`](Self::set_players).
///
/// <p>Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, <code>Player</code> objects contain the name of the team the player is assigned to.</p>
/// <p>You can include up to 10 <code>Players</code> in a <code>StartMatchmaking</code> request.</p>
pub fn players(mut self, input: crate::model::Player) -> Self {
self.inner = self.inner.players(input);
self
}
/// <p>Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, <code>Player</code> objects contain the name of the team the player is assigned to.</p>
/// <p>You can include up to 10 <code>Players</code> in a <code>StartMatchmaking</code> request.</p>
pub fn set_players(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::Player>>,
) -> Self {
self.inner = self.inner.set_players(input);
self
}
}
/// Fluent builder constructing a request to `StopFleetActions`.
///
/// <p>Suspends certain types of activity in a fleet location. Currently, this operation is used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed separately for each location. </p>
/// <p>Stopping fleet actions has several potential purposes. It allows you to temporarily stop auto-scaling activity but retain your scaling policies for use in the future. For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it for certain locations. </p>
/// <p>This operation can be used in the following ways: </p>
/// <ul>
/// <li> <p>To stop actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to suspend. </p> </li>
/// <li> <p>To stop actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to suspend. </p> </li>
/// </ul>
/// <p>If successful, GameLift no longer initiates scaling events except in response to manual changes using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html">UpdateFleetCapacity</a>.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift Fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct StopFleetActions {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::stop_fleet_actions_input::Builder,
}
impl StopFleetActions {
/// Creates a new `StopFleetActions`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::StopFleetActions,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::StopFleetActionsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::StopFleetActionsOutput,
aws_smithy_http::result::SdkError<crate::error::StopFleetActionsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet to stop actions on. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to stop actions on. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// Appends an item to `Actions`.
///
/// To override the contents of this collection use [`set_actions`](Self::set_actions).
///
/// <p>List of actions to suspend on the fleet. </p>
pub fn actions(mut self, input: crate::model::FleetAction) -> Self {
self.inner = self.inner.actions(input);
self
}
/// <p>List of actions to suspend on the fleet. </p>
pub fn set_actions(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::FleetAction>>,
) -> Self {
self.inner = self.inner.set_actions(input);
self
}
/// <p>The fleet location to stop fleet actions for. Specify a location in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
pub fn location(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.location(input.into());
self
}
/// <p>The fleet location to stop fleet actions for. Specify a location in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
pub fn set_location(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_location(input);
self
}
}
/// Fluent builder constructing a request to `StopGameSessionPlacement`.
///
/// <p>Cancels a game session placement that is in <code>PENDING</code> status. To stop a placement, provide the placement ID values. If successful, the placement is moved to <code>CANCELLED</code> status.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct StopGameSessionPlacement {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::stop_game_session_placement_input::Builder,
}
impl StopGameSessionPlacement {
/// Creates a new `StopGameSessionPlacement`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::StopGameSessionPlacement,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::StopGameSessionPlacementError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::StopGameSessionPlacementOutput,
aws_smithy_http::result::SdkError<crate::error::StopGameSessionPlacementError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for a game session placement to stop.</p>
pub fn placement_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.placement_id(input.into());
self
}
/// <p>A unique identifier for a game session placement to stop.</p>
pub fn set_placement_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_placement_id(input);
self
}
}
/// Fluent builder constructing a request to `StopMatchmaking`.
///
/// <p>Cancels a matchmaking ticket or match backfill ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to <code>CANCELLED</code>.</p>
/// <p>This call is also used to turn off automatic backfill for an individual game session. This is for game sessions that are created with a matchmaking configuration that has automatic backfill enabled. The ticket ID is included in the <code>MatchmakerData</code> of an updated game session object, which is provided to the game server.</p> <note>
/// <p>If the operation is successful, the service sends back an empty JSON struct with the HTTP 200 response (not an empty HTTP body).</p>
/// </note>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html"> Add FlexMatch to a game client</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct StopMatchmaking {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::stop_matchmaking_input::Builder,
}
impl StopMatchmaking {
/// Creates a new `StopMatchmaking`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::StopMatchmaking,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::StopMatchmakingError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::StopMatchmakingOutput,
aws_smithy_http::result::SdkError<crate::error::StopMatchmakingError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for a matchmaking ticket.</p>
pub fn ticket_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.ticket_id(input.into());
self
}
/// <p>A unique identifier for a matchmaking ticket.</p>
pub fn set_ticket_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_ticket_id(input);
self
}
}
/// Fluent builder constructing a request to `SuspendGameServerGroup`.
///
/// <p> <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b> </p>
/// <p>Temporarily stops activity on a game server group without terminating instances or the game server group. You can restart activity by calling <a href="gamelift/latest/apireference/API_ResumeGameServerGroup.html">ResumeGameServerGroup</a>. You can suspend the following activity:</p>
/// <ul>
/// <li> <p> <b>Instance type replacement</b> - This activity evaluates the current game hosting viability of all Spot instance types that are defined for the game server group. It updates the Auto Scaling group to remove nonviable Spot Instance types, which have a higher chance of game server interruptions. It then balances capacity across the remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling group continues with its current balance, regardless of viability. Instance protection, utilization metrics, and capacity scaling activities continue to be active. </p> </li>
/// </ul>
/// <p>To suspend activity, specify a game server group ARN and the type of activity to be suspended. If successful, a <code>GameServerGroup</code> object is returned showing that the activity is listed in <code>SuspendedActions</code>.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ Guide</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct SuspendGameServerGroup {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::suspend_game_server_group_input::Builder,
}
impl SuspendGameServerGroup {
/// Creates a new `SuspendGameServerGroup`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::SuspendGameServerGroup,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::SuspendGameServerGroupError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::SuspendGameServerGroupOutput,
aws_smithy_http::result::SdkError<crate::error::SuspendGameServerGroupError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
pub fn game_server_group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_group_name(input.into());
self
}
/// <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
pub fn set_game_server_group_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_group_name(input);
self
}
/// Appends an item to `SuspendActions`.
///
/// To override the contents of this collection use [`set_suspend_actions`](Self::set_suspend_actions).
///
/// <p>The activity to suspend for this game server group.</p>
pub fn suspend_actions(mut self, input: crate::model::GameServerGroupAction) -> Self {
self.inner = self.inner.suspend_actions(input);
self
}
/// <p>The activity to suspend for this game server group.</p>
pub fn set_suspend_actions(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::GameServerGroupAction>>,
) -> Self {
self.inner = self.inner.set_suspend_actions(input);
self
}
}
/// Fluent builder constructing a request to `TagResource`.
///
/// <p> Assigns a tag to a GameLift resource. Amazon Web Services resource tags provide an additional management tool set. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, etc. This operation handles the permissions necessary to manage tags for the following GameLift resource types:</p>
/// <ul>
/// <li> <p>Build</p> </li>
/// <li> <p>Script</p> </li>
/// <li> <p>Fleet</p> </li>
/// <li> <p>Alias</p> </li>
/// <li> <p>GameSessionQueue</p> </li>
/// <li> <p>MatchmakingConfiguration</p> </li>
/// <li> <p>MatchmakingRuleSet</p> </li>
/// </ul>
/// <p>To add a tag to a resource, specify the unique ARN value for the resource and provide a tag list containing one or more tags. The operation succeeds even if the list includes tags that are already assigned to the specified resource. </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i> </p>
/// <p> <a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/"> Amazon Web Services Tagging Strategies</a> </p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct TagResource {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::tag_resource_input::Builder,
}
impl TagResource {
/// Creates a new `TagResource`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::TagResource,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::TagResourceError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::TagResourceOutput,
aws_smithy_http::result::SdkError<crate::error::TagResourceError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <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 and uniquely identifies the GameLift resource that you want to assign tags to. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type. </p>
pub fn resource_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.resource_arn(input.into());
self
}
/// <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 and uniquely identifies the GameLift resource that you want to assign tags to. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type. </p>
pub fn set_resource_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_resource_arn(input);
self
}
/// Appends an item to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>A list of one or more tags to assign to the specified GameLift resource. Tags are developer-defined and structured as key-value pairs. The maximum tag limit may be lower than stated. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> for actual tagging limits.</p>
pub fn tags(mut self, input: crate::model::Tag) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>A list of one or more tags to assign to the specified GameLift resource. Tags are developer-defined and structured as key-value pairs. The maximum tag limit may be lower than stated. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> for actual tagging limits.</p>
pub fn set_tags(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::Tag>>,
) -> Self {
self.inner = self.inner.set_tags(input);
self
}
}
/// Fluent builder constructing a request to `UntagResource`.
///
/// <p>Removes a tag that is assigned to a GameLift resource. Resource tags are used to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:</p>
/// <ul>
/// <li> <p>Build</p> </li>
/// <li> <p>Script</p> </li>
/// <li> <p>Fleet</p> </li>
/// <li> <p>Alias</p> </li>
/// <li> <p>GameSessionQueue</p> </li>
/// <li> <p>MatchmakingConfiguration</p> </li>
/// <li> <p>MatchmakingRuleSet</p> </li>
/// </ul>
/// <p>To remove a tag from a resource, specify the unique ARN value for the resource and provide a string list containing one or more tags to be removed. This operation succeeds even if the list includes tags that are not currently assigned to the specified resource.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i> </p>
/// <p> <a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/"> Amazon Web Services Tagging Strategies</a> </p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UntagResource {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::untag_resource_input::Builder,
}
impl UntagResource {
/// Creates a new `UntagResource`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UntagResource,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UntagResourceError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UntagResourceOutput,
aws_smithy_http::result::SdkError<crate::error::UntagResourceError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <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 and uniquely identifies the GameLift resource that you want to remove tags from. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type. </p>
pub fn resource_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.resource_arn(input.into());
self
}
/// <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 and uniquely identifies the GameLift resource that you want to remove tags from. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type. </p>
pub fn set_resource_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_resource_arn(input);
self
}
/// Appends an item to `TagKeys`.
///
/// To override the contents of this collection use [`set_tag_keys`](Self::set_tag_keys).
///
/// <p>A list of one or more tag keys to remove from the specified GameLift resource. An Amazon Web Services resource can have only one tag with a specific tag key, so specifying the tag key identifies which tag to remove. </p>
pub fn tag_keys(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.tag_keys(input.into());
self
}
/// <p>A list of one or more tag keys to remove from the specified GameLift resource. An Amazon Web Services resource can have only one tag with a specific tag key, so specifying the tag key identifies which tag to remove. </p>
pub fn set_tag_keys(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_tag_keys(input);
self
}
}
/// Fluent builder constructing a request to `UpdateAlias`.
///
/// <p>Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.</p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateAlias {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_alias_input::Builder,
}
impl UpdateAlias {
/// Creates a new `UpdateAlias`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateAlias,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateAliasError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateAliasOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateAliasError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the alias that you want to update. You can use either the alias ID or ARN value.</p>
pub fn alias_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.alias_id(input.into());
self
}
/// <p>A unique identifier for the alias that you want to update. You can use either the alias ID or ARN value.</p>
pub fn set_alias_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_alias_id(input);
self
}
/// <p>A descriptive label that is associated with an alias. Alias names do not need to be unique.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A descriptive label that is associated with an alias. Alias names do not need to be unique.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>A human-readable description of the alias.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.description(input.into());
self
}
/// <p>A human-readable description of the alias.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_description(input);
self
}
/// <p>The routing configuration, including routing type and fleet target, for the alias.</p>
pub fn routing_strategy(mut self, input: crate::model::RoutingStrategy) -> Self {
self.inner = self.inner.routing_strategy(input);
self
}
/// <p>The routing configuration, including routing type and fleet target, for the alias.</p>
pub fn set_routing_strategy(
mut self,
input: std::option::Option<crate::model::RoutingStrategy>,
) -> Self {
self.inner = self.inner.set_routing_strategy(input);
self
}
}
/// Fluent builder constructing a request to `UpdateBuild`.
///
/// <p>Updates metadata in a build resource, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html"> Upload a Custom Server Build</a> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateBuild {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_build_input::Builder,
}
impl UpdateBuild {
/// Creates a new `UpdateBuild`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateBuild,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateBuildError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateBuildOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateBuildError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the build to update. You can use either the build ID or ARN value. </p>
pub fn build_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.build_id(input.into());
self
}
/// <p>A unique identifier for the build to update. You can use either the build ID or ARN value. </p>
pub fn set_build_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_build_id(input);
self
}
/// <p>A descriptive label associated with a build. Build names do not need to be unique. </p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A descriptive label associated with a build. Build names do not need to be unique. </p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>Version information associated with a build or script. Version strings do not need to be unique.</p>
pub fn version(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.version(input.into());
self
}
/// <p>Version information associated with a build or script. Version strings do not need to be unique.</p>
pub fn set_version(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_version(input);
self
}
}
/// Fluent builder constructing a request to `UpdateFleetAttributes`.
///
/// <p>Updates a fleet's mutable attributes, including game session protection and resource creation limits.</p>
/// <p>To update fleet attributes, specify the fleet ID and the property values that you want to change. </p>
/// <p>If successful, an updated <code>FleetAttributes</code> object is returned.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateFleetAttributes {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_fleet_attributes_input::Builder,
}
impl UpdateFleetAttributes {
/// Creates a new `UpdateFleetAttributes`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateFleetAttributes,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateFleetAttributesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateFleetAttributesOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateFleetAttributesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>A descriptive label that is associated with a fleet. Fleet names do not need to be unique.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A descriptive label that is associated with a fleet. Fleet names do not need to be unique.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>A human-readable description of a fleet.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.description(input.into());
self
}
/// <p>A human-readable description of a fleet.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_description(input);
self
}
/// <p>The game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a> .</p>
/// <ul>
/// <li> <p> <b>NoProtection</b> -- The game session can be terminated during a scale-down event.</p> </li>
/// <li> <p> <b>FullProtection</b> -- If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</p> </li>
/// </ul>
pub fn new_game_session_protection_policy(
mut self,
input: crate::model::ProtectionPolicy,
) -> Self {
self.inner = self.inner.new_game_session_protection_policy(input);
self
}
/// <p>The game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a> .</p>
/// <ul>
/// <li> <p> <b>NoProtection</b> -- The game session can be terminated during a scale-down event.</p> </li>
/// <li> <p> <b>FullProtection</b> -- If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</p> </li>
/// </ul>
pub fn set_new_game_session_protection_policy(
mut self,
input: std::option::Option<crate::model::ProtectionPolicy>,
) -> Self {
self.inner = self.inner.set_new_game_session_protection_policy(input);
self
}
/// <p>Policy settings that limit the number of game sessions an individual player can create over a span of time. </p>
pub fn resource_creation_limit_policy(
mut self,
input: crate::model::ResourceCreationLimitPolicy,
) -> Self {
self.inner = self.inner.resource_creation_limit_policy(input);
self
}
/// <p>Policy settings that limit the number of game sessions an individual player can create over a span of time. </p>
pub fn set_resource_creation_limit_policy(
mut self,
input: std::option::Option<crate::model::ResourceCreationLimitPolicy>,
) -> Self {
self.inner = self.inner.set_resource_creation_limit_policy(input);
self
}
/// Appends an item to `MetricGroups`.
///
/// To override the contents of this collection use [`set_metric_groups`](Self::set_metric_groups).
///
/// <p>The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.</p>
pub fn metric_groups(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.metric_groups(input.into());
self
}
/// <p>The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.</p>
pub fn set_metric_groups(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_metric_groups(input);
self
}
/// <p>GameLift Anywhere configuration options.</p>
pub fn anywhere_configuration(
mut self,
input: crate::model::AnywhereConfiguration,
) -> Self {
self.inner = self.inner.anywhere_configuration(input);
self
}
/// <p>GameLift Anywhere configuration options.</p>
pub fn set_anywhere_configuration(
mut self,
input: std::option::Option<crate::model::AnywhereConfiguration>,
) -> Self {
self.inner = self.inner.set_anywhere_configuration(input);
self
}
}
/// Fluent builder constructing a request to `UpdateFleetCapacity`.
///
/// <p>Updates capacity settings for a fleet. For fleets with multiple locations, use this operation to manage capacity settings in each location individually. Fleet capacity determines the number of game sessions and players that can be hosted based on the fleet configuration. Use this operation to set the following fleet capacity properties: </p>
/// <ul>
/// <li> <p>Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set the fleet's capacity to a value outside of this range, whether the capacity is changed manually or through automatic scaling. </p> </li>
/// <li> <p>Desired capacity: Manually set the number of Amazon EC2 instances to be maintained in a fleet location. Before changing a fleet's desired capacity, you may want to call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeEC2InstanceLimits.html">DescribeEC2InstanceLimits</a> to get the maximum capacity of the fleet's Amazon EC2 instance type. Alternatively, consider using automatic scaling to adjust capacity based on player demand.</p> </li>
/// </ul>
/// <p>This operation can be used in the following ways: </p>
/// <ul>
/// <li> <p>To update capacity for a fleet's home Region, or if the fleet has no remote locations, omit the <code>Location</code> parameter. The fleet must be in <code>ACTIVE</code> status. </p> </li>
/// <li> <p>To update capacity for a fleet's remote location, include the <code>Location</code> parameter set to the location to be updated. The location must be in <code>ACTIVE</code> status.</p> </li>
/// </ul>
/// <p>If successful, capacity settings are updated immediately. In response a change in desired capacity, GameLift initiates steps to start new instances or terminate existing instances in the requested fleet location. This continues until the location's active instance count matches the new desired instance count. You can track a fleet's current capacity by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html">DescribeFleetCapacity</a> or <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html">DescribeFleetLocationCapacity</a>. If the requested desired instance count is higher than the instance type's limit, the <code>LimitExceeded</code> exception occurs.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-manage-capacity.html">Scaling fleet capacity</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateFleetCapacity {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_fleet_capacity_input::Builder,
}
impl UpdateFleetCapacity {
/// Creates a new `UpdateFleetCapacity`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateFleetCapacity,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateFleetCapacityError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateFleetCapacityOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateFleetCapacityError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet to update capacity settings for. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to update capacity settings for. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>The number of Amazon EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.</p>
pub fn desired_instances(mut self, input: i32) -> Self {
self.inner = self.inner.desired_instances(input);
self
}
/// <p>The number of Amazon EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.</p>
pub fn set_desired_instances(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_desired_instances(input);
self
}
/// <p>The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.</p>
pub fn min_size(mut self, input: i32) -> Self {
self.inner = self.inner.min_size(input);
self
}
/// <p>The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.</p>
pub fn set_min_size(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_min_size(input);
self
}
/// <p>The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.</p>
pub fn max_size(mut self, input: i32) -> Self {
self.inner = self.inner.max_size(input);
self
}
/// <p>The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.</p>
pub fn set_max_size(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_size(input);
self
}
/// <p>The name of a remote location to update fleet capacity settings for, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>.</p>
pub fn location(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.location(input.into());
self
}
/// <p>The name of a remote location to update fleet capacity settings for, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>.</p>
pub fn set_location(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_location(input);
self
}
}
/// Fluent builder constructing a request to `UpdateFleetPortSettings`.
///
/// <p>Updates permissions that allow inbound traffic to connect to game sessions that are being hosted on instances in the fleet. </p>
/// <p>To update settings, specify the fleet ID to be updated and specify the changes to be made. List the permissions you want to add in <code>InboundPermissionAuthorizations</code>, and permissions you want to remove in <code>InboundPermissionRevocations</code>. Permissions to be removed must match existing fleet permissions. </p>
/// <p>If successful, the fleet ID for the updated fleet is returned. For fleets with remote locations, port setting updates can take time to propagate across all locations. You can check the status of updates in each location by calling <code>DescribeFleetPortSettings</code> with a location name.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateFleetPortSettings {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_fleet_port_settings_input::Builder,
}
impl UpdateFleetPortSettings {
/// Creates a new `UpdateFleetPortSettings`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateFleetPortSettings,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateFleetPortSettingsError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateFleetPortSettingsOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateFleetPortSettingsError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet to update port settings for. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to update port settings for. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// Appends an item to `InboundPermissionAuthorizations`.
///
/// To override the contents of this collection use [`set_inbound_permission_authorizations`](Self::set_inbound_permission_authorizations).
///
/// <p>A collection of port settings to be added to the fleet resource.</p>
pub fn inbound_permission_authorizations(
mut self,
input: crate::model::IpPermission,
) -> Self {
self.inner = self.inner.inbound_permission_authorizations(input);
self
}
/// <p>A collection of port settings to be added to the fleet resource.</p>
pub fn set_inbound_permission_authorizations(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::IpPermission>>,
) -> Self {
self.inner = self.inner.set_inbound_permission_authorizations(input);
self
}
/// Appends an item to `InboundPermissionRevocations`.
///
/// To override the contents of this collection use [`set_inbound_permission_revocations`](Self::set_inbound_permission_revocations).
///
/// <p>A collection of port settings to be removed from the fleet resource.</p>
pub fn inbound_permission_revocations(mut self, input: crate::model::IpPermission) -> Self {
self.inner = self.inner.inbound_permission_revocations(input);
self
}
/// <p>A collection of port settings to be removed from the fleet resource.</p>
pub fn set_inbound_permission_revocations(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::IpPermission>>,
) -> Self {
self.inner = self.inner.set_inbound_permission_revocations(input);
self
}
}
/// Fluent builder constructing a request to `UpdateGameServer`.
///
/// <p> <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b> </p>
/// <p>Updates information about a registered game server to help GameLift FleetIQ to track game server availability. This operation is called by a game server process that is running on an instance in a game server group. </p>
/// <p>Use this operation to update the following types of game server information. You can make all three types of updates in the same request:</p>
/// <ul>
/// <li> <p>To update the game server's utilization status, identify the game server and game server group and specify the current utilization status. Use this status to identify when game servers are currently hosting games and when they are available to be claimed.</p> </li>
/// <li> <p>To report health status, identify the game server and game server group and set health check to <code>HEALTHY</code>. If a game server does not report health status for a certain length of time, the game server is no longer considered healthy. As a result, it will be eventually deregistered from the game server group to avoid affecting utilization metrics. The best practice is to report health every 60 seconds.</p> </li>
/// <li> <p>To change game server metadata, provide updated game server data.</p> </li>
/// </ul>
/// <p>Once a game server is successfully updated, the relevant statuses and timestamps are updated.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ Guide</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateGameServer {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_game_server_input::Builder,
}
impl UpdateGameServer {
/// Creates a new `UpdateGameServer`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateGameServer,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateGameServerError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateGameServerOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateGameServerError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the game server group where the game server is running.</p>
pub fn game_server_group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_group_name(input.into());
self
}
/// <p>A unique identifier for the game server group where the game server is running.</p>
pub fn set_game_server_group_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_group_name(input);
self
}
/// <p>A custom string that uniquely identifies the game server to update.</p>
pub fn game_server_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_id(input.into());
self
}
/// <p>A custom string that uniquely identifies the game server to update.</p>
pub fn set_game_server_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_id(input);
self
}
/// <p>A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers. </p>
pub fn game_server_data(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_data(input.into());
self
}
/// <p>A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers. </p>
pub fn set_game_server_data(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_data(input);
self
}
/// <p>Indicates whether the game server is available or is currently hosting gameplay.</p>
pub fn utilization_status(
mut self,
input: crate::model::GameServerUtilizationStatus,
) -> Self {
self.inner = self.inner.utilization_status(input);
self
}
/// <p>Indicates whether the game server is available or is currently hosting gameplay.</p>
pub fn set_utilization_status(
mut self,
input: std::option::Option<crate::model::GameServerUtilizationStatus>,
) -> Self {
self.inner = self.inner.set_utilization_status(input);
self
}
/// <p>Indicates health status of the game server. A request that includes this parameter updates the game server's <i>LastHealthCheckTime</i> timestamp. </p>
pub fn health_check(mut self, input: crate::model::GameServerHealthCheck) -> Self {
self.inner = self.inner.health_check(input);
self
}
/// <p>Indicates health status of the game server. A request that includes this parameter updates the game server's <i>LastHealthCheckTime</i> timestamp. </p>
pub fn set_health_check(
mut self,
input: std::option::Option<crate::model::GameServerHealthCheck>,
) -> Self {
self.inner = self.inner.set_health_check(input);
self
}
}
/// Fluent builder constructing a request to `UpdateGameServerGroup`.
///
/// <p> <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b> </p>
/// <p>Updates GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group properties are updated on the Auto Scaling group directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired instance counts.</p>
/// <p>To update the game server group, specify the game server group ID and provide the updated values. Before applying the updates, the new values are validated to ensure that GameLift FleetIQ can continue to perform instance balancing activity. If successful, a <code>GameServerGroup</code> object is returned.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ Guide</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateGameServerGroup {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_game_server_group_input::Builder,
}
impl UpdateGameServerGroup {
/// Creates a new `UpdateGameServerGroup`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateGameServerGroup,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateGameServerGroupError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateGameServerGroupOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateGameServerGroupError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
pub fn game_server_group_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_server_group_name(input.into());
self
}
/// <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
pub fn set_game_server_group_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_server_group_name(input);
self
}
/// <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.</p>
pub fn role_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.role_arn(input.into());
self
}
/// <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.</p>
pub fn set_role_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_role_arn(input);
self
}
/// Appends an item to `InstanceDefinitions`.
///
/// To override the contents of this collection use [`set_instance_definitions`](Self::set_instance_definitions).
///
/// <p>An updated list of Amazon EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">EC2 Instance Types</a> in the <i>Amazon EC2 User Guide</i>. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html"> Instance Weighting for Amazon EC2 Auto Scaling</a> in the Amazon EC2 Auto Scaling User Guide.</p>
pub fn instance_definitions(mut self, input: crate::model::InstanceDefinition) -> Self {
self.inner = self.inner.instance_definitions(input);
self
}
/// <p>An updated list of Amazon EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">EC2 Instance Types</a> in the <i>Amazon EC2 User Guide</i>. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html"> Instance Weighting for Amazon EC2 Auto Scaling</a> in the Amazon EC2 Auto Scaling User Guide.</p>
pub fn set_instance_definitions(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::InstanceDefinition>>,
) -> Self {
self.inner = self.inner.set_instance_definitions(input);
self
}
/// <p>A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by Amazon Web Services regardless of protection status. This property is set to <code>NO_PROTECTION</code> by default.</p>
pub fn game_server_protection_policy(
mut self,
input: crate::model::GameServerProtectionPolicy,
) -> Self {
self.inner = self.inner.game_server_protection_policy(input);
self
}
/// <p>A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by Amazon Web Services regardless of protection status. This property is set to <code>NO_PROTECTION</code> by default.</p>
pub fn set_game_server_protection_policy(
mut self,
input: std::option::Option<crate::model::GameServerProtectionPolicy>,
) -> Self {
self.inner = self.inner.set_game_server_protection_policy(input);
self
}
/// <p>Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:</p>
/// <ul>
/// <li> <p> <code>SPOT_ONLY</code> - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.</p> </li>
/// <li> <p> <code>SPOT_PREFERRED</code> - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.</p> </li>
/// <li> <p> <code>ON_DEMAND_ONLY</code> - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.</p> </li>
/// </ul>
pub fn balancing_strategy(mut self, input: crate::model::BalancingStrategy) -> Self {
self.inner = self.inner.balancing_strategy(input);
self
}
/// <p>Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:</p>
/// <ul>
/// <li> <p> <code>SPOT_ONLY</code> - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.</p> </li>
/// <li> <p> <code>SPOT_PREFERRED</code> - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.</p> </li>
/// <li> <p> <code>ON_DEMAND_ONLY</code> - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.</p> </li>
/// </ul>
pub fn set_balancing_strategy(
mut self,
input: std::option::Option<crate::model::BalancingStrategy>,
) -> Self {
self.inner = self.inner.set_balancing_strategy(input);
self
}
}
/// Fluent builder constructing a request to `UpdateGameSession`.
///
/// <p>Updates the mutable properties of a game session. </p>
/// <p>To update a game session, specify the game session ID and the values you want to change. </p>
/// <p>If successful, the updated <code>GameSession</code> object is returned. </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateGameSession {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_game_session_input::Builder,
}
impl UpdateGameSession {
/// Creates a new `UpdateGameSession`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateGameSession,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateGameSessionError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateGameSessionOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateGameSessionError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the game session to update. </p>
pub fn game_session_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_session_id(input.into());
self
}
/// <p>A unique identifier for the game session to update. </p>
pub fn set_game_session_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_session_id(input);
self
}
/// <p>The maximum number of players that can be connected simultaneously to the game session.</p>
pub fn maximum_player_session_count(mut self, input: i32) -> Self {
self.inner = self.inner.maximum_player_session_count(input);
self
}
/// <p>The maximum number of players that can be connected simultaneously to the game session.</p>
pub fn set_maximum_player_session_count(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_maximum_player_session_count(input);
self
}
/// <p>A descriptive label that is associated with a game session. Session names do not need to be unique.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A descriptive label that is associated with a game session. Session names do not need to be unique.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>A policy that determines whether the game session is accepting new players.</p>
pub fn player_session_creation_policy(
mut self,
input: crate::model::PlayerSessionCreationPolicy,
) -> Self {
self.inner = self.inner.player_session_creation_policy(input);
self
}
/// <p>A policy that determines whether the game session is accepting new players.</p>
pub fn set_player_session_creation_policy(
mut self,
input: std::option::Option<crate::model::PlayerSessionCreationPolicy>,
) -> Self {
self.inner = self.inner.set_player_session_creation_policy(input);
self
}
/// <p>Game session protection policy to apply to this game session only.</p>
/// <ul>
/// <li> <p> <b>NoProtection</b> -- The game session can be terminated during a scale-down event.</p> </li>
/// <li> <p> <b>FullProtection</b> -- If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</p> </li>
/// </ul>
pub fn protection_policy(mut self, input: crate::model::ProtectionPolicy) -> Self {
self.inner = self.inner.protection_policy(input);
self
}
/// <p>Game session protection policy to apply to this game session only.</p>
/// <ul>
/// <li> <p> <b>NoProtection</b> -- The game session can be terminated during a scale-down event.</p> </li>
/// <li> <p> <b>FullProtection</b> -- If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</p> </li>
/// </ul>
pub fn set_protection_policy(
mut self,
input: std::option::Option<crate::model::ProtectionPolicy>,
) -> Self {
self.inner = self.inner.set_protection_policy(input);
self
}
}
/// Fluent builder constructing a request to `UpdateGameSessionQueue`.
///
/// <p>Updates the configuration of a game session queue, which determines how the queue processes new game session requests. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations. </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html"> Using Multi-Region Queues</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateGameSessionQueue {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_game_session_queue_input::Builder,
}
impl UpdateGameSessionQueue {
/// Creates a new `UpdateGameSessionQueue`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateGameSessionQueue,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateGameSessionQueueError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateGameSessionQueueOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateGameSessionQueueError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value. </p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value. </p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a <code>TIMED_OUT</code> status.</p>
pub fn timeout_in_seconds(mut self, input: i32) -> Self {
self.inner = self.inner.timeout_in_seconds(input);
self
}
/// <p>The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a <code>TIMED_OUT</code> status.</p>
pub fn set_timeout_in_seconds(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_timeout_in_seconds(input);
self
}
/// Appends an item to `PlayerLatencyPolicies`.
///
/// To override the contents of this collection use [`set_player_latency_policies`](Self::set_player_latency_policies).
///
/// <p>A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.</p>
pub fn player_latency_policies(mut self, input: crate::model::PlayerLatencyPolicy) -> Self {
self.inner = self.inner.player_latency_policies(input);
self
}
/// <p>A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.</p>
pub fn set_player_latency_policies(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::PlayerLatencyPolicy>>,
) -> Self {
self.inner = self.inner.set_player_latency_policies(input);
self
}
/// Appends an item to `Destinations`.
///
/// To override the contents of this collection use [`set_destinations`](Self::set_destinations).
///
/// <p>A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. When updating this list, provide a complete list of destinations.</p>
pub fn destinations(mut self, input: crate::model::GameSessionQueueDestination) -> Self {
self.inner = self.inner.destinations(input);
self
}
/// <p>A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. When updating this list, provide a complete list of destinations.</p>
pub fn set_destinations(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::GameSessionQueueDestination>>,
) -> Self {
self.inner = self.inner.set_destinations(input);
self
}
/// <p>A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as <code>us-west-2</code>. If this parameter is not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.</p>
pub fn filter_configuration(mut self, input: crate::model::FilterConfiguration) -> Self {
self.inner = self.inner.filter_configuration(input);
self
}
/// <p>A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as <code>us-west-2</code>. If this parameter is not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.</p>
pub fn set_filter_configuration(
mut self,
input: std::option::Option<crate::model::FilterConfiguration>,
) -> Self {
self.inner = self.inner.set_filter_configuration(input);
self
}
/// <p>Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. To remove an existing priority configuration, pass in an empty set.</p>
pub fn priority_configuration(
mut self,
input: crate::model::PriorityConfiguration,
) -> Self {
self.inner = self.inner.priority_configuration(input);
self
}
/// <p>Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. To remove an existing priority configuration, pass in an empty set.</p>
pub fn set_priority_configuration(
mut self,
input: std::option::Option<crate::model::PriorityConfiguration>,
) -> Self {
self.inner = self.inner.set_priority_configuration(input);
self
}
/// <p>Information to be added to all events that are related to this game session queue.</p>
pub fn custom_event_data(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.custom_event_data(input.into());
self
}
/// <p>Information to be added to all events that are related to this game session queue.</p>
pub fn set_custom_event_data(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_custom_event_data(input);
self
}
/// <p>An SNS topic ARN that is set up to receive game session placement notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html"> Setting up notifications for game session placement</a>.</p>
pub fn notification_target(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.notification_target(input.into());
self
}
/// <p>An SNS topic ARN that is set up to receive game session placement notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html"> Setting up notifications for game session placement</a>.</p>
pub fn set_notification_target(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_notification_target(input);
self
}
}
/// Fluent builder constructing a request to `UpdateMatchmakingConfiguration`.
///
/// <p>Updates settings for a FlexMatch matchmaking configuration. These changes affect all matches and game sessions that are created after the update. To update settings, specify the configuration name to be updated and provide the new settings. </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html"> Design a FlexMatch matchmaker</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateMatchmakingConfiguration {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_matchmaking_configuration_input::Builder,
}
impl UpdateMatchmakingConfiguration {
/// Creates a new `UpdateMatchmakingConfiguration`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateMatchmakingConfiguration,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateMatchmakingConfigurationError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateMatchmakingConfigurationOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateMatchmakingConfigurationError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the matchmaking configuration to update. You can use either the configuration name or ARN value. </p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A unique identifier for the matchmaking configuration to update. You can use either the configuration name or ARN value. </p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>A description for the matchmaking configuration.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.description(input.into());
self
}
/// <p>A description for the matchmaking configuration.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_description(input);
self
}
/// Appends an item to `GameSessionQueueArns`.
///
/// To override the contents of this collection use [`set_game_session_queue_arns`](Self::set_game_session_queue_arns).
///
/// <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 GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:
/// <region>
/// ::gamesessionqueue/
/// <queue name></queue>
/// </region></code>. Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If <code>FlexMatchMode</code> is set to <code>STANDALONE</code>, do not set this parameter.</p>
pub fn game_session_queue_arns(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_session_queue_arns(input.into());
self
}
/// <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 GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:
/// <region>
/// ::gamesessionqueue/
/// <queue name></queue>
/// </region></code>. Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If <code>FlexMatchMode</code> is set to <code>STANDALONE</code>, do not set this parameter.</p>
pub fn set_game_session_queue_arns(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_game_session_queue_arns(input);
self
}
/// <p>The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.</p>
pub fn request_timeout_seconds(mut self, input: i32) -> Self {
self.inner = self.inner.request_timeout_seconds(input);
self
}
/// <p>The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.</p>
pub fn set_request_timeout_seconds(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_request_timeout_seconds(input);
self
}
/// <p>The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.</p>
pub fn acceptance_timeout_seconds(mut self, input: i32) -> Self {
self.inner = self.inner.acceptance_timeout_seconds(input);
self
}
/// <p>The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.</p>
pub fn set_acceptance_timeout_seconds(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_acceptance_timeout_seconds(input);
self
}
/// <p>A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. With this option enabled, matchmaking tickets use the status <code>REQUIRES_ACCEPTANCE</code> to indicate when a completed potential match is waiting for player acceptance. </p>
pub fn acceptance_required(mut self, input: bool) -> Self {
self.inner = self.inner.acceptance_required(input);
self
}
/// <p>A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. With this option enabled, matchmaking tickets use the status <code>REQUIRES_ACCEPTANCE</code> to indicate when a completed potential match is waiting for player acceptance. </p>
pub fn set_acceptance_required(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_acceptance_required(input);
self
}
/// <p>A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.</p>
pub fn rule_set_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.rule_set_name(input.into());
self
}
/// <p>A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.</p>
pub fn set_rule_set_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_rule_set_name(input);
self
}
/// <p>An SNS topic ARN that is set up to receive matchmaking notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Setting up notifications for matchmaking</a> for more information.</p>
pub fn notification_target(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.notification_target(input.into());
self
}
/// <p>An SNS topic ARN that is set up to receive matchmaking notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Setting up notifications for matchmaking</a> for more information.</p>
pub fn set_notification_target(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_notification_target(input);
self
}
/// <p>The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
pub fn additional_player_count(mut self, input: i32) -> Self {
self.inner = self.inner.additional_player_count(input);
self
}
/// <p>The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
pub fn set_additional_player_count(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_additional_player_count(input);
self
}
/// <p>Information to add to all events related to the matchmaking configuration. </p>
pub fn custom_event_data(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.custom_event_data(input.into());
self
}
/// <p>Information to add to all events related to the matchmaking configuration. </p>
pub fn set_custom_event_data(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_custom_event_data(input);
self
}
/// Appends an item to `GameProperties`.
///
/// To override the contents of this collection use [`set_game_properties`](Self::set_game_properties).
///
/// <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the new <code>GameSession</code> object that is created for a successful match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
pub fn game_properties(mut self, input: crate::model::GameProperty) -> Self {
self.inner = self.inner.game_properties(input);
self
}
/// <p>A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the new <code>GameSession</code> object that is created for a successful match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
pub fn set_game_properties(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::GameProperty>>,
) -> Self {
self.inner = self.inner.set_game_properties(input);
self
}
/// <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the game session that is created for a successful match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
pub fn game_session_data(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.game_session_data(input.into());
self
}
/// <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the game session that is created for a successful match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
pub fn set_game_session_data(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_game_session_data(input);
self
}
/// <p>The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html">Backfill Existing Games with FlexMatch</a>. Automatic backfill is not available when <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
pub fn backfill_mode(mut self, input: crate::model::BackfillMode) -> Self {
self.inner = self.inner.backfill_mode(input);
self
}
/// <p>The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html">Backfill Existing Games with FlexMatch</a>. Automatic backfill is not available when <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
pub fn set_backfill_mode(
mut self,
input: std::option::Option<crate::model::BackfillMode>,
) -> Self {
self.inner = self.inner.set_backfill_mode(input);
self
}
/// <p>Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution. </p>
/// <ul>
/// <li> <p> <b>STANDALONE</b> - FlexMatch forms matches and returns match information, including players and team assignments, in a <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded"> MatchmakingSucceeded</a> event.</p> </li>
/// <li> <p> <b>WITH_QUEUE</b> - FlexMatch forms matches and uses the specified GameLift queue to start a game session for the match. </p> </li>
/// </ul>
pub fn flex_match_mode(mut self, input: crate::model::FlexMatchMode) -> Self {
self.inner = self.inner.flex_match_mode(input);
self
}
/// <p>Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution. </p>
/// <ul>
/// <li> <p> <b>STANDALONE</b> - FlexMatch forms matches and returns match information, including players and team assignments, in a <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded"> MatchmakingSucceeded</a> event.</p> </li>
/// <li> <p> <b>WITH_QUEUE</b> - FlexMatch forms matches and uses the specified GameLift queue to start a game session for the match. </p> </li>
/// </ul>
pub fn set_flex_match_mode(
mut self,
input: std::option::Option<crate::model::FlexMatchMode>,
) -> Self {
self.inner = self.inner.set_flex_match_mode(input);
self
}
}
/// Fluent builder constructing a request to `UpdateRuntimeConfiguration`.
///
/// <p>Updates the current runtime configuration for the specified fleet, which tells GameLift how to launch server processes on all instances in the fleet. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in <code>ACTIVE</code> status.</p>
/// <p>To update runtime configuration, specify the fleet ID and provide a <code>RuntimeConfiguration</code> with an updated set of server process configurations.</p>
/// <p>If successful, the fleet's runtime configuration settings are updated. Each instance in the fleet regularly checks for and retrieves updated runtime configurations. Instances immediately begin complying with the new configuration by launching new server processes or not replacing existing processes when they shut down. Updating a fleet's runtime configuration never affects existing server processes.</p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift fleets</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateRuntimeConfiguration {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_runtime_configuration_input::Builder,
}
impl UpdateRuntimeConfiguration {
/// Creates a new `UpdateRuntimeConfiguration`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateRuntimeConfiguration,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateRuntimeConfigurationError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateRuntimeConfigurationOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateRuntimeConfigurationError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the fleet to update runtime configuration for. You can use either the fleet ID or ARN value.</p>
pub fn fleet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.fleet_id(input.into());
self
}
/// <p>A unique identifier for the fleet to update runtime configuration for. You can use either the fleet ID or ARN value.</p>
pub fn set_fleet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_fleet_id(input);
self
}
/// <p>Instructions for alaunching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime Servers script. The runtime configuration lists the types of server processes to run on an instance, how to launch them, and the number of processes to run concurrently.</p>
pub fn runtime_configuration(mut self, input: crate::model::RuntimeConfiguration) -> Self {
self.inner = self.inner.runtime_configuration(input);
self
}
/// <p>Instructions for alaunching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime Servers script. The runtime configuration lists the types of server processes to run on an instance, how to launch them, and the number of processes to run concurrently.</p>
pub fn set_runtime_configuration(
mut self,
input: std::option::Option<crate::model::RuntimeConfiguration>,
) -> Self {
self.inner = self.inner.set_runtime_configuration(input);
self
}
}
/// Fluent builder constructing a request to `UpdateScript`.
///
/// <p>Updates Realtime script metadata and content.</p>
/// <p>To update script metadata, specify the script ID and provide updated name and/or version values. </p>
/// <p>To update script content, provide an updated zip file by pointing to either a local file or an Amazon S3 bucket location. You can use either method regardless of how the original script was uploaded. Use the <i>Version</i> parameter to track updates to the script.</p>
/// <p>If the call is successful, the updated metadata is stored in the script record and a revised script is uploaded to the Amazon GameLift service. Once the script is updated and acquired by a fleet instance, the new version is used for all new game sessions. </p>
/// <p> <b>Learn more</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a> </p>
/// <p> <b>Related actions</b> </p>
/// <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateScript {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::update_script_input::Builder,
}
impl UpdateScript {
/// Creates a new `UpdateScript`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::UpdateScript,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::UpdateScriptError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::UpdateScriptOutput,
aws_smithy_http::result::SdkError<crate::error::UpdateScriptError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.</p>
pub fn script_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.script_id(input.into());
self
}
/// <p>A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.</p>
pub fn set_script_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_script_id(input);
self
}
/// <p>A descriptive label that is associated with a script. Script names do not need to be unique.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A descriptive label that is associated with a script. Script names do not need to be unique.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>Version information associated with a build or script. Version strings do not need to be unique.</p>
pub fn version(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.version(input.into());
self
}
/// <p>Version information associated with a build or script. Version strings do not need to be unique.</p>
pub fn set_version(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_version(input);
self
}
/// <p>The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the <code>ObjectVersion</code> parameter to specify an earlier version. </p>
pub fn storage_location(mut self, input: crate::model::S3Location) -> Self {
self.inner = self.inner.storage_location(input);
self
}
/// <p>The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the <code>ObjectVersion</code> parameter to specify an earlier version. </p>
pub fn set_storage_location(
mut self,
input: std::option::Option<crate::model::S3Location>,
) -> Self {
self.inner = self.inner.set_storage_location(input);
self
}
/// <p>A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.</p>
/// <p>When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: <code>--zip-file fileb://myRealtimeScript.zip</code>.</p>
pub fn zip_file(mut self, input: aws_smithy_types::Blob) -> Self {
self.inner = self.inner.zip_file(input);
self
}
/// <p>A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.</p>
/// <p>When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: <code>--zip-file fileb://myRealtimeScript.zip</code>.</p>
pub fn set_zip_file(mut self, input: std::option::Option<aws_smithy_types::Blob>) -> Self {
self.inner = self.inner.set_zip_file(input);
self
}
}
/// Fluent builder constructing a request to `ValidateMatchmakingRuleSet`.
///
/// <p>Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string.</p>
/// <p> <b>Learn more</b> </p>
/// <ul>
/// <li> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html">Build a rule set</a> </p> </li>
/// </ul>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct ValidateMatchmakingRuleSet {
handle: std::sync::Arc<super::Handle>,
inner: crate::input::validate_matchmaking_rule_set_input::Builder,
}
impl ValidateMatchmakingRuleSet {
/// Creates a new `ValidateMatchmakingRuleSet`.
pub(crate) fn new(handle: std::sync::Arc<super::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::operation::customize::CustomizableOperation<
crate::operation::ValidateMatchmakingRuleSet,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::error::ValidateMatchmakingRuleSetError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::operation::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::output::ValidateMatchmakingRuleSetOutput,
aws_smithy_http::result::SdkError<crate::error::ValidateMatchmakingRuleSetError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A collection of matchmaking rules to validate, formatted as a JSON string.</p>
pub fn rule_set_body(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.rule_set_body(input.into());
self
}
/// <p>A collection of matchmaking rules to validate, formatted as a JSON string.</p>
pub fn set_rule_set_body(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_rule_set_body(input);
self
}
}
}
impl Client {
/// Creates a new client from an [SDK Config](aws_types::sdk_config::SdkConfig).
///
/// # Panics
///
/// - This method will panic if the `sdk_config` is missing an async sleep implementation. If you experience this panic, set
/// the `sleep_impl` on the Config passed into this function to fix it.
/// - This method will panic if the `sdk_config` is missing an HTTP connector. If you experience this panic, set the
/// `http_connector` on the Config passed into this function to fix it.
pub fn new(sdk_config: &aws_types::sdk_config::SdkConfig) -> Self {
Self::from_conf(sdk_config.into())
}
/// Creates a new client from the service [`Config`](crate::Config).
///
/// # Panics
///
/// - This method will panic if the `conf` is missing an async sleep implementation. If you experience this panic, set
/// the `sleep_impl` on the Config passed into this function to fix it.
/// - This method will panic if the `conf` is missing an HTTP connector. If you experience this panic, set the
/// `http_connector` on the Config passed into this function to fix it.
pub fn from_conf(conf: crate::Config) -> Self {
let retry_config = conf
.retry_config()
.cloned()
.unwrap_or_else(aws_smithy_types::retry::RetryConfig::disabled);
let timeout_config = conf
.timeout_config()
.cloned()
.unwrap_or_else(aws_smithy_types::timeout::TimeoutConfig::disabled);
let sleep_impl = conf.sleep_impl();
if (retry_config.has_retry() || timeout_config.has_timeouts()) && sleep_impl.is_none() {
panic!("An async sleep implementation is required for retries or timeouts to work. \
Set the `sleep_impl` on the Config passed into this function to fix this panic.");
}
let connector = conf.http_connector().and_then(|c| {
let timeout_config = conf
.timeout_config()
.cloned()
.unwrap_or_else(aws_smithy_types::timeout::TimeoutConfig::disabled);
let connector_settings =
aws_smithy_client::http_connector::ConnectorSettings::from_timeout_config(
&timeout_config,
);
c.connector(&connector_settings, conf.sleep_impl())
});
let builder = aws_smithy_client::Builder::new();
let builder = match connector {
// Use provided connector
Some(c) => builder.connector(c),
None => {
#[cfg(any(feature = "rustls", feature = "native-tls"))]
{
// Use default connector based on enabled features
builder.dyn_https_connector(
aws_smithy_client::http_connector::ConnectorSettings::from_timeout_config(
&timeout_config,
),
)
}
#[cfg(not(any(feature = "rustls", feature = "native-tls")))]
{
panic!("No HTTP connector was available. Enable the `rustls` or `native-tls` crate feature or set a connector to fix this.");
}
}
};
let mut builder = builder
.middleware(aws_smithy_client::erase::DynMiddleware::new(
crate::middleware::DefaultMiddleware::new(),
))
.retry_config(retry_config.into())
.operation_timeout_config(timeout_config.into());
builder.set_sleep_impl(sleep_impl);
let client = builder.build();
Self {
handle: std::sync::Arc::new(Handle { client, conf }),
}
}
}