Class: Aws::GameLift::Client

FlexMatch Events Reference

Related operations

StartMatchmaking
DescribeMatchmaking
StopMatchmaking
AcceptMatch
StartMatchBackfill

Examples:

Request syntax with placeholder values


resp = client.accept_match({
  ticket_id: "MatchmakingIdStringModel", # required
  player_ids: ["NonZeroAndMaxString"], # required
  acceptance_type: "ACCEPT", # required, accepts ACCEPT, REJECT
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:ticket_id (required, String) —
A unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE; otherwise this request will fail.
:player_ids (required, Array<String>) —
A unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.
:acceptance_type (required, String) —
Player response to the proposed match.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 414

def accept_match(params = {}, options = {})
  req = build_request(:accept_match, params)
  req.send_request(options)
end

#claim_game_server(params = {}) ⇒ `Types::ClaimGameServerOutput`

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

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 CLAIMED status for 60 seconds, and returns connection information that players can use to connect to the game server.

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.

When a game server is successfully claimed, connection information is returned. A claimed game server's utilization status remains AVAILABLE while the claim status is set to CLAIMED for up to 60 seconds. This time period gives the game server time to update its status to UTILIZED (using UpdateGameServer) once 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.

If you try to claim a specific game server, this request will fail in the following cases:

If the game server utilization status is UTILIZED.
If the game server claim status is CLAIMED.

When claiming a specific game server, this request will succeed even if the game server is running on an instance in DRAINING status. To avoid this, first check the instance status by calling DescribeGameServerInstances.

Learn more

Create a Build with Files in Amazon S3

Related operations

RegisterGameServer
ListGameServers
ClaimGameServer
DescribeGameServer
UpdateGameServer
DeregisterGameServer

Examples:

Request syntax with placeholder values


resp = client.claim_game_server({
  game_server_group_name: "GameServerGroupNameOrArn", # required
  game_server_id: "GameServerId",
  game_server_data: "GameServerData",
})

Response structure


resp.game_server.game_server_group_name #=> String
resp.game_server.game_server_group_arn #=> String
resp.game_server.game_server_id #=> String
resp.game_server.instance_id #=> String
resp.game_server.connection_info #=> String
resp.game_server.game_server_data #=> String
resp.game_server.claim_status #=> String, one of "CLAIMED"
resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
resp.game_server.registration_time #=> Time
resp.game_server.last_claim_time #=> Time
resp.game_server.last_health_check_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:game_server_group_name (required, String) —
A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.. 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.
:game_server_id (String) —
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.
:game_server_data (String) —
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 using ListGameServers or ClaimGameServer.

Returns:

(Types::ClaimGameServerOutput) —
Returns a response object which responds to the following methods:
- #game_server => Types::GameServer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 529

def claim_game_server(params = {}, options = {})
  req = build_request(:claim_game_server, params)
  req.send_request(options)
end

#create_alias(params = {}) ⇒ `Types::CreateAliasOutput`

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.

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.

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 UpdateAlias.

CreateAlias
ListAliases
DescribeAlias
UpdateAlias
DeleteAlias
ResolveAlias

Examples:

Request syntax with placeholder values


resp = client.create_alias({
  name: "NonBlankAndLengthConstraintString", # required
  description: "NonZeroAndMaxString",
  routing_strategy: { # required
    type: "SIMPLE", # accepts SIMPLE, TERMINAL
    fleet_id: "FleetId",
    message: "FreeText",
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.alias.alias_id #=> String
resp.alias.name #=> String
resp.alias.alias_arn #=> String
resp.alias.description #=> String
resp.alias.routing_strategy.type #=> String, one of "SIMPLE", "TERMINAL"
resp.alias.routing_strategy.fleet_id #=> String
resp.alias.routing_strategy.message #=> String
resp.alias.creation_time #=> Time
resp.alias.last_updated_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
A descriptive label that is associated with an alias. Alias names do not need to be unique.
:description (String) —
A human-readable description of the alias.
:routing_strategy (required, Types::RoutingStrategy) —
The routing configuration, including routing type and fleet target, for the alias.
:tags (Array<Types::Tag>) —
A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Returns:

(Types::CreateAliasOutput) —
Returns a response object which responds to the following methods:
- #alias => Types::Alias

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 627

def create_alias(params = {}, options = {})
  req = build_request(:create_alias, params)
  req.send_request(options)
end

#create_build(params = {}) ⇒ `Types::CreateBuildOutput`

Creates a new Amazon GameLift build resource for your game server binary files. Game server binaries must be combined into a zip file for use with Amazon GameLift.

When setting up a new game build for GameLift, we recommend using the AWS CLI command upload-build . 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.

The CreateBuild operation can used in the following scenarios:

To create a new game build with build files that are in an S3 location under an AWS account that you control. To use this option, you must first give Amazon GameLift access to the S3 bucket. With permissions in place, call CreateBuild and specify a build name, operating system, and the S3 storage location of your game build.
To directly upload your build files to a GameLift S3 location. To use this option, first call CreateBuild and specify a build name and operating system. This operation creates a new build resource and also returns an S3 location with temporary access credentials. Use the credentials to manually upload your build files to the specified S3 location. For more information, see Uploading Objects in the Amazon S3 Developer Guide. Build files can be uploaded to the GameLift S3 location once only; that can't be updated.

If successful, this operation creates a new build resource with a unique build ID and places it in INITIALIZED status. A build must be in READY status before you can create fleets with it.

Learn more

Uploading Your Game

Related operations

CreateBuild
ListBuilds
DescribeBuild
UpdateBuild
DeleteBuild

Examples:

Request syntax with placeholder values


resp = client.create_build({
  name: "NonZeroAndMaxString",
  version: "NonZeroAndMaxString",
  storage_location: {
    bucket: "NonEmptyString",
    key: "NonEmptyString",
    role_arn: "NonEmptyString",
    object_version: "NonEmptyString",
  },
  operating_system: "WINDOWS_2012", # accepts WINDOWS_2012, AMAZON_LINUX, AMAZON_LINUX_2
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.build.build_id #=> String
resp.build.build_arn #=> String
resp.build.name #=> String
resp.build.version #=> String
resp.build.status #=> String, one of "INITIALIZED", "READY", "FAILED"
resp.build.size_on_disk #=> Integer
resp.build.operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2"
resp.build.creation_time #=> Time
resp.upload_credentials.access_key_id #=> String
resp.upload_credentials.secret_access_key #=> String
resp.upload_credentials.session_token #=> String
resp.storage_location.bucket #=> String
resp.storage_location.key #=> String
resp.storage_location.role_arn #=> String
resp.storage_location.object_version #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (String) —
A descriptive label that is associated with a build. Build names do not need to be unique. You can use UpdateBuild to change this value later.
:version (String) —
Version information that is associated with a build or script. Version strings do not need to be unique. You can use UpdateBuild to change this value later.
:storage_location (Types::S3Location) —
The location where your game build files are stored. Use this parameter only when creating a build using files that are stored in an S3 bucket that you own. Identify an S3 bucket name and key, which must in the same Region where you're creating a build. This parameter must also specify the ARN for an IAM role that you've set up to give Amazon GameLift access your S3 bucket. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.
:operating_system (String) —
The operating system that the game server binaries are built 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, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.
:tags (Array<Types::Tag>) —
A list of labels to assign to the new build resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Returns:

(Types::CreateBuildOutput) —
Returns a response object which responds to the following methods:
- #build => Types::Build
- #upload_credentials => Types::AwsCredentials
- #storage_location => Types::S3Location

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 784

def create_build(params = {}, options = {})
  req = build_request(:create_build, params)
  req.send_request(options)
end

#create_fleet(params = {}) ⇒ `Types::CreateFleetOutput`

Creates a new fleet to run your game servers. whether they are custom game builds or Realtime Servers with game-specific script. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can host multiple game sessions. When creating a fleet, you choose the hardware specifications, set some configuration options, and specify the game server to deploy on the new fleet.

To create a new fleet, provide the following: (1) a fleet name, (2) an EC2 instance type and fleet type (spot or on-demand), (3) the build ID for your game build or script ID if using Realtime Servers, and (4) a runtime configuration, which determines how game servers will run on each instance in the fleet.

If the CreateFleet call is successful, Amazon GameLift performs the following tasks. You can track the process of a fleet by checking the fleet status or by monitoring fleet creation events:

Creates a fleet resource. Status: NEW.
Begins writing events to the fleet event log, which can be accessed in the Amazon GameLift console.
Sets the fleet's target capacity to 1 (desired instances), which triggers Amazon GameLift to start one new EC2 instance.
Downloads the game build or Realtime script to the new instance and installs it. Statuses: DOWNLOADING, VALIDATING, BUILDING.
Starts launching server processes on the instance. If the fleet is configured to run multiple server processes per instance, Amazon GameLift staggers each process launch by a few seconds. Status: ACTIVATING.
Sets the fleet's status to ACTIVE as soon as one server process is ready to host a game session.

Learn more

Setting Up Fleets

Debug Fleet Creation Issues

Related operations

CreateFleet
ListFleets
DeleteFleet
DescribeFleetAttributes
UpdateFleetAttributes
StartFleetActions or StopFleetActions

Examples:

Request syntax with placeholder values


resp = client.create_fleet({
  name: "NonZeroAndMaxString", # required
  description: "NonZeroAndMaxString",
  build_id: "BuildIdOrArn",
  script_id: "ScriptIdOrArn",
  server_launch_path: "NonZeroAndMaxString",
  server_launch_parameters: "NonZeroAndMaxString",
  log_paths: ["NonZeroAndMaxString"],
  ec2_instance_type: "t2.micro", # required, accepts t2.micro, t2.small, t2.medium, t2.large, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge
  ec2_inbound_permissions: [
    {
      from_port: 1, # required
      to_port: 1, # required
      ip_range: "NonBlankString", # required
      protocol: "TCP", # required, accepts TCP, UDP
    },
  ],
  new_game_session_protection_policy: "NoProtection", # accepts NoProtection, FullProtection
  runtime_configuration: {
    server_processes: [
      {
        launch_path: "NonZeroAndMaxString", # required
        parameters: "NonZeroAndMaxString",
        concurrent_executions: 1, # required
      },
    ],
    max_concurrent_game_session_activations: 1,
    game_session_activation_timeout_seconds: 1,
  },
  resource_creation_limit_policy: {
    new_game_sessions_per_creator: 1,
    policy_period_in_minutes: 1,
  },
  metric_groups: ["MetricGroup"],
  peer_vpc_aws_account_id: "NonZeroAndMaxString",
  peer_vpc_id: "NonZeroAndMaxString",
  fleet_type: "ON_DEMAND", # accepts ON_DEMAND, SPOT
  instance_role_arn: "NonEmptyString",
  certificate_configuration: {
    certificate_type: "DISABLED", # required, accepts DISABLED, GENERATED
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.fleet_attributes.fleet_id #=> String
resp.fleet_attributes.fleet_arn #=> String
resp.fleet_attributes.fleet_type #=> String, one of "ON_DEMAND", "SPOT"
resp.fleet_attributes.instance_type #=> String, one of "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge"
resp.fleet_attributes.description #=> String
resp.fleet_attributes.name #=> String
resp.fleet_attributes.creation_time #=> Time
resp.fleet_attributes.termination_time #=> Time
resp.fleet_attributes.status #=> String, one of "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED"
resp.fleet_attributes.build_id #=> String
resp.fleet_attributes.build_arn #=> String
resp.fleet_attributes.script_id #=> String
resp.fleet_attributes.script_arn #=> String
resp.fleet_attributes.server_launch_path #=> String
resp.fleet_attributes.server_launch_parameters #=> String
resp.fleet_attributes.log_paths #=> Array
resp.fleet_attributes.log_paths[0] #=> String
resp.fleet_attributes.new_game_session_protection_policy #=> String, one of "NoProtection", "FullProtection"
resp.fleet_attributes.operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2"
resp.fleet_attributes.resource_creation_limit_policy.new_game_sessions_per_creator #=> Integer
resp.fleet_attributes.resource_creation_limit_policy.policy_period_in_minutes #=> Integer
resp.fleet_attributes.metric_groups #=> Array
resp.fleet_attributes.metric_groups[0] #=> String
resp.fleet_attributes.stopped_actions #=> Array
resp.fleet_attributes.stopped_actions[0] #=> String, one of "AUTO_SCALING"
resp.fleet_attributes.instance_role_arn #=> String
resp.fleet_attributes.certificate_configuration.certificate_type #=> String, one of "DISABLED", "GENERATED"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
:description (String) —
A human-readable description of a fleet.
:build_id (String) —
A unique identifier for a build to be deployed on the new fleet. You can use either the build ID or ARN value. The custom game server build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
:script_id (String) —
A unique identifier for a Realtime script to be deployed on the new fleet. You can use either the script ID or ARN value. The Realtime script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.
:server_launch_path (String) —
This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.
:server_launch_parameters (String) —
This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.)
:log_paths (Array<String>) —
This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.
:ec2_instance_type (required, String) —
The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
:ec2_inbound_permissions (Array<Types::IpPermission>) —
Range of IP addresses and port settings that permit inbound traffic to access game sessions that are running on the fleet. For fleets using a custom game build, this parameter is required before game sessions running on the fleet can accept connections. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges for use by the Realtime servers. You can specify multiple permission settings or add more by updating the fleet.
:new_game_session_protection_policy (String) —
A game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.
- NoProtection - The game session can be terminated during a scale-down event.
- FullProtection - If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
:runtime_configuration (Types::RuntimeConfiguration) —
Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters, although requests that contain values for these parameters instead of a runtime configuration will continue to work.) This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration replaced these parameters, but fleets that use them will continue to work.
:resource_creation_limit_policy (Types::ResourceCreationLimitPolicy) —
A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
:metric_groups (Array<String>) —
The name of an Amazon CloudWatch metric group to add this fleet to. A metric group aggregates the metrics for all fleets in the group. Specify an existing metric group name, or provide a new name to create a new metric group. A fleet can only be included in one metric group at a time.
:peer_vpc_aws_account_id (String) —
A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings.
:peer_vpc_id (String) —
A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.
:fleet_type (String) —
Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet. Learn more about On-Demand versus Spot Instances.
:instance_role_arn (String) —
A unique identifier for an AWS IAM role that manages access to your AWS services. Fleets with an instance role ARN allow applications that are running on the fleet's instances to assume the role. Learn more about using on-box credentials for your game servers at Access external resources from a game server. To call this operation with instance role ARN, you must have IAM PassRole permissions. See IAM policy examples for GameLift.
:certificate_configuration (Types::CertificateConfiguration) —
Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not specified, the default value, DISABLED, is used. This fleet setting cannot be changed once the fleet is created. Learn more at Securing Client/Server Communication.

Note: This feature requires the AWS Certificate Manager (ACM) service, which is available in the AWS global partition but not in all other partitions. When working in a partition that does not support this feature, a request for a new fleet with certificate generation results fails with a 4xx unsupported Region error.

Valid values include:
- GENERATED - Generate a TLS/SSL certificate for this fleet.
- DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
:tags (Array<Types::Tag>) —
A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Returns:

(Types::CreateFleetOutput) —
Returns a response object which responds to the following methods:
- #fleet_attributes => Types::FleetAttributes

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 1124

def create_fleet(params = {}, options = {})
  req = build_request(:create_fleet, params)
  req.send_request(options)
end

#create_game_server_group(params = {}) ⇒ `Types::CreateGameServerGroupOutput`

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Creates a GameLift FleetIQ game server group for managing game hosting on a collection of Amazon EC2 instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your AWS 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.

Before creating a new game server group, you must have the following:

An Amazon EC2 launch template that specifies how to launch Amazon EC2 instances with your game server build. For more information, see Launching an Instance from a Launch Template in the Amazon EC2 User Guide.
An IAM role that extends limited access to your AWS account to allow GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see Create IAM roles for cross-service interaction in the GameLift FleetIQ Developer Guide.

To create a new game server group, specify a unique group name, IAM role and Amazon EC2 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.

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.

Learn more

Design a Game Session Queue

Related operations

CreateGameServerGroup
ListGameServerGroups
DescribeGameServerGroup
UpdateGameServerGroup
DeleteGameServerGroup
ResumeGameServerGroup
SuspendGameServerGroup
DescribeGameServerInstances

Examples:

Request syntax with placeholder values


resp = client.create_game_server_group({
  game_server_group_name: "GameServerGroupName", # required
  role_arn: "IamRoleArn", # required
  min_size: 1, # required
  max_size: 1, # required
  launch_template: { # required
    launch_template_id: "LaunchTemplateId",
    launch_template_name: "LaunchTemplateName",
    version: "LaunchTemplateVersion",
  },
  instance_definitions: [ # required
    {
      instance_type: "c4.large", # required, accepts c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge
      weighted_capacity: "WeightedCapacity",
    },
  ],
  auto_scaling_policy: {
    estimated_instance_warmup: 1,
    target_tracking_configuration: { # required
      target_value: 1.0, # required
    },
  },
  balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED, ON_DEMAND_ONLY
  game_server_protection_policy: "NO_PROTECTION", # accepts NO_PROTECTION, FULL_PROTECTION
  vpc_subnets: ["VpcSubnet"],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.game_server_group.game_server_group_name #=> String
resp.game_server_group.game_server_group_arn #=> String
resp.game_server_group.role_arn #=> String
resp.game_server_group.instance_definitions #=> Array
resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
resp.game_server_group.auto_scaling_group_arn #=> String
resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
resp.game_server_group.status_reason #=> String
resp.game_server_group.suspended_actions #=> Array
resp.game_server_group.suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
resp.game_server_group.creation_time #=> Time
resp.game_server_group.last_updated_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:game_server_group_name (required, String) —
An identifier for the new game server group. This value is used to generate unique ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per AWS account.
:role_arn (required, String) —
The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
:min_size (required, Integer) —
The minimum number of instances allowed in the EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and 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 AWS console or APIs.
:max_size (required, Integer) —
The maximum number of instances allowed in the 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 AWS console or APIs.
:launch_template (required, Types::LaunchTemplateSpecification) —
The 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 Creating a Launch Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
:instance_definitions (required, Array<Types::InstanceDefinition>) —
The 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 EC2 Instance Types in the Amazon EC2 User Guide. 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 Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
:auto_scaling_policy (Types::GameServerGroupAutoScalingPolicy) —
Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric "PercentUtilizedGameServers" 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 AWS console or APIs.
:balancing_strategy (String) —
Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:
- SPOT_ONLY - 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.
- SPOT_PREFERRED - (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.
- ON_DEMAND_ONLY - 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.
:game_server_protection_policy (String) —
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 AWS regardless of protection status. This property is set to NO_PROTECTION by default.
:vpc_subnets (Array<String>) —
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.
:tags (Array<Types::Tag>) —
A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags, respectively. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Returns:

(Types::CreateGameServerGroupOutput) —
Returns a response object which responds to the following methods:
- #game_server_group => Types::GameServerGroup

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 1380

def create_game_server_group(params = {}, options = {})
  req = build_request(:create_game_server_group, params)
  req.send_request(options)
end

#create_game_session(params = {}) ⇒ `Types::CreateGameSessionOutput`

Creates a multiplayer game session for players. This operation creates a game session record and assigns an available server process in the specified fleet to host the game session. A fleet must have an ACTIVE status before a game session can be created in it.

To create a game session, specify either fleet ID or alias ID and indicate a maximum number of players to allow in the game session. You can also provide a name and game-specific properties for this game session. If successful, a GameSession object is returned containing the game session properties and other settings you specified.

Idempotency tokens. You can add a token that uniquely identifies game session requests. This is useful for ensuring that game session requests are idempotent. Multiple requests with the same idempotency token are processed only once; subsequent requests return the original result. All response values are the same with the exception of game session status, which may change.

Resource creation limits. If you are creating a game session on a fleet with a resource creation limit policy in force, then you must specify a creator ID. Without this ID, Amazon GameLift has no way to evaluate the policy for this new game session request.

Player acceptance policy. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation policy.

Game session logs. Logs are retained for all active game sessions for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.

Available in Amazon GameLift Local.

CreateGameSession
DescribeGameSessions
DescribeGameSessionDetails
SearchGameSessions
UpdateGameSession
GetGameSessionLogUrl
Game session placements
- StartGameSessionPlacement
- DescribeGameSessionPlacement
- StopGameSessionPlacement

Examples:

Request syntax with placeholder values


resp = client.create_game_session({
  fleet_id: "FleetIdOrArn",
  alias_id: "AliasIdOrArn",
  maximum_player_session_count: 1, # required
  name: "NonZeroAndMaxString",
  game_properties: [
    {
      key: "GamePropertyKey", # required
      value: "GamePropertyValue", # required
    },
  ],
  creator_id: "NonZeroAndMaxString",
  game_session_id: "IdStringModel",
  idempotency_token: "IdStringModel",
  game_session_data: "GameSessionData",
})

Response structure


resp.game_session.game_session_id #=> String
resp.game_session.name #=> String
resp.game_session.fleet_id #=> String
resp.game_session.fleet_arn #=> String
resp.game_session.creation_time #=> Time
resp.game_session.termination_time #=> Time
resp.game_session.current_player_session_count #=> Integer
resp.game_session.maximum_player_session_count #=> Integer
resp.game_session.status #=> String, one of "ACTIVE", "ACTIVATING", "TERMINATED", "TERMINATING", "ERROR"
resp.game_session.status_reason #=> String, one of "INTERRUPTED"
resp.game_session.game_properties #=> Array
resp.game_session.game_properties[0].key #=> String
resp.game_session.game_properties[0].value #=> String
resp.game_session.ip_address #=> String
resp.game_session.dns_name #=> String
resp.game_session.port #=> Integer
resp.game_session.player_session_creation_policy #=> String, one of "ACCEPT_ALL", "DENY_ALL"
resp.game_session.creator_id #=> String
resp.game_session.game_session_data #=> String
resp.game_session.matchmaker_data #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (String) —
A unique identifier for a 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.
:alias_id (String) —
A unique identifier for an 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.
:maximum_player_session_count (required, Integer) —
The maximum number of players that can be connected simultaneously to the game session.
:name (String) —
A descriptive label that is associated with a game session. Session names do not need to be unique.
:game_properties (Array<Types::GameProperty>) —
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).
:creator_id (String) —
A unique identifier for a player or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.
:game_session_id (String) —
This parameter is no longer preferred. Please use IdempotencyToken instead. 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. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.)
:idempotency_token (String) —
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. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.) 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.
:game_session_data (String) —
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Returns:

(Types::CreateGameSessionOutput) —
Returns a response object which responds to the following methods:
- #game_session => Types::GameSession

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 1552

def create_game_session(params = {}, options = {})
  req = build_request(:create_game_session, params)
  req.send_request(options)
end

#create_game_session_queue(params = {}) ⇒ `Types::CreateGameSessionQueueOutput`

Establishes a new queue for processing requests to place new game sessions. A queue identifies where new game sessions can be hosted -- by specifying a list of destinations (fleets or aliases) -- and how long requests can wait in the queue before timing out. You can set up a queue to try to place game sessions on fleets in multiple Regions. To add placement requests to a queue, call StartGameSessionPlacement and reference the queue name.

Destination order. When processing a request for a game session, Amazon GameLift tries each destination in order until it finds one with available resources to host the new game session. A queue's default order is determined by how destinations are listed. The default order is overridden when a game session placement request provides player latency information. Player latency information enables Amazon GameLift to prioritize destinations where players report the lowest average latency, as a result placing the new game session where the majority of players will have the best possible gameplay experience.

Player latency policies. For placement requests containing player latency information, use player latency policies to protect individual players from very high latencies. With a latency cap, even when a destination can deliver a low latency for most players, the game is not placed where any individual player is reporting latency higher than a policy's maximum. A queue can have multiple latency policies, which are enforced consecutively starting with the policy with the lowest latency cap. Use multiple policies to gradually relax latency controls; for example, you might set a policy with a low latency cap for the first 60 seconds, a second policy with a higher cap for the next 60 seconds, etc.

To create a new queue, provide a name, timeout value, a list of destinations and, if desired, a set of latency policies. If successful, a new queue object is returned.

Learn more

Create a Game Session Queue

Related operations

CreateGameSessionQueue
DescribeGameSessionQueues
UpdateGameSessionQueue
DeleteGameSessionQueue

Examples:

Request syntax with placeholder values


resp = client.create_game_session_queue({
  name: "GameSessionQueueName", # required
  timeout_in_seconds: 1,
  player_latency_policies: [
    {
      maximum_individual_player_latency_milliseconds: 1,
      policy_duration_seconds: 1,
    },
  ],
  destinations: [
    {
      destination_arn: "ArnStringModel",
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.game_session_queue.name #=> String
resp.game_session_queue.game_session_queue_arn #=> String
resp.game_session_queue.timeout_in_seconds #=> Integer
resp.game_session_queue.player_latency_policies #=> Array
resp.game_session_queue.player_latency_policies[0].maximum_individual_player_latency_milliseconds #=> Integer
resp.game_session_queue.player_latency_policies[0].policy_duration_seconds #=> Integer
resp.game_session_queue.destinations #=> Array
resp.game_session_queue.destinations[0].destination_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
:timeout_in_seconds (Integer) —
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 TIMED_OUT status.
:player_latency_policies (Array<Types::PlayerLatencyPolicy>) —
A collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, the policy is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds. If none is set, this API request fails.
:destinations (Array<Types::GameSessionQueueDestination>) —
A list of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.
:tags (Array<Types::Tag>) —
A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Returns:

(Types::CreateGameSessionQueueOutput) —
Returns a response object which responds to the following methods:
- #game_session_queue => Types::GameSessionQueue

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 1698

def create_game_session_queue(params = {}, options = {})
  req = build_request(:create_game_session_queue, params)
  req.send_request(options)
end

#create_matchmaking_configuration(params = {}) ⇒ `Types::CreateMatchmakingConfigurationOutput`

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 (StartMatchmaking or StartMatchBackfill) identify the matchmaking configuration to use and provide player attributes consistent with that configuration.

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.

In addition, you must set up an Amazon Simple Notification Service (SNS) to receive matchmaking notifications, and provide the topic ARN in the matchmaking configuration. An alternative method, continuously polling ticket status with DescribeMatchmaking, is only suitable for games in development with low matchmaking usage.

Learn more

FlexMatch Developer Guide

Design a FlexMatch Matchmaker

Set Up FlexMatch Event Notification

Related operations

CreateMatchmakingConfiguration
DescribeMatchmakingConfigurations
UpdateMatchmakingConfiguration
DeleteMatchmakingConfiguration
CreateMatchmakingRuleSet
DescribeMatchmakingRuleSets
ValidateMatchmakingRuleSet
DeleteMatchmakingRuleSet

Examples:

Request syntax with placeholder values


resp = client.create_matchmaking_configuration({
  name: "MatchmakingIdStringModel", # required
  description: "NonZeroAndMaxString",
  game_session_queue_arns: ["ArnStringModel"],
  request_timeout_seconds: 1, # required
  acceptance_timeout_seconds: 1,
  acceptance_required: false, # required
  rule_set_name: "MatchmakingRuleSetName", # required
  notification_target: "SnsArnStringModel",
  additional_player_count: 1,
  custom_event_data: "CustomEventData",
  game_properties: [
    {
      key: "GamePropertyKey", # required
      value: "GamePropertyValue", # required
    },
  ],
  game_session_data: "GameSessionData",
  backfill_mode: "AUTOMATIC", # accepts AUTOMATIC, MANUAL
  flex_match_mode: "STANDALONE", # accepts STANDALONE, WITH_QUEUE
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.configuration.name #=> String
resp.configuration.configuration_arn #=> String
resp.configuration.description #=> String
resp.configuration.game_session_queue_arns #=> Array
resp.configuration.game_session_queue_arns[0] #=> String
resp.configuration.request_timeout_seconds #=> Integer
resp.configuration.acceptance_timeout_seconds #=> Integer
resp.configuration.acceptance_required #=> Boolean
resp.configuration.rule_set_name #=> String
resp.configuration.rule_set_arn #=> String
resp.configuration.notification_target #=> String
resp.configuration.additional_player_count #=> Integer
resp.configuration.custom_event_data #=> String
resp.configuration.creation_time #=> Time
resp.configuration.game_properties #=> Array
resp.configuration.game_properties[0].key #=> String
resp.configuration.game_properties[0].value #=> String
resp.configuration.game_session_data #=> String
resp.configuration.backfill_mode #=> String, one of "AUTOMATIC", "MANUAL"
resp.configuration.flex_match_mode #=> String, one of "STANDALONE", "WITH_QUEUE"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
A unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.
:description (String) —
A human-readable description of the matchmaking configuration.
:game_session_queue_arns (Array<String>) —
Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. 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 FlexMatchMode is set to STANDALONE, do not set this parameter.
:request_timeout_seconds (required, Integer) —
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.
:acceptance_timeout_seconds (Integer) —
The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. If any player rejects the match or fails to accept before the timeout, the tickets are returned to the ticket pool and continue to be evaluated for an acceptable match.
:acceptance_required (required, Boolean) —
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 TRUE. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.
:rule_set_name (required, String) —
A unique identifier for a 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.
:notification_target (String) —
An SNS topic ARN that is set up to receive matchmaking notifications.
:additional_player_count (Integer) —
The number of player slots in a match to keep open for future players. For example, assume that the configuration's rule set specifies a match for a single 12-person team. If the additional player count is set to 2, only 10 players are initially selected for the match. This parameter is not used if FlexMatchMode is set to STANDALONE.
:custom_event_data (String) —
Information to be added to all events related to this matchmaking configuration.
:game_properties (Array<Types::GameProperty>) —
A set of custom properties for a game session, formatted as key-value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
:game_session_data (String) —
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.
:backfill_mode (String) —
The method used to backfill game sessions that are 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 StartMatchBackfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.
:flex_match_mode (String) —
Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.
- STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.
- WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift queue to start a game session for the match.
:tags (Array<Types::Tag>) —
A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Returns:

(Types::CreateMatchmakingConfigurationOutput) —
Returns a response object which responds to the following methods:
- #configuration => Types::MatchmakingConfiguration

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 1947

def create_matchmaking_configuration(params = {}, options = {})
  req = build_request(:create_matchmaking_configuration, params)
  req.send_request(options)
end

#create_matchmaking_rule_set(params = {}) ⇒ `Types::CreateMatchmakingRuleSetOutput`

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. A rule set is used by a MatchmakingConfiguration.

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.

Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using ValidateMatchmakingRuleSet before creating a new rule set.

Learn more

Related operations

CreateMatchmakingConfiguration
DescribeMatchmakingConfigurations
UpdateMatchmakingConfiguration
DeleteMatchmakingConfiguration
CreateMatchmakingRuleSet
DescribeMatchmakingRuleSets
ValidateMatchmakingRuleSet
DeleteMatchmakingRuleSet

Examples:

Request syntax with placeholder values


resp = client.create_matchmaking_rule_set({
  name: "MatchmakingIdStringModel", # required
  rule_set_body: "RuleSetBody", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.rule_set.rule_set_name #=> String
resp.rule_set.rule_set_arn #=> String
resp.rule_set.rule_set_body #=> String
resp.rule_set.creation_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
A unique identifier for a 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 name field in the rule set body.
:rule_set_body (required, String) —
A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.
:tags (Array<Types::Tag>) —
A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Returns:

(Types::CreateMatchmakingRuleSetOutput) —
Returns a response object which responds to the following methods:
- #rule_set => Types::MatchmakingRuleSet

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2051

def create_matchmaking_rule_set(params = {}, options = {})
  req = build_request(:create_matchmaking_rule_set, params)
  req.send_request(options)
end

#create_player_session(params = {}) ⇒ `Types::CreatePlayerSessionOutput`

Reserves an open player slot in an active game session. Before a player can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot. To add a group of players to a game session, use CreatePlayerSessions. When the player connects to the game server and references a player session ID, the game server contacts the Amazon GameLift service to validate the player reservation and accept the player.

To create a player session, specify a game session ID, player ID, and optionally a string of player data. If successful, a slot is reserved in the game session for the player and a new PlayerSession object is returned. Player sessions cannot be updated.

Available in Amazon GameLift Local.

CreatePlayerSession
CreatePlayerSessions
DescribePlayerSessions
Game session placements
- StartGameSessionPlacement
- DescribeGameSessionPlacement
- StopGameSessionPlacement

Examples:

Request syntax with placeholder values


resp = client.create_player_session({
  game_session_id: "ArnStringModel", # required
  player_id: "NonZeroAndMaxString", # required
  player_data: "PlayerData",
})

Response structure


resp.player_session.player_session_id #=> String
resp.player_session.player_id #=> String
resp.player_session.game_session_id #=> String
resp.player_session.fleet_id #=> String
resp.player_session.fleet_arn #=> String
resp.player_session.creation_time #=> Time
resp.player_session.termination_time #=> Time
resp.player_session.status #=> String, one of "RESERVED", "ACTIVE", "COMPLETED", "TIMEDOUT"
resp.player_session.ip_address #=> String
resp.player_session.dns_name #=> String
resp.player_session.port #=> Integer
resp.player_session.player_data #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:game_session_id (required, String) —
A unique identifier for the game session to add a player to.
:player_id (required, String) —
A unique identifier for a player. Player IDs are developer-defined.
:player_data (String) —
Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

Returns:

(Types::CreatePlayerSessionOutput) —
Returns a response object which responds to the following methods:
- #player_session => Types::PlayerSession

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2127

def create_player_session(params = {}, options = {})
  req = build_request(:create_player_session, params)
  req.send_request(options)
end

#create_player_sessions(params = {}) ⇒ `Types::CreatePlayerSessionsOutput`

Reserves open slots in a game session for a group of players. Before players can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot. To add a single player to a game session, use CreatePlayerSession. When a player connects to the game server and references a player session ID, the game server contacts the Amazon GameLift service to validate the player reservation and accept the player.

To create player sessions, specify a game session ID, a list of player IDs, and optionally a set of player data strings. If successful, a slot is reserved in the game session for each player and a set of new PlayerSession objects is returned. Player sessions cannot be updated.

Available in Amazon GameLift Local.

CreatePlayerSession
CreatePlayerSessions
DescribePlayerSessions
Game session placements
- StartGameSessionPlacement
- DescribeGameSessionPlacement
- StopGameSessionPlacement

Examples:

Request syntax with placeholder values


resp = client.create_player_sessions({
  game_session_id: "ArnStringModel", # required
  player_ids: ["NonZeroAndMaxString"], # required
  player_data_map: {
    "NonZeroAndMaxString" => "PlayerData",
  },
})

Response structure


resp.player_sessions #=> Array
resp.player_sessions[0].player_session_id #=> String
resp.player_sessions[0].player_id #=> String
resp.player_sessions[0].game_session_id #=> String
resp.player_sessions[0].fleet_id #=> String
resp.player_sessions[0].fleet_arn #=> String
resp.player_sessions[0].creation_time #=> Time
resp.player_sessions[0].termination_time #=> Time
resp.player_sessions[0].status #=> String, one of "RESERVED", "ACTIVE", "COMPLETED", "TIMEDOUT"
resp.player_sessions[0].ip_address #=> String
resp.player_sessions[0].dns_name #=> String
resp.player_sessions[0].port #=> Integer
resp.player_sessions[0].player_data #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:game_session_id (required, String) —
A unique identifier for the game session to add players to.
:player_ids (required, Array<String>) —
List of unique identifiers for the players to be added.
:player_data_map (Hash<String,String>) —
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. Player data strings for player IDs not included in the PlayerIds parameter are ignored.

Returns:

(Types::CreatePlayerSessionsOutput) —
Returns a response object which responds to the following methods:
- #player_sessions => Array<Types::PlayerSession>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2208

def create_player_sessions(params = {}, options = {})
  req = build_request(:create_player_sessions, params)
  req.send_request(options)
end

#create_script(params = {}) ⇒ `Types::CreateScriptOutput`

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.

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:

A locally available directory. Use the ZipFile parameter for this option.
An Amazon Simple Storage Service (Amazon S3) bucket under your AWS account. Use the StorageLocation 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.

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.

Learn more

Set Up a Role for Amazon GameLift Access

Related operations

CreateScript
ListScripts
DescribeScript
UpdateScript
DeleteScript

Examples:

Request syntax with placeholder values


resp = client.create_script({
  name: "NonZeroAndMaxString",
  version: "NonZeroAndMaxString",
  storage_location: {
    bucket: "NonEmptyString",
    key: "NonEmptyString",
    role_arn: "NonEmptyString",
    object_version: "NonEmptyString",
  },
  zip_file: "data",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.script.script_id #=> String
resp.script.script_arn #=> String
resp.script.name #=> String
resp.script.version #=> String
resp.script.size_on_disk #=> Integer
resp.script.creation_time #=> Time
resp.script.storage_location.bucket #=> String
resp.script.storage_location.key #=> String
resp.script.storage_location.role_arn #=> String
resp.script.storage_location.object_version #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (String) —
A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.
:version (String) —
The version that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.
:storage_location (Types::S3Location) —
The Amazon S3 location of your Realtime scripts. The storage location must specify the S3 bucket name, the zip file name (the "key"), and an IAM role ARN that allows Amazon GameLift to access the S3 storage location. The S3 bucket must be in the same Region where you are creating 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 ObjectVersion parameter to specify an earlier version. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.
:zip_file (String, StringIO, File) —
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.

When using the AWS 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: --zip-file fileb://myRealtimeScript.zip.
:tags (Array<Types::Tag>) —
A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Returns:

(Types::CreateScriptOutput) —
Returns a response object which responds to the following methods:
- #script => Types::Script

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2353

def create_script(params = {}, options = {})
  req = build_request(:create_script, params)
  req.send_request(options)
end

#create_vpc_peering_authorization(params = {}) ⇒ `Types::CreateVpcPeeringAuthorizationOutput`

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 AWS account. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. Once you've received authorization, call CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Fleets.

You can peer with VPCs that are owned by any AWS 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.

To request authorization to create a connection, call this operation from the AWS 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 AWS account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC.

To request authorization to delete a connection, call this operation from the AWS 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 AWS account that you use to manage Amazon GameLift.

The authorization remains valid for 24 hours unless it is canceled by a call to DeleteVpcPeeringAuthorization. You must create or delete the peering connection while the authorization is valid.

CreateVpcPeeringAuthorization
DescribeVpcPeeringAuthorizations
DeleteVpcPeeringAuthorization
CreateVpcPeeringConnection
DescribeVpcPeeringConnections
DeleteVpcPeeringConnection

Examples:

Request syntax with placeholder values


resp = client.create_vpc_peering_authorization({
  game_lift_aws_account_id: "NonZeroAndMaxString", # required
  peer_vpc_id: "NonZeroAndMaxString", # required
})

Response structure


resp.vpc_peering_authorization.game_lift_aws_account_id #=> String
resp.vpc_peering_authorization.peer_vpc_aws_account_id #=> String
resp.vpc_peering_authorization.peer_vpc_id #=> String
resp.vpc_peering_authorization.creation_time #=> Time
resp.vpc_peering_authorization.expiration_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:game_lift_aws_account_id (required, String) —
A unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the AWS Management Console under account settings.
:peer_vpc_id (required, String) —
A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

Returns:

(Types::CreateVpcPeeringAuthorizationOutput) —
Returns a response object which responds to the following methods:
- #vpc_peering_authorization => Types::VpcPeeringAuthorization

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2446

def create_vpc_peering_authorization(params = {}, options = {})
  req = build_request(:create_vpc_peering_authorization, params)
  req.send_request(options)
end

#create_vpc_peering_connection(params = {}) ⇒ `Struct`

Establishes a VPC peering connection between a virtual private cloud (VPC) in an AWS account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. You can peer with VPCs in any AWS 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 VPC Peering with Amazon GameLift Fleets.

Before calling this operation to establish the peering connection, you first need to call CreateVpcPeeringAuthorization 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.

To establish the connection, call this operation from the AWS 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 AWS 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 VpcPeeringConnection request is created. You can use continuous polling to track the request's status using DescribeVpcPeeringConnections, or by monitoring fleet events for success or failure using DescribeFleetEvents.

CreateVpcPeeringAuthorization
DescribeVpcPeeringAuthorizations
DeleteVpcPeeringAuthorization
CreateVpcPeeringConnection
DescribeVpcPeeringConnections
DeleteVpcPeeringConnection

Examples:

Request syntax with placeholder values


resp = client.create_vpc_peering_connection({
  fleet_id: "FleetId", # required
  peer_vpc_aws_account_id: "NonZeroAndMaxString", # required
  peer_vpc_id: "NonZeroAndMaxString", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (required, String) —
A unique identifier for a fleet. You can use either the fleet ID or ARN value. This tells Amazon GameLift which GameLift VPC to peer with.
:peer_vpc_aws_account_id (required, String) —
A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.
:peer_vpc_id (required, String) —
A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2529

def create_vpc_peering_connection(params = {}, options = {})
  req = build_request(:create_vpc_peering_connection, params)
  req.send_request(options)
end

#delete_alias(params = {}) ⇒ `Struct`

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.

CreateAlias
ListAliases
DescribeAlias
UpdateAlias
DeleteAlias
ResolveAlias

Examples:

Request syntax with placeholder values


resp = client.delete_alias({
  alias_id: "AliasIdOrArn", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:alias_id (required, String) —
A unique identifier of the alias that you want to delete. You can use either the alias ID or ARN value.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2567

def delete_alias(params = {}, options = {})
  req = build_request(:delete_alias, params)
  req.send_request(options)
end

#delete_build(params = {}) ⇒ `Struct`

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.

To delete a build, specify the build ID.

Learn more

Related operations

CreateBuild
ListBuilds
DescribeBuild
UpdateBuild
DeleteBuild

Examples:

Request syntax with placeholder values


resp = client.delete_build({
  build_id: "BuildIdOrArn", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:build_id (required, String) —
A unique identifier for a build to delete. You can use either the build ID or ARN value.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2615

def delete_build(params = {}, options = {})
  req = build_request(:delete_build, params)
  req.send_request(options)
end

#delete_fleet(params = {}) ⇒ `Struct`

Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See UpdateFleetCapacity.

If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You do not need to explicitly delete the VPC peering connection--this is done as part of the delete fleet process.

This operation removes the fleet and its resources. Once a fleet is deleted, you can no longer use any of the resource in that fleet.

Learn more

Related operations

CreateFleet
ListFleets
DeleteFleet
DescribeFleetAttributes
UpdateFleetAttributes
StartFleetActions or StopFleetActions

Examples:

Request syntax with placeholder values


resp = client.delete_fleet({
  fleet_id: "FleetIdOrArn", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (required, String) —
A unique identifier for a fleet to be deleted. You can use either the fleet ID or ARN value.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2671

def delete_fleet(params = {}, options = {})
  req = build_request(:delete_fleet, params)
  req.send_request(options)
end

#delete_game_server_group(params = {}) ⇒ `Types::DeleteGameServerGroupOutput`

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

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:

The game server group
The corresponding Auto Scaling group
All game servers that are currently running in the group

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 ACTIVE or ERROR status.

If the delete request is successful, a series of operations are kicked off. The game server group status is changed to DELETE_SCHEDULED, 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 ERROR status.

GameLift FleetIQ emits delete events to Amazon CloudWatch.

Learn more

Using Multi-Region Queues

Related operations

CreateGameServerGroup
ListGameServerGroups
DescribeGameServerGroup
UpdateGameServerGroup
DeleteGameServerGroup
ResumeGameServerGroup
SuspendGameServerGroup
DescribeGameServerInstances

Examples:

Request syntax with placeholder values


resp = client.delete_game_server_group({
  game_server_group_name: "GameServerGroupNameOrArn", # required
  delete_option: "SAFE_DELETE", # accepts SAFE_DELETE, FORCE_DELETE, RETAIN
})

Response structure


resp.game_server_group.game_server_group_name #=> String
resp.game_server_group.game_server_group_arn #=> String
resp.game_server_group.role_arn #=> String
resp.game_server_group.instance_definitions #=> Array
resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
resp.game_server_group.auto_scaling_group_arn #=> String
resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
resp.game_server_group.status_reason #=> String
resp.game_server_group.suspended_actions #=> Array
resp.game_server_group.suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
resp.game_server_group.creation_time #=> Time
resp.game_server_group.last_updated_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:game_server_group_name (required, String) —
A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
:delete_option (String) —
The type of delete to perform. Options include the following:
- SAFE_DELETE – (default) Terminates the game server group and EC2 Auto Scaling group only when it has no game servers that are in UTILIZED status.
- FORCE_DELETE – Terminates the game server group, including all active game servers regardless of their utilization status, and the EC2 Auto Scaling group.
- RETAIN – Does a safe delete of the game server group but retains the EC2 Auto Scaling group as is.

Returns:

(Types::DeleteGameServerGroupOutput) —
Returns a response object which responds to the following methods:
- #game_server_group => Types::GameServerGroup

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2783

def delete_game_server_group(params = {}, options = {})
  req = build_request(:delete_game_server_group, params)
  req.send_request(options)
end

#delete_game_session_queue(params = {}) ⇒ `Struct`

Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement requests that reference the queue will fail. To delete a queue, specify the queue name.

Learn more

Related operations

CreateGameSessionQueue
DescribeGameSessionQueues
UpdateGameSessionQueue
DeleteGameSessionQueue

Examples:

Request syntax with placeholder values


resp = client.delete_game_session_queue({
  name: "GameSessionQueueNameOrArn", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
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.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2827

def delete_game_session_queue(params = {}, options = {})
  req = build_request(:delete_game_session_queue, params)
  req.send_request(options)
end

#delete_matchmaking_configuration(params = {}) ⇒ `Struct`

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.

Related operations

CreateMatchmakingConfiguration
DescribeMatchmakingConfigurations
UpdateMatchmakingConfiguration
DeleteMatchmakingConfiguration
CreateMatchmakingRuleSet
DescribeMatchmakingRuleSets
ValidateMatchmakingRuleSet
DeleteMatchmakingRuleSet

Examples:

Request syntax with placeholder values


resp = client.delete_matchmaking_configuration({
  name: "MatchmakingConfigurationName", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
A unique identifier for a matchmaking configuration. You can use either the configuration name or ARN value.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2870

def delete_matchmaking_configuration(params = {}, options = {})
  req = build_request(:delete_matchmaking_configuration, params)
  req.send_request(options)
end

#delete_matchmaking_rule_set(params = {}) ⇒ `Struct`

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.

Learn more

Build a Rule Set

Related operations

CreateMatchmakingConfiguration
DescribeMatchmakingConfigurations
UpdateMatchmakingConfiguration
DeleteMatchmakingConfiguration
CreateMatchmakingRuleSet
DescribeMatchmakingRuleSets
ValidateMatchmakingRuleSet
DeleteMatchmakingRuleSet

Examples:

Request syntax with placeholder values


resp = client.delete_matchmaking_rule_set({
  name: "MatchmakingRuleSetName", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
A unique identifier for a 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.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2924

def delete_matchmaking_rule_set(params = {}, options = {})
  req = build_request(:delete_matchmaking_rule_set, params)
  req.send_request(options)
end

#delete_scaling_policy(params = {}) ⇒ `Struct`

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.

To temporarily suspend scaling policies, call StopFleetActions. This operation suspends all policies for the fleet.

DescribeFleetCapacity
UpdateFleetCapacity
DescribeEC2InstanceLimits
Manage scaling policies:
- PutScalingPolicy (auto-scaling)
- DescribeScalingPolicies (auto-scaling)
- DeleteScalingPolicy (auto-scaling)
Manage fleet actions:
- StartFleetActions
- StopFleetActions

Examples:

Request syntax with placeholder values


resp = client.delete_scaling_policy({
  name: "NonZeroAndMaxString", # required
  fleet_id: "FleetIdOrArn", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
A descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
:fleet_id (required, String) —
A unique identifier for a fleet to be deleted. You can use either the fleet ID or ARN value.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2978

def delete_scaling_policy(params = {}, options = {})
  req = build_request(:delete_scaling_policy, params)
  req.send_request(options)
end

#delete_script(params = {}) ⇒ `Struct`

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).

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.

Learn more

Related operations

CreateScript
ListScripts
DescribeScript
UpdateScript
DeleteScript

Examples:

Request syntax with placeholder values


resp = client.delete_script({
  script_id: "ScriptIdOrArn", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:script_id (required, String) —
A unique identifier for a Realtime script to delete. You can use either the script ID or ARN value.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3029

def delete_script(params = {}, options = {})
  req = build_request(:delete_script, params)
  req.send_request(options)
end

#delete_vpc_peering_authorization(params = {}) ⇒ `Struct`

Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, call DeleteVpcPeeringConnection.

CreateVpcPeeringAuthorization
DescribeVpcPeeringAuthorizations
DeleteVpcPeeringAuthorization
CreateVpcPeeringConnection
DescribeVpcPeeringConnections
DeleteVpcPeeringConnection

Examples:

Request syntax with placeholder values


resp = client.delete_vpc_peering_authorization({
  game_lift_aws_account_id: "NonZeroAndMaxString", # required
  peer_vpc_id: "NonZeroAndMaxString", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:game_lift_aws_account_id (required, String) —
A unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the AWS Management Console under account settings.
:peer_vpc_id (required, String) —
A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3080

def delete_vpc_peering_authorization(params = {}, options = {})
  req = build_request(:delete_vpc_peering_authorization, params)
  req.send_request(options)
end

#delete_vpc_peering_connection(params = {}) ⇒ `Struct`

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. You can check for an authorization by calling DescribeVpcPeeringAuthorizations or request a new one using CreateVpcPeeringAuthorization.

Once a valid authorization exists, call this operation from the AWS 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.

CreateVpcPeeringAuthorization
DescribeVpcPeeringAuthorizations
DeleteVpcPeeringAuthorization
CreateVpcPeeringConnection
DescribeVpcPeeringConnections
DeleteVpcPeeringConnection

Examples:

Request syntax with placeholder values


resp = client.delete_vpc_peering_connection({
  fleet_id: "FleetId", # required
  vpc_peering_connection_id: "NonZeroAndMaxString", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (required, String) —
A unique identifier for a 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.
:vpc_peering_connection_id (required, String) —
A unique identifier for a VPC peering connection. This value is included in the VpcPeeringConnection object, which can be retrieved by calling DescribeVpcPeeringConnections.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3131

def delete_vpc_peering_connection(params = {}, options = {})
  req = build_request(:delete_vpc_peering_connection, params)
  req.send_request(options)
end

#deregister_game_server(params = {}) ⇒ `Struct`

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

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.

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.

Learn more

Related operations

RegisterGameServer
ListGameServers
ClaimGameServer
DescribeGameServer
UpdateGameServer
DeregisterGameServer

Examples:

Request syntax with placeholder values


resp = client.deregister_game_server({
  game_server_group_name: "GameServerGroupNameOrArn", # required
  game_server_id: "GameServerId", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:game_server_group_name (required, String) —
A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.
:game_server_id (required, String) —
A custom string that uniquely identifies the game server to deregister.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3190

def deregister_game_server(params = {}, options = {})
  req = build_request(:deregister_game_server, params)
  req.send_request(options)
end

#describe_alias(params = {}) ⇒ `Types::DescribeAliasOutput`

Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use ResolveAlias.

To get alias properties, specify the alias ID. If successful, the requested alias record is returned.

CreateAlias
ListAliases
DescribeAlias
UpdateAlias
DeleteAlias
ResolveAlias

Examples:

Request syntax with placeholder values


resp = client.describe_alias({
  alias_id: "AliasIdOrArn", # required
})

Response structure


resp.alias.alias_id #=> String
resp.alias.name #=> String
resp.alias.alias_arn #=> String
resp.alias.description #=> String
resp.alias.routing_strategy.type #=> String, one of "SIMPLE", "TERMINAL"
resp.alias.routing_strategy.fleet_id #=> String
resp.alias.routing_strategy.message #=> String
resp.alias.creation_time #=> Time
resp.alias.last_updated_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:alias_id (required, String) —
The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN value.

Returns:

(Types::DescribeAliasOutput) —
Returns a response object which responds to the following methods:
- #alias => Types::Alias

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3244

def describe_alias(params = {}, options = {})
  req = build_request(:describe_alias, params)
  req.send_request(options)
end

#describe_build(params = {}) ⇒ `Types::DescribeBuildOutput`

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.

Learn more

Related operations

CreateBuild
ListBuilds
DescribeBuild
UpdateBuild
DeleteBuild

Examples:

Request syntax with placeholder values


resp = client.describe_build({
  build_id: "BuildIdOrArn", # required
})

Response structure


resp.build.build_id #=> String
resp.build.build_arn #=> String
resp.build.name #=> String
resp.build.version #=> String
resp.build.status #=> String, one of "INITIALIZED", "READY", "FAILED"
resp.build.size_on_disk #=> Integer
resp.build.operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2"
resp.build.creation_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:build_id (required, String) —
A unique identifier for a build to retrieve properties for. You can use either the build ID or ARN value.

Returns:

(Types::DescribeBuildOutput) —
Returns a response object which responds to the following methods:
- #build => Types::Build

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3302

def describe_build(params = {}, options = {})
  req = build_request(:describe_build, params)
  req.send_request(options)
end

#describe_ec2_instance_limits(params = {}) ⇒ `Types::DescribeEC2InstanceLimitsOutput`

Retrieves the following information for the specified EC2 instance type:

Maximum number of instances allowed per AWS account (service limit).
Current usage for the AWS account.

To learn more about the capabilities of each instance type, see Amazon EC2 Instance Types. Note that the instance types offered may vary depending on the region.

Learn more

Related operations

CreateFleet
ListFleets
DeleteFleet
DescribeFleetAttributes
UpdateFleetAttributes
StartFleetActions or StopFleetActions

Examples:

Request syntax with placeholder values


resp = client.describe_ec2_instance_limits({
  ec2_instance_type: "t2.micro", # accepts t2.micro, t2.small, t2.medium, t2.large, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge
})

Response structure


resp.ec2_instance_limits #=> Array
resp.ec2_instance_limits[0].ec2_instance_type #=> String, one of "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge"
resp.ec2_instance_limits[0].current_instances #=> Integer
resp.ec2_instance_limits[0].instance_limit #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:ec2_instance_type (String) —
Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. Leave this parameter blank to retrieve limits for all types.

Returns:

(Types::DescribeEC2InstanceLimitsOutput) —
Returns a response object which responds to the following methods:
- #ec2_instance_limits => Array<Types::EC2InstanceLimit>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3374

def describe_ec2_instance_limits(params = {}, options = {})
  req = build_request(:describe_ec2_instance_limits, params)
  req.send_request(options)
end

#describe_fleet_attributes(params = {}) ⇒ `Types::DescribeFleetAttributesOutput`

Retrieves core properties, including configuration, status, and metadata, for a fleet.

To get attributes for one or more fleets, provide a list of fleet IDs or fleet ARNs. To get attributes for all fleets, do not specify a fleet identifier. When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each fleet requested, unless the fleet identifier is not found.

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 number.

Learn more

Related operations

CreateFleet
ListFleets
DeleteFleet
Describe fleets:
- DescribeFleetAttributes
- DescribeFleetCapacity
- DescribeFleetPortSettings
- DescribeFleetUtilization
- DescribeRuntimeConfiguration
- DescribeEC2InstanceLimits
- DescribeFleetEvents
UpdateFleetAttributes
StartFleetActions or StopFleetActions

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_fleet_attributes({
  fleet_ids: ["FleetIdOrArn"],
  limit: 1,
  next_token: "NonZeroAndMaxString",
})

Response structure


resp.fleet_attributes #=> Array
resp.fleet_attributes[0].fleet_id #=> String
resp.fleet_attributes[0].fleet_arn #=> String
resp.fleet_attributes[0].fleet_type #=> String, one of "ON_DEMAND", "SPOT"
resp.fleet_attributes[0].instance_type #=> String, one of "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge"
resp.fleet_attributes[0].description #=> String
resp.fleet_attributes[0].name #=> String
resp.fleet_attributes[0].creation_time #=> Time
resp.fleet_attributes[0].termination_time #=> Time
resp.fleet_attributes[0].status #=> String, one of "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED"
resp.fleet_attributes[0].build_id #=> String
resp.fleet_attributes[0].build_arn #=> String
resp.fleet_attributes[0].script_id #=> String
resp.fleet_attributes[0].script_arn #=> String
resp.fleet_attributes[0].server_launch_path #=> String
resp.fleet_attributes[0].server_launch_parameters #=> String
resp.fleet_attributes[0].log_paths #=> Array
resp.fleet_attributes[0].log_paths[0] #=> String
resp.fleet_attributes[0].new_game_session_protection_policy #=> String, one of "NoProtection", "FullProtection"
resp.fleet_attributes[0].operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2"
resp.fleet_attributes[0].resource_creation_limit_policy.new_game_sessions_per_creator #=> Integer
resp.fleet_attributes[0].resource_creation_limit_policy.policy_period_in_minutes #=> Integer
resp.fleet_attributes[0].metric_groups #=> Array
resp.fleet_attributes[0].metric_groups[0] #=> String
resp.fleet_attributes[0].stopped_actions #=> Array
resp.fleet_attributes[0].stopped_actions[0] #=> String, one of "AUTO_SCALING"
resp.fleet_attributes[0].instance_role_arn #=> String
resp.fleet_attributes[0].certificate_configuration.certificate_type #=> String, one of "DISABLED", "GENERATED"
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_ids (Array<String>) —
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. If the list of fleet identifiers includes fleets that don't currently exist, the request succeeds but no attributes for that fleet are returned.
:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
:next_token (String) —
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.

Returns:

(Types::DescribeFleetAttributesOutput) —
Returns a response object which responds to the following methods:
- #fleet_attributes => Array<Types::FleetAttributes>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3502

def describe_fleet_attributes(params = {}, options = {})
  req = build_request(:describe_fleet_attributes, params)
  req.send_request(options)
end

#describe_fleet_capacity(params = {}) ⇒ `Types::DescribeFleetCapacityOutput`

Retrieves the current capacity statistics for one or more fleets. These statistics present a snapshot of the fleet's instances and provide insight on current or imminent scaling activity. To get statistics on game hosting activity in the fleet, see DescribeFleetUtilization.

You can request capacity for all fleets or specify a list of one or more fleet identifiers. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. When a list of fleet IDs is provided, attribute objects are returned only for fleets that currently exist.

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.

Learn more

GameLift Metrics for Fleets

Related operations

CreateFleet
ListFleets
DeleteFleet
Describe fleets:
- DescribeFleetAttributes
- DescribeFleetCapacity
- DescribeFleetPortSettings
- DescribeFleetUtilization
- DescribeRuntimeConfiguration
- DescribeEC2InstanceLimits
- DescribeFleetEvents
UpdateFleetAttributes
StartFleetActions or StopFleetActions

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_fleet_capacity({
  fleet_ids: ["FleetIdOrArn"],
  limit: 1,
  next_token: "NonZeroAndMaxString",
})

Response structure


resp.fleet_capacity #=> Array
resp.fleet_capacity[0].fleet_id #=> String
resp.fleet_capacity[0].instance_type #=> String, one of "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge"
resp.fleet_capacity[0].instance_counts.desired #=> Integer
resp.fleet_capacity[0].instance_counts.minimum #=> Integer
resp.fleet_capacity[0].instance_counts.maximum #=> Integer
resp.fleet_capacity[0].instance_counts.pending #=> Integer
resp.fleet_capacity[0].instance_counts.active #=> Integer
resp.fleet_capacity[0].instance_counts.idle #=> Integer
resp.fleet_capacity[0].instance_counts.terminating #=> Integer
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_ids (Array<String>) —
A unique identifier for a fleet(s) to retrieve capacity information for. You can use either the fleet ID or ARN value.
:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
:next_token (String) —
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.

Returns:

(Types::DescribeFleetCapacityOutput) —
Returns a response object which responds to the following methods:
- #fleet_capacity => Array<Types::FleetCapacity>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3615

def describe_fleet_capacity(params = {}, options = {})
  req = build_request(:describe_fleet_capacity, params)
  req.send_request(options)
end

#describe_fleet_events(params = {}) ⇒ `Types::DescribeFleetEventsOutput`

Retrieves entries from the specified fleet's event log. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned.

Learn more

Related operations

CreateFleet
ListFleets
DeleteFleet
Describe fleets:
- DescribeFleetAttributes
- DescribeFleetCapacity
- DescribeFleetPortSettings
- DescribeFleetUtilization
- DescribeRuntimeConfiguration
- DescribeEC2InstanceLimits
- DescribeFleetEvents
UpdateFleetAttributes
StartFleetActions or StopFleetActions

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_fleet_events({
  fleet_id: "FleetIdOrArn", # required
  start_time: Time.now,
  end_time: Time.now,
  limit: 1,
  next_token: "NonZeroAndMaxString",
})

Response structure


resp.events #=> Array
resp.events[0].event_id #=> String
resp.events[0].resource_id #=> String
resp.events[0].event_code #=> String, one of "GENERIC_EVENT", "FLEET_CREATED", "FLEET_DELETED", "FLEET_SCALING_EVENT", "FLEET_STATE_DOWNLOADING", "FLEET_STATE_VALIDATING", "FLEET_STATE_BUILDING", "FLEET_STATE_ACTIVATING", "FLEET_STATE_ACTIVE", "FLEET_STATE_ERROR", "FLEET_INITIALIZATION_FAILED", "FLEET_BINARY_DOWNLOAD_FAILED", "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND", "FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE", "FLEET_VALIDATION_TIMED_OUT", "FLEET_ACTIVATION_FAILED", "FLEET_ACTIVATION_FAILED_NO_INSTANCES", "FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED", "SERVER_PROCESS_INVALID_PATH", "SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT", "SERVER_PROCESS_PROCESS_READY_TIMEOUT", "SERVER_PROCESS_CRASHED", "SERVER_PROCESS_TERMINATED_UNHEALTHY", "SERVER_PROCESS_FORCE_TERMINATED", "SERVER_PROCESS_PROCESS_EXIT_TIMEOUT", "GAME_SESSION_ACTIVATION_TIMEOUT", "FLEET_CREATION_EXTRACTING_BUILD", "FLEET_CREATION_RUNNING_INSTALLER", "FLEET_CREATION_VALIDATING_RUNTIME_CONFIG", "FLEET_VPC_PEERING_SUCCEEDED", "FLEET_VPC_PEERING_FAILED", "FLEET_VPC_PEERING_DELETED", "INSTANCE_INTERRUPTED"
resp.events[0].message #=> String
resp.events[0].event_time #=> Time
resp.events[0].pre_signed_log_url #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (required, String) —
A unique identifier for a fleet to get event logs for. You can use either the fleet ID or ARN value.
:start_time (Time, DateTime, Date, Integer, String) —
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").
:end_time (Time, DateTime, Date, Integer, String) —
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").
:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
:next_token (String) —
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.

Returns:

(Types::DescribeFleetEventsOutput) —
Returns a response object which responds to the following methods:
- #events => Array<Types::Event>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3719

def describe_fleet_events(params = {}, options = {})
  req = build_request(:describe_fleet_events, params)
  req.send_request(options)
end

#describe_fleet_port_settings(params = {}) ⇒ `Types::DescribeFleetPortSettingsOutput`

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 use connections that fall in this range.

To get a fleet's inbound connection permissions, specify the fleet's unique identifier. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.

Learn more

Related operations

CreateFleet
ListFleets
DeleteFleet
Describe fleets:
- DescribeFleetAttributes
- DescribeFleetCapacity
- DescribeFleetPortSettings
- DescribeFleetUtilization
- DescribeRuntimeConfiguration
- DescribeEC2InstanceLimits
- DescribeFleetEvents
UpdateFleetAttributes
StartFleetActions or StopFleetActions

Examples:

Request syntax with placeholder values


resp = client.describe_fleet_port_settings({
  fleet_id: "FleetIdOrArn", # required
})

Response structure


resp.inbound_permissions #=> Array
resp.inbound_permissions[0].from_port #=> Integer
resp.inbound_permissions[0].to_port #=> Integer
resp.inbound_permissions[0].ip_range #=> String
resp.inbound_permissions[0].protocol #=> String, one of "TCP", "UDP"

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (required, String) —
A unique identifier for a fleet to retrieve port settings for. You can use either the fleet ID or ARN value.

Returns:

(Types::DescribeFleetPortSettingsOutput) —
Returns a response object which responds to the following methods:
- #inbound_permissions => Array<Types::IpPermission>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3797

def describe_fleet_port_settings(params = {}, options = {})
  req = build_request(:describe_fleet_port_settings, params)
  req.send_request(options)
end

#describe_fleet_utilization(params = {}) ⇒ `Types::DescribeFleetUtilizationOutput`

Retrieves utilization statistics for one or more fleets. These statistics provide insight into how available hosting resources are currently being used. To get statistics on available hosting resources, see DescribeFleetCapacity.

You can request utilization data for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID, unless the fleet identifier is not found.

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.

Learn more

GameLift Metrics for Fleets

Related operations

CreateFleet
ListFleets
DeleteFleet
Describe fleets:
- DescribeFleetAttributes
- DescribeFleetCapacity
- DescribeFleetPortSettings
- DescribeFleetUtilization
- DescribeRuntimeConfiguration
- DescribeEC2InstanceLimits
- DescribeFleetEvents
UpdateFleetAttributes
StartFleetActions or StopFleetActions

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_fleet_utilization({
  fleet_ids: ["FleetIdOrArn"],
  limit: 1,
  next_token: "NonZeroAndMaxString",
})

Response structure


resp.fleet_utilization #=> Array
resp.fleet_utilization[0].fleet_id #=> String
resp.fleet_utilization[0].active_server_process_count #=> Integer
resp.fleet_utilization[0].active_game_session_count #=> Integer
resp.fleet_utilization[0].current_player_session_count #=> Integer
resp.fleet_utilization[0].maximum_player_session_count #=> Integer
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_ids (Array<String>) —
A unique identifier for a fleet(s) 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. If the list of fleet identifiers includes fleets that don't currently exist, the request succeeds but no attributes for that fleet are returned.
:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
:next_token (String) —
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.

Returns:

(Types::DescribeFleetUtilizationOutput) —
Returns a response object which responds to the following methods:
- #fleet_utilization => Array<Types::FleetUtilization>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3907

def describe_fleet_utilization(params = {}, options = {})
  req = build_request(:describe_fleet_utilization, params)
  req.send_request(options)
end

#describe_game_server(params = {}) ⇒ `Types::DescribeGameServerOutput`

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

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.

To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned.

Learn more

Related operations

RegisterGameServer
ListGameServers
ClaimGameServer
DescribeGameServer
UpdateGameServer
DeregisterGameServer

Examples:

Request syntax with placeholder values


resp = client.describe_game_server({
  game_server_group_name: "GameServerGroupNameOrArn", # required
  game_server_id: "GameServerId", # required
})

Response structure


resp.game_server.game_server_group_name #=> String
resp.game_server.game_server_group_arn #=> String
resp.game_server.game_server_id #=> String
resp.game_server.instance_id #=> String
resp.game_server.connection_info #=> String
resp.game_server.game_server_data #=> String
resp.game_server.claim_status #=> String, one of "CLAIMED"
resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
resp.game_server.registration_time #=> Time
resp.game_server.last_claim_time #=> Time
resp.game_server.last_health_check_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:game_server_group_name (required, String) —
A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.
:game_server_id (required, String) —
A custom string that uniquely identifies the game server information to be retrieved.

Returns:

(Types::DescribeGameServerOutput) —
Returns a response object which responds to the following methods:
- #game_server => Types::GameServer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3981

def describe_game_server(params = {}, options = {})
  req = build_request(:describe_game_server, params)
  req.send_request(options)
end

#describe_game_server_group(params = {}) ⇒ `Types::DescribeGameServerGroupOutput`

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

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.

To get attributes for a game server group, provide a group name or ARN value. If successful, a GameServerGroup object is returned.

Learn more

Related operations

CreateGameServerGroup
ListGameServerGroups
DescribeGameServerGroup
UpdateGameServerGroup
DeleteGameServerGroup
ResumeGameServerGroup
SuspendGameServerGroup
DescribeGameServerInstances

Examples:

Request syntax with placeholder values


resp = client.describe_game_server_group({
  game_server_group_name: "GameServerGroupNameOrArn", # required
})

Response structure


resp.game_server_group.game_server_group_name #=> String
resp.game_server_group.game_server_group_arn #=> String
resp.game_server_group.role_arn #=> String
resp.game_server_group.instance_definitions #=> Array
resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
resp.game_server_group.auto_scaling_group_arn #=> String
resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
resp.game_server_group.status_reason #=> String
resp.game_server_group.suspended_actions #=> Array
resp.game_server_group.suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
resp.game_server_group.creation_time #=> Time
resp.game_server_group.last_updated_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:game_server_group_name (required, String) —
A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Returns:

(Types::DescribeGameServerGroupOutput) —
Returns a response object which responds to the following methods:
- #game_server_group => Types::GameServerGroup

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4060

def describe_game_server_group(params = {}, options = {})
  req = build_request(:describe_game_server_group, params)
  req.send_request(options)
end

#describe_game_server_instances(params = {}) ⇒ `Types::DescribeGameServerInstancesOutput`

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

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. If you are looking for instance configuration information, call DescribeGameServerGroup or access the corresponding Auto Scaling group properties.

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 GameServerInstance objects is returned.

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.

Learn more

Remotely Access Fleet Instances

Related operations

CreateGameServerGroup
ListGameServerGroups
DescribeGameServerGroup
UpdateGameServerGroup
DeleteGameServerGroup
ResumeGameServerGroup
SuspendGameServerGroup
DescribeGameServerInstances

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_game_server_instances({
  game_server_group_name: "GameServerGroupNameOrArn", # required
  instance_ids: ["GameServerInstanceId"],
  limit: 1,
  next_token: "NonZeroAndMaxString",
})

Response structure


resp.game_server_instances #=> Array
resp.game_server_instances[0].game_server_group_name #=> String
resp.game_server_instances[0].game_server_group_arn #=> String
resp.game_server_instances[0].instance_id #=> String
resp.game_server_instances[0].instance_status #=> String, one of "ACTIVE", "DRAINING", "SPOT_TERMINATING"
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:game_server_group_name (required, String) —
A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
:instance_ids (Array<String>) —
The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.
:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential segments.
:next_token (String) —
A token that indicates the start of the next sequential segment of results. Use the token returned with the previous call to this operation. To start at the beginning of the result set, do not specify a value.

Returns:

(Types::DescribeGameServerInstancesOutput) —
Returns a response object which responds to the following methods:
- #game_server_instances => Array<Types::GameServerInstance>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4161

def describe_game_server_instances(params = {}, options = {})
  req = build_request(:describe_game_server_instances, params)
  req.send_request(options)
end

#describe_game_session_details(params = {}) ⇒ `Types::DescribeGameSessionDetailsOutput`

Retrieves properties, including the protection policy in force, for one or more game sessions. This operation can be used in several ways: (1) provide a GameSessionId or GameSessionArn to request details for a specific game session; (2) provide either a FleetId or an AliasId to request properties for all game sessions running on a fleet.

To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each session matching the request.

CreateGameSession
DescribeGameSessions
DescribeGameSessionDetails
SearchGameSessions
UpdateGameSession
GetGameSessionLogUrl
Game session placements
- StartGameSessionPlacement
- DescribeGameSessionPlacement
- StopGameSessionPlacement

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_game_session_details({
  fleet_id: "FleetIdOrArn",
  game_session_id: "ArnStringModel",
  alias_id: "AliasIdOrArn",
  status_filter: "NonZeroAndMaxString",
  limit: 1,
  next_token: "NonZeroAndMaxString",
})

Response structure


resp.game_session_details #=> Array
resp.game_session_details[0].game_session.game_session_id #=> String
resp.game_session_details[0].game_session.name #=> String
resp.game_session_details[0].game_session.fleet_id #=> String
resp.game_session_details[0].game_session.fleet_arn #=> String
resp.game_session_details[0].game_session.creation_time #=> Time
resp.game_session_details[0].game_session.termination_time #=> Time
resp.game_session_details[0].game_session.current_player_session_count #=> Integer
resp.game_session_details[0].game_session.maximum_player_session_count #=> Integer
resp.game_session_details[0].game_session.status #=> String, one of "ACTIVE", "ACTIVATING", "TERMINATED", "TERMINATING", "ERROR"
resp.game_session_details[0].game_session.status_reason #=> String, one of "INTERRUPTED"
resp.game_session_details[0].game_session.game_properties #=> Array
resp.game_session_details[0].game_session.game_properties[0].key #=> String
resp.game_session_details[0].game_session.game_properties[0].value #=> String
resp.game_session_details[0].game_session.ip_address #=> String
resp.game_session_details[0].game_session.dns_name #=> String
resp.game_session_details[0].game_session.port #=> Integer
resp.game_session_details[0].game_session.player_session_creation_policy #=> String, one of "ACCEPT_ALL", "DENY_ALL"
resp.game_session_details[0].game_session.creator_id #=> String
resp.game_session_details[0].game_session.game_session_data #=> String
resp.game_session_details[0].game_session.matchmaker_data #=> String
resp.game_session_details[0].protection_policy #=> String, one of "NoProtection", "FullProtection"
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (String) —
A unique identifier for a fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.
:game_session_id (String) —
A unique identifier for the game session to retrieve.
:alias_id (String) —
A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.
:status_filter (String) —
Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).
:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
:next_token (String) —
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.

Returns:

(Types::DescribeGameSessionDetailsOutput) —
Returns a response object which responds to the following methods:
- #game_session_details => Array<Types::GameSessionDetail>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4272

def describe_game_session_details(params = {}, options = {})
  req = build_request(:describe_game_session_details, params)
  req.send_request(options)
end

#describe_game_session_placement(params = {}) ⇒ `Types::DescribeGameSessionPlacementOutput`

Retrieves properties and current status of a game session placement request. To get game session placement details, specify the placement ID. If successful, a GameSessionPlacement object is returned.

CreateGameSession
DescribeGameSessions
DescribeGameSessionDetails
SearchGameSessions
UpdateGameSession
GetGameSessionLogUrl
Game session placements
- StartGameSessionPlacement
- DescribeGameSessionPlacement
- StopGameSessionPlacement

Examples:

Request syntax with placeholder values


resp = client.describe_game_session_placement({
  placement_id: "IdStringModel", # required
})

Response structure


resp.game_session_placement.placement_id #=> String
resp.game_session_placement.game_session_queue_name #=> String
resp.game_session_placement.status #=> String, one of "PENDING", "FULFILLED", "CANCELLED", "TIMED_OUT", "FAILED"
resp.game_session_placement.game_properties #=> Array
resp.game_session_placement.game_properties[0].key #=> String
resp.game_session_placement.game_properties[0].value #=> String
resp.game_session_placement.maximum_player_session_count #=> Integer
resp.game_session_placement.game_session_name #=> String
resp.game_session_placement.game_session_id #=> String
resp.game_session_placement.game_session_arn #=> String
resp.game_session_placement.game_session_region #=> String
resp.game_session_placement.player_latencies #=> Array
resp.game_session_placement.player_latencies[0].player_id #=> String
resp.game_session_placement.player_latencies[0].region_identifier #=> String
resp.game_session_placement.player_latencies[0].latency_in_milliseconds #=> Float
resp.game_session_placement.start_time #=> Time
resp.game_session_placement.end_time #=> Time
resp.game_session_placement.ip_address #=> String
resp.game_session_placement.dns_name #=> String
resp.game_session_placement.port #=> Integer
resp.game_session_placement.placed_player_sessions #=> Array
resp.game_session_placement.placed_player_sessions[0].player_id #=> String
resp.game_session_placement.placed_player_sessions[0].player_session_id #=> String
resp.game_session_placement.game_session_data #=> String
resp.game_session_placement.matchmaker_data #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:placement_id (required, String) —
A unique identifier for a game session placement to retrieve.

Returns:

(Types::DescribeGameSessionPlacementOutput) —
Returns a response object which responds to the following methods:
- #game_session_placement => Types::GameSessionPlacement

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4346

def describe_game_session_placement(params = {}, options = {})
  req = build_request(:describe_game_session_placement, params)
  req.send_request(options)
end

#describe_game_session_queues(params = {}) ⇒ `Types::DescribeGameSessionQueuesOutput`

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. If successful, a GameSessionQueue object is returned for each requested queue. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.

Learn more

View Your Queues

Related operations

CreateGameSessionQueue
DescribeGameSessionQueues
UpdateGameSessionQueue
DeleteGameSessionQueue

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_game_session_queues({
  names: ["GameSessionQueueNameOrArn"],
  limit: 1,
  next_token: "NonZeroAndMaxString",
})

Response structure


resp.game_session_queues #=> Array
resp.game_session_queues[0].name #=> String
resp.game_session_queues[0].game_session_queue_arn #=> String
resp.game_session_queues[0].timeout_in_seconds #=> Integer
resp.game_session_queues[0].player_latency_policies #=> Array
resp.game_session_queues[0].player_latency_policies[0].maximum_individual_player_latency_milliseconds #=> Integer
resp.game_session_queues[0].player_latency_policies[0].policy_duration_seconds #=> Integer
resp.game_session_queues[0].destinations #=> Array
resp.game_session_queues[0].destinations[0].destination_arn #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:names (Array<String>) —
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.
:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. You can request up to 50 results.
:next_token (String) —
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.

Returns:

(Types::DescribeGameSessionQueuesOutput) —
Returns a response object which responds to the following methods:
- #game_session_queues => Array<Types::GameSessionQueue>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4424

def describe_game_session_queues(params = {}, options = {})
  req = build_request(:describe_game_session_queues, params)
  req.send_request(options)
end

#describe_game_sessions(params = {}) ⇒ `Types::DescribeGameSessionsOutput`

Retrieves a set of one or more game sessions. Request a specific game session or request all game sessions on a fleet. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve protection policy settings for game sessions, use DescribeGameSessionDetails.

To get game sessions, specify one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each game session matching the request.

Available in Amazon GameLift Local.

CreateGameSession
DescribeGameSessions
DescribeGameSessionDetails
SearchGameSessions
UpdateGameSession
GetGameSessionLogUrl
Game session placements
- StartGameSessionPlacement
- DescribeGameSessionPlacement
- StopGameSessionPlacement

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_game_sessions({
  fleet_id: "FleetIdOrArn",
  game_session_id: "ArnStringModel",
  alias_id: "AliasIdOrArn",
  status_filter: "NonZeroAndMaxString",
  limit: 1,
  next_token: "NonZeroAndMaxString",
})

Response structure


resp.game_sessions #=> Array
resp.game_sessions[0].game_session_id #=> String
resp.game_sessions[0].name #=> String
resp.game_sessions[0].fleet_id #=> String
resp.game_sessions[0].fleet_arn #=> String
resp.game_sessions[0].creation_time #=> Time
resp.game_sessions[0].termination_time #=> Time
resp.game_sessions[0].current_player_session_count #=> Integer
resp.game_sessions[0].maximum_player_session_count #=> Integer
resp.game_sessions[0].status #=> String, one of "ACTIVE", "ACTIVATING", "TERMINATED", "TERMINATING", "ERROR"
resp.game_sessions[0].status_reason #=> String, one of "INTERRUPTED"
resp.game_sessions[0].game_properties #=> Array
resp.game_sessions[0].game_properties[0].key #=> String
resp.game_sessions[0].game_properties[0].value #=> String
resp.game_sessions[0].ip_address #=> String
resp.game_sessions[0].dns_name #=> String
resp.game_sessions[0].port #=> Integer
resp.game_sessions[0].player_session_creation_policy #=> String, one of "ACCEPT_ALL", "DENY_ALL"
resp.game_sessions[0].creator_id #=> String
resp.game_sessions[0].game_session_data #=> String
resp.game_sessions[0].matchmaker_data #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (String) —
A unique identifier for a fleet to retrieve all game sessions for. You can use either the fleet ID or ARN value.
:game_session_id (String) —
A unique identifier for the game session to retrieve.
:alias_id (String) —
A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.
:status_filter (String) —
Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).
:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
:next_token (String) —
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.

Returns:

(Types::DescribeGameSessionsOutput) —
Returns a response object which responds to the following methods:
- #game_sessions => Array<Types::GameSession>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4535

def describe_game_sessions(params = {}, options = {})
  req = build_request(:describe_game_sessions, params)
  req.send_request(options)
end

#describe_instances(params = {}) ⇒ `Types::DescribeInstancesOutput`

Retrieves information about a fleet's instances, including instance IDs. Use this operation to get details on all instances in the fleet or get details on one specific instance.

To get a specific instance, specify fleet ID and instance ID. To get all instances in a fleet, specify a fleet ID only. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, an Instance object is returned for each result.

Learn more

Debug Fleet Issues

Related operations

DescribeInstances
GetInstanceAccess

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_instances({
  fleet_id: "FleetIdOrArn", # required
  instance_id: "InstanceId",
  limit: 1,
  next_token: "NonZeroAndMaxString",
})

Response structure


resp.instances #=> Array
resp.instances[0].fleet_id #=> String
resp.instances[0].instance_id #=> String
resp.instances[0].ip_address #=> String
resp.instances[0].dns_name #=> String
resp.instances[0].operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2"
resp.instances[0].type #=> String, one of "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge"
resp.instances[0].status #=> String, one of "PENDING", "ACTIVE", "TERMINATING"
resp.instances[0].creation_time #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (required, String) —
A unique identifier for a fleet to retrieve instance information for. You can use either the fleet ID or ARN value.
:instance_id (String) —
A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.
:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
:next_token (String) —
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.

Returns:

(Types::DescribeInstancesOutput) —
Returns a response object which responds to the following methods:
- #instances => Array<Types::Instance>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4616

def describe_instances(params = {}, options = {})
  req = build_request(:describe_instances, params)
  req.send_request(options)
end

#describe_matchmaking(params = {}) ⇒ `Types::DescribeMatchmakingOutput`

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.

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.

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 (SNS) to receive notifications, and provide the topic ARN in the matchmaking configuration. Continuously poling ticket status with DescribeMatchmaking should only be used for games in development with low matchmaking usage.

Learn more

Set Up FlexMatch Event Notification

Related operations

StartMatchmaking
DescribeMatchmaking
StopMatchmaking
AcceptMatch
StartMatchBackfill

Examples:

Request syntax with placeholder values


resp = client.describe_matchmaking({
  ticket_ids: ["MatchmakingIdStringModel"], # required
})

Response structure


resp.ticket_list #=> Array
resp.ticket_list[0].ticket_id #=> String
resp.ticket_list[0].configuration_name #=> String
resp.ticket_list[0].configuration_arn #=> String
resp.ticket_list[0].status #=> String, one of "CANCELLED", "COMPLETED", "FAILED", "PLACING", "QUEUED", "REQUIRES_ACCEPTANCE", "SEARCHING", "TIMED_OUT"
resp.ticket_list[0].status_reason #=> String
resp.ticket_list[0].status_message #=> String
resp.ticket_list[0].start_time #=> Time
resp.ticket_list[0].end_time #=> Time
resp.ticket_list[0].players #=> Array
resp.ticket_list[0].players[0].player_id #=> String
resp.ticket_list[0].players[0].player_attributes #=> Hash
resp.ticket_list[0].players[0].player_attributes["NonZeroAndMaxString"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.ticket_list[0].players[0].team #=> String
resp.ticket_list[0].players[0].latency_in_ms #=> Hash
resp.ticket_list[0].players[0].latency_in_ms["NonEmptyString"] #=> Integer
resp.ticket_list[0].game_session_connection_info.game_session_arn #=> String
resp.ticket_list[0].game_session_connection_info.ip_address #=> String
resp.ticket_list[0].game_session_connection_info.dns_name #=> String
resp.ticket_list[0].game_session_connection_info.port #=> Integer
resp.ticket_list[0].game_session_connection_info.matched_player_sessions #=> Array
resp.ticket_list[0].game_session_connection_info.matched_player_sessions[0].player_id #=> String
resp.ticket_list[0].game_session_connection_info.matched_player_sessions[0].player_session_id #=> String
resp.ticket_list[0].estimated_wait_time #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:ticket_ids (required, Array<String>) —
A unique identifier for a matchmaking ticket. You can include up to 10 ID values.

Returns:

(Types::DescribeMatchmakingOutput) —
Returns a response object which responds to the following methods:
- #ticket_list => Array<Types::MatchmakingTicket>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4708

def describe_matchmaking(params = {}, options = {})
  req = build_request(:describe_matchmaking, params)
  req.send_request(options)
end

#describe_matchmaking_configurations(params = {}) ⇒ `Types::DescribeMatchmakingConfigurationsOutput`

Retrieves the details of FlexMatch matchmaking configurations.

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.

If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.

Learn more

Setting Up FlexMatch Matchmakers

Related operations

CreateMatchmakingConfiguration
DescribeMatchmakingConfigurations
UpdateMatchmakingConfiguration
DeleteMatchmakingConfiguration
CreateMatchmakingRuleSet
DescribeMatchmakingRuleSets
ValidateMatchmakingRuleSet
DeleteMatchmakingRuleSet

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_matchmaking_configurations({
  names: ["MatchmakingConfigurationName"],
  rule_set_name: "MatchmakingRuleSetName",
  limit: 1,
  next_token: "NonZeroAndMaxString",
})

Response structure


resp.configurations #=> Array
resp.configurations[0].name #=> String
resp.configurations[0].configuration_arn #=> String
resp.configurations[0].description #=> String
resp.configurations[0].game_session_queue_arns #=> Array
resp.configurations[0].game_session_queue_arns[0] #=> String
resp.configurations[0].request_timeout_seconds #=> Integer
resp.configurations[0].acceptance_timeout_seconds #=> Integer
resp.configurations[0].acceptance_required #=> Boolean
resp.configurations[0].rule_set_name #=> String
resp.configurations[0].rule_set_arn #=> String
resp.configurations[0].notification_target #=> String
resp.configurations[0].additional_player_count #=> Integer
resp.configurations[0].custom_event_data #=> String
resp.configurations[0].creation_time #=> Time
resp.configurations[0].game_properties #=> Array
resp.configurations[0].game_properties[0].key #=> String
resp.configurations[0].game_properties[0].value #=> String
resp.configurations[0].game_session_data #=> String
resp.configurations[0].backfill_mode #=> String, one of "AUTOMATIC", "MANUAL"
resp.configurations[0].flex_match_mode #=> String, one of "STANDALONE", "WITH_QUEUE"
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:names (Array<String>) —
A unique identifier for a matchmaking configuration(s) to retrieve. You can use either the configuration name or ARN value. To request all existing configurations, leave this parameter empty.
:rule_set_name (String) —
A unique identifier for a 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.
:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is limited to 10.
:next_token (String) —
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.

Returns:

(Types::DescribeMatchmakingConfigurationsOutput) —
Returns a response object which responds to the following methods:
- #configurations => Array<Types::MatchmakingConfiguration>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4818

def describe_matchmaking_configurations(params = {}, options = {})
  req = build_request(:describe_matchmaking_configurations, params)
  req.send_request(options)
end

#describe_matchmaking_rule_sets(params = {}) ⇒ `Types::DescribeMatchmakingRuleSetsOutput`

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.

Learn more

Build a Rule Set

Related operations

CreateMatchmakingConfiguration
DescribeMatchmakingConfigurations
UpdateMatchmakingConfiguration
DeleteMatchmakingConfiguration
CreateMatchmakingRuleSet
DescribeMatchmakingRuleSets
ValidateMatchmakingRuleSet
DeleteMatchmakingRuleSet

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_matchmaking_rule_sets({
  names: ["MatchmakingRuleSetName"],
  limit: 1,
  next_token: "NonZeroAndMaxString",
})

Response structure


resp.rule_sets #=> Array
resp.rule_sets[0].rule_set_name #=> String
resp.rule_sets[0].rule_set_arn #=> String
resp.rule_sets[0].rule_set_body #=> String
resp.rule_sets[0].creation_time #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:names (Array<String>) —
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.
:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
:next_token (String) —
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.

Returns:

(Types::DescribeMatchmakingRuleSetsOutput) —
Returns a response object which responds to the following methods:
- #rule_sets => Array<Types::MatchmakingRuleSet>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4901

def describe_matchmaking_rule_sets(params = {}, options = {})
  req = build_request(:describe_matchmaking_rule_sets, params)
  req.send_request(options)
end

#describe_player_sessions(params = {}) ⇒ `Types::DescribePlayerSessionsOutput`

Retrieves properties for one or more player sessions. This operation can be used in several ways: (1) provide a PlayerSessionId to request properties for a specific player session; (2) provide a GameSessionId to request properties for all player sessions in the specified game session; (3) provide a PlayerId to request properties for all player sessions of a specified player.

To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request.

Available in Amazon GameLift Local.

CreatePlayerSession
CreatePlayerSessions
DescribePlayerSessions
Game session placements
- StartGameSessionPlacement
- DescribeGameSessionPlacement
- StopGameSessionPlacement

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_player_sessions({
  game_session_id: "ArnStringModel",
  player_id: "NonZeroAndMaxString",
  player_session_id: "PlayerSessionId",
  player_session_status_filter: "NonZeroAndMaxString",
  limit: 1,
  next_token: "NonZeroAndMaxString",
})

Response structure


resp.player_sessions #=> Array
resp.player_sessions[0].player_session_id #=> String
resp.player_sessions[0].player_id #=> String
resp.player_sessions[0].game_session_id #=> String
resp.player_sessions[0].fleet_id #=> String
resp.player_sessions[0].fleet_arn #=> String
resp.player_sessions[0].creation_time #=> Time
resp.player_sessions[0].termination_time #=> Time
resp.player_sessions[0].status #=> String, one of "RESERVED", "ACTIVE", "COMPLETED", "TIMEDOUT"
resp.player_sessions[0].ip_address #=> String
resp.player_sessions[0].dns_name #=> String
resp.player_sessions[0].port #=> Integer
resp.player_sessions[0].player_data #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:game_session_id (String) —
A unique identifier for the game session to retrieve player sessions for.
:player_id (String) —
A unique identifier for a player to retrieve player sessions for.
:player_session_id (String) —
A unique identifier for a player session to retrieve.
:player_session_status_filter (String) —
Player session status to filter results on.

Possible player session statuses include the following:
- RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.
- ACTIVE -- The player has been validated by the server process and is currently connected.
- COMPLETED -- The player connection has been dropped.
- TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).
:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.
:next_token (String) —
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.

Returns:

(Types::DescribePlayerSessionsOutput) —
Returns a response object which responds to the following methods:
- #player_sessions => Array<Types::PlayerSession>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5014

def describe_player_sessions(params = {}, options = {})
  req = build_request(:describe_player_sessions, params)
  req.send_request(options)
end

#describe_runtime_configuration(params = {}) ⇒ `Types::DescribeRuntimeConfigurationOutput`

Retrieves a fleet's runtime configuration settings. The runtime configuration tells Amazon GameLift which server processes to run (and how) on each instance in the fleet.

To get a runtime configuration, specify the fleet's unique identifier. If successful, a RuntimeConfiguration object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty.

Learn more

Running Multiple Processes on a Fleet

Related operations

CreateFleet
ListFleets
DeleteFleet
Describe fleets:
- DescribeFleetAttributes
- DescribeFleetCapacity
- DescribeFleetPortSettings
- DescribeFleetUtilization
- DescribeRuntimeConfiguration
- DescribeEC2InstanceLimits
- DescribeFleetEvents
UpdateFleetAttributes
StartFleetActions or StopFleetActions

Examples:

Request syntax with placeholder values


resp = client.describe_runtime_configuration({
  fleet_id: "FleetIdOrArn", # required
})

Response structure


resp.runtime_configuration.server_processes #=> Array
resp.runtime_configuration.server_processes[0].launch_path #=> String
resp.runtime_configuration.server_processes[0].parameters #=> String
resp.runtime_configuration.server_processes[0].concurrent_executions #=> Integer
resp.runtime_configuration.max_concurrent_game_session_activations #=> Integer
resp.runtime_configuration.game_session_activation_timeout_seconds #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (required, String) —
A unique identifier for a fleet to get the runtime configuration for. You can use either the fleet ID or ARN value.

Returns:

(Types::DescribeRuntimeConfigurationOutput) —
Returns a response object which responds to the following methods:
- #runtime_configuration => Types::RuntimeConfiguration

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5094

def describe_runtime_configuration(params = {}, options = {})
  req = build_request(:describe_runtime_configuration, params)
  req.send_request(options)
end

#describe_scaling_policies(params = {}) ⇒ `Types::DescribeScalingPoliciesOutput`

Retrieves all scaling policies applied to a fleet.

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 ScalingPolicy objects is returned for the fleet.

A fleet may have all of its scaling policies suspended (StopFleetActions). This operation does not affect the status of the scaling policies, which remains ACTIVE. To see whether a fleet's scaling policies are in force or suspended, call DescribeFleetAttributes and check the stopped actions.

DescribeFleetCapacity
UpdateFleetCapacity
DescribeEC2InstanceLimits
Manage scaling policies:
- PutScalingPolicy (auto-scaling)
- DescribeScalingPolicies (auto-scaling)
- DeleteScalingPolicy (auto-scaling)
Manage fleet actions:
- StartFleetActions
- StopFleetActions

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_scaling_policies({
  fleet_id: "FleetIdOrArn", # required
  status_filter: "ACTIVE", # accepts ACTIVE, UPDATE_REQUESTED, UPDATING, DELETE_REQUESTED, DELETING, DELETED, ERROR
  limit: 1,
  next_token: "NonZeroAndMaxString",
})

Response structure


resp.scaling_policies #=> Array
resp.scaling_policies[0].fleet_id #=> String
resp.scaling_policies[0].name #=> String
resp.scaling_policies[0].status #=> String, one of "ACTIVE", "UPDATE_REQUESTED", "UPDATING", "DELETE_REQUESTED", "DELETING", "DELETED", "ERROR"
resp.scaling_policies[0].scaling_adjustment #=> Integer
resp.scaling_policies[0].scaling_adjustment_type #=> String, one of "ChangeInCapacity", "ExactCapacity", "PercentChangeInCapacity"
resp.scaling_policies[0].comparison_operator #=> String, one of "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold"
resp.scaling_policies[0].threshold #=> Float
resp.scaling_policies[0].evaluation_periods #=> Integer
resp.scaling_policies[0].metric_name #=> String, one of "ActivatingGameSessions", "ActiveGameSessions", "ActiveInstances", "AvailableGameSessions", "AvailablePlayerSessions", "CurrentPlayerSessions", "IdleInstances", "PercentAvailableGameSessions", "PercentIdleInstances", "QueueDepth", "WaitTime"
resp.scaling_policies[0].policy_type #=> String, one of "RuleBased", "TargetBased"
resp.scaling_policies[0].target_configuration.target_value #=> Float
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (required, String) —
A unique identifier for a fleet to retrieve scaling policies for. You can use either the fleet ID or ARN value.
:status_filter (String) —
Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status.
- ACTIVE -- The scaling policy is currently in force.
- UPDATEREQUESTED -- A request to update the scaling policy has been received.
- UPDATING -- A change is being made to the scaling policy.
- DELETEREQUESTED -- A request to delete the scaling policy has been received.
- DELETING -- The scaling policy is being deleted.
- DELETED -- The scaling policy has been deleted.
- ERROR -- An error occurred in creating the policy. It should be removed and recreated.
:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
:next_token (String) —
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.

Returns:

(Types::DescribeScalingPoliciesOutput) —
Returns a response object which responds to the following methods:
- #scaling_policies => Array<Types::ScalingPolicy>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5203

def describe_scaling_policies(params = {}, options = {})
  req = build_request(:describe_scaling_policies, params)
  req.send_request(options)
end

#describe_script(params = {}) ⇒ `Types::DescribeScriptOutput`

Retrieves properties for a Realtime script.

To request a script record, specify the script ID. If successful, an object containing the script properties is returned.

Learn more

Remotely Access Fleet Instances

Related operations

CreateScript
ListScripts
DescribeScript
UpdateScript
DeleteScript

Examples:

Request syntax with placeholder values


resp = client.describe_script({
  script_id: "ScriptIdOrArn", # required
})

Response structure


resp.script.script_id #=> String
resp.script.script_arn #=> String
resp.script.name #=> String
resp.script.version #=> String
resp.script.size_on_disk #=> Integer
resp.script.creation_time #=> Time
resp.script.storage_location.bucket #=> String
resp.script.storage_location.key #=> String
resp.script.storage_location.role_arn #=> String
resp.script.storage_location.object_version #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:script_id (required, String) —
A unique identifier for a Realtime script to retrieve properties for. You can use either the script ID or ARN value.

Returns:

(Types::DescribeScriptOutput) —
Returns a response object which responds to the following methods:
- #script => Types::Script

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5264

def describe_script(params = {}, options = {})
  req = build_request(:describe_script, params)
  req.send_request(options)
end

#describe_vpc_peering_authorizations(params = {}) ⇒ `Types::DescribeVpcPeeringAuthorizationsOutput`

Retrieves valid VPC peering authorizations that are pending for the AWS account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account.

CreateVpcPeeringAuthorization
DescribeVpcPeeringAuthorizations
DeleteVpcPeeringAuthorization
CreateVpcPeeringConnection
DescribeVpcPeeringConnections
DeleteVpcPeeringConnection

Examples:

Response structure


resp.vpc_peering_authorizations #=> Array
resp.vpc_peering_authorizations[0].game_lift_aws_account_id #=> String
resp.vpc_peering_authorizations[0].peer_vpc_aws_account_id #=> String
resp.vpc_peering_authorizations[0].peer_vpc_id #=> String
resp.vpc_peering_authorizations[0].creation_time #=> Time
resp.vpc_peering_authorizations[0].expiration_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Returns:

(Types::DescribeVpcPeeringAuthorizationsOutput) —
Returns a response object which responds to the following methods:
- #vpc_peering_authorizations => Array<Types::VpcPeeringAuthorization>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5303

def describe_vpc_peering_authorizations(params = {}, options = {})
  req = build_request(:describe_vpc_peering_authorizations, params)
  req.send_request(options)
end

#describe_vpc_peering_connections(params = {}) ⇒ `Types::DescribeVpcPeeringConnectionsOutput`

Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID.

To retrieve connection information, call this operation from the AWS 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.

CreateVpcPeeringAuthorization
DescribeVpcPeeringAuthorizations
DeleteVpcPeeringAuthorization
CreateVpcPeeringConnection
DescribeVpcPeeringConnections
DeleteVpcPeeringConnection

Examples:

Request syntax with placeholder values


resp = client.describe_vpc_peering_connections({
  fleet_id: "FleetId",
})

Response structure


resp.vpc_peering_connections #=> Array
resp.vpc_peering_connections[0].fleet_id #=> String
resp.vpc_peering_connections[0].fleet_arn #=> String
resp.vpc_peering_connections[0].ip_v4_cidr_block #=> String
resp.vpc_peering_connections[0].vpc_peering_connection_id #=> String
resp.vpc_peering_connections[0].status.code #=> String
resp.vpc_peering_connections[0].status.message #=> String
resp.vpc_peering_connections[0].peer_vpc_id #=> String
resp.vpc_peering_connections[0].game_lift_vpc_id #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (String) —
A unique identifier for a fleet. You can use either the fleet ID or ARN value.

Returns:

(Types::DescribeVpcPeeringConnectionsOutput) —
Returns a response object which responds to the following methods:
- #vpc_peering_connections => Array<Types::VpcPeeringConnection>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5361

def describe_vpc_peering_connections(params = {}, options = {})
  req = build_request(:describe_vpc_peering_connections, params)
  req.send_request(options)
end

#get_game_session_log_url(params = {}) ⇒ `Types::GetGameSessionLogUrlOutput`

Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs.

See the AWS Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved.

CreateGameSession
DescribeGameSessions
DescribeGameSessionDetails
SearchGameSessions
UpdateGameSession
GetGameSessionLogUrl
Game session placements
- StartGameSessionPlacement
- DescribeGameSessionPlacement
- StopGameSessionPlacement

Examples:

Request syntax with placeholder values


resp = client.get_game_session_log_url({
  game_session_id: "ArnStringModel", # required
})

Response structure


resp.pre_signed_url #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:game_session_id (required, String) —
A unique identifier for the game session to get logs for.

Returns:

(Types::GetGameSessionLogUrlOutput) —
Returns a response object which responds to the following methods:
- #pre_signed_url => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5421

def get_game_session_log_url(params = {}, options = {})
  req = build_request(:get_game_session_log_url, params)
  req.send_request(options)
end

#get_instance_access(params = {}) ⇒ `Types::GetInstanceAccessOutput`

Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time.

To remotely access an instance, you need credentials that match the operating system of the instance. For a Windows instance, Amazon GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, Amazon 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 .pem file before using. If you're making this request using the AWS CLI, saving the secret can be handled as part of the GetInstanceAccess request, as shown in one of the examples for this operation.

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 DescribeInstances. If successful, an InstanceAccess object is returned that contains the instance's IP address and a set of credentials.

Learn more

Debug Fleet Issues

Related operations

DescribeInstances
GetInstanceAccess

Examples:

Request syntax with placeholder values


resp = client.get_instance_access({
  fleet_id: "FleetIdOrArn", # required
  instance_id: "InstanceId", # required
})

Response structure


resp.instance_access.fleet_id #=> String
resp.instance_access.instance_id #=> String
resp.instance_access.ip_address #=> String
resp.instance_access.operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2"
resp.instance_access.credentials.user_name #=> String
resp.instance_access.credentials.secret #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (required, String) —
A unique identifier for a 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: ACTIVATING, ACTIVE, or ERROR. Fleets with an ERROR status may be accessible for a short time before they are deleted.
:instance_id (required, String) —
A unique identifier for an instance you want to get access to. You can access an instance in any status.

Returns:

(Types::GetInstanceAccessOutput) —
Returns a response object which responds to the following methods:
- #instance_access => Types::InstanceAccess

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5498

def get_instance_access(params = {}, options = {})
  req = build_request(:get_instance_access, params)
  req.send_request(options)
end

#list_aliases(params = {}) ⇒ `Types::ListAliasesOutput`

Retrieves all aliases for this AWS 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.

Returned aliases are not listed in any particular order.

CreateAlias
ListAliases
DescribeAlias
UpdateAlias
DeleteAlias
ResolveAlias

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_aliases({
  routing_strategy_type: "SIMPLE", # accepts SIMPLE, TERMINAL
  name: "NonEmptyString",
  limit: 1,
  next_token: "NonEmptyString",
})

Response structure


resp.aliases #=> Array
resp.aliases[0].alias_id #=> String
resp.aliases[0].name #=> String
resp.aliases[0].alias_arn #=> String
resp.aliases[0].description #=> String
resp.aliases[0].routing_strategy.type #=> String, one of "SIMPLE", "TERMINAL"
resp.aliases[0].routing_strategy.fleet_id #=> String
resp.aliases[0].routing_strategy.message #=> String
resp.aliases[0].creation_time #=> Time
resp.aliases[0].last_updated_time #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:routing_strategy_type (String) —
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.

Possible routing types include the following:
- SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets.
- TERMINAL -- 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 RoutingStrategy message embedded.
:name (String) —
A descriptive label that is associated with an alias. Alias names do not need to be unique.
:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
:next_token (String) —
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.

Returns:

(Types::ListAliasesOutput) —
Returns a response object which responds to the following methods:
- #aliases => Array<Types::Alias>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5586

def list_aliases(params = {}, options = {})
  req = build_request(:list_aliases, params)
  req.send_request(options)
end

#list_builds(params = {}) ⇒ `Types::ListBuildsOutput`

Retrieves build resources for all builds associated with the AWS account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.

Build resources are not listed in any particular order.

Learn more

Related operations

CreateBuild
ListBuilds
DescribeBuild
UpdateBuild
DeleteBuild

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_builds({
  status: "INITIALIZED", # accepts INITIALIZED, READY, FAILED
  limit: 1,
  next_token: "NonEmptyString",
})

Response structure


resp.builds #=> Array
resp.builds[0].build_id #=> String
resp.builds[0].build_arn #=> String
resp.builds[0].name #=> String
resp.builds[0].version #=> String
resp.builds[0].status #=> String, one of "INITIALIZED", "READY", "FAILED"
resp.builds[0].size_on_disk #=> Integer
resp.builds[0].operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2"
resp.builds[0].creation_time #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:status (String) —
Build status to filter results by. To retrieve all builds, leave this parameter empty.

Possible build statuses include the following:
- INITIALIZED -- 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.
- READY -- The game build has been successfully uploaded. You can now create new fleets for this build.
- FAILED -- The game build upload failed. You cannot create new fleets for this build.
:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
:next_token (String) —
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.

Returns:

(Types::ListBuildsOutput) —
Returns a response object which responds to the following methods:
- #builds => Array<Types::Build>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5678

def list_builds(params = {}, options = {})
  req = build_request(:list_builds, params)
  req.send_request(options)
end

#list_fleets(params = {}) ⇒ `Types::ListFleetsOutput`

Retrieves a collection of fleet resources for this AWS account. You can filter the result set to find only those fleets that are deployed with a specific build or script. Use the pagination parameters to retrieve results in sequential pages.

Fleet resources are not listed in a particular order.

Learn more

Related operations

CreateFleet
ListFleets
DeleteFleet
DescribeFleetAttributes
UpdateFleetAttributes
StartFleetActions or StopFleetActions

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_fleets({
  build_id: "BuildIdOrArn",
  script_id: "ScriptIdOrArn",
  limit: 1,
  next_token: "NonZeroAndMaxString",
})

Response structure


resp.fleet_ids #=> Array
resp.fleet_ids[0] #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:build_id (String) —
A unique identifier for a build to return fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value. To retrieve all fleets, do not include either a BuildId and ScriptID parameter.
:script_id (String) —
A unique identifier for a Realtime script to return fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value. To retrieve all fleets, leave this parameter empty.
:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
:next_token (String) —
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.

Returns:

(Types::ListFleetsOutput) —
Returns a response object which responds to the following methods:
- #fleet_ids => Array<String>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5761

def list_fleets(params = {}, options = {})
  req = build_request(:list_fleets, params)
  req.send_request(options)
end

#list_game_server_groups(params = {}) ⇒ `Types::ListGameServerGroupsOutput`

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Retrieves information on all game servers groups that exist in the current AWS account for the selected Region. Use the pagination parameters to retrieve results in a set of sequential segments.

Learn more

Related operations

CreateGameServerGroup
ListGameServerGroups
DescribeGameServerGroup
UpdateGameServerGroup
DeleteGameServerGroup
ResumeGameServerGroup
SuspendGameServerGroup
DescribeGameServerInstances

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_game_server_groups({
  limit: 1,
  next_token: "NonZeroAndMaxString",
})

Response structure


resp.game_server_groups #=> Array
resp.game_server_groups[0].game_server_group_name #=> String
resp.game_server_groups[0].game_server_group_arn #=> String
resp.game_server_groups[0].role_arn #=> String
resp.game_server_groups[0].instance_definitions #=> Array
resp.game_server_groups[0].instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
resp.game_server_groups[0].instance_definitions[0].weighted_capacity #=> String
resp.game_server_groups[0].balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
resp.game_server_groups[0].game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
resp.game_server_groups[0].auto_scaling_group_arn #=> String
resp.game_server_groups[0].status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
resp.game_server_groups[0].status_reason #=> String
resp.game_server_groups[0].suspended_actions #=> Array
resp.game_server_groups[0].suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
resp.game_server_groups[0].creation_time #=> Time
resp.game_server_groups[0].last_updated_time #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential segments.
:next_token (String) —
A token that indicates the start of the next sequential segment of results. Use the token returned with the previous call to this operation. To start at the beginning of the result set, do not specify a value.

Returns:

(Types::ListGameServerGroupsOutput) —
Returns a response object which responds to the following methods:
- #game_server_groups => Array<Types::GameServerGroup>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5847

def list_game_server_groups(params = {}, options = {})
  req = build_request(:list_game_server_groups, params)
  req.send_request(options)
end

#list_game_servers(params = {}) ⇒ `Types::ListGameServersOutput`

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

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.

Learn more

Related operations

RegisterGameServer
ListGameServers
ClaimGameServer
DescribeGameServer
UpdateGameServer
DeregisterGameServer

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_game_servers({
  game_server_group_name: "GameServerGroupNameOrArn", # required
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  limit: 1,
  next_token: "NonZeroAndMaxString",
})

Response structure


resp.game_servers #=> Array
resp.game_servers[0].game_server_group_name #=> String
resp.game_servers[0].game_server_group_arn #=> String
resp.game_servers[0].game_server_id #=> String
resp.game_servers[0].instance_id #=> String
resp.game_servers[0].connection_info #=> String
resp.game_servers[0].game_server_data #=> String
resp.game_servers[0].claim_status #=> String, one of "CLAIMED"
resp.game_servers[0].utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
resp.game_servers[0].registration_time #=> Time
resp.game_servers[0].last_claim_time #=> Time
resp.game_servers[0].last_health_check_time #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:game_server_group_name (required, String) —
An identifier for the game server group to retrieve a list of game servers from. Use either the GameServerGroup name or ARN value.
:sort_order (String) —
Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.
:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential segments.
:next_token (String) —
A token that indicates the start of the next sequential segment of results. Use the token returned with the previous call to this operation. To start at the beginning of the result set, do not specify a value.

Returns:

(Types::ListGameServersOutput) —
Returns a response object which responds to the following methods:
- #game_servers => Array<Types::GameServer>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5939

def list_game_servers(params = {}, options = {})
  req = build_request(:list_game_servers, params)
  req.send_request(options)
end

#list_scripts(params = {}) ⇒ `Types::ListScriptsOutput`

Retrieves script records for all Realtime scripts that are associated with the AWS account in use.

Learn more

Related operations

CreateScript
ListScripts
DescribeScript
UpdateScript
DeleteScript

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_scripts({
  limit: 1,
  next_token: "NonEmptyString",
})

Response structure


resp.scripts #=> Array
resp.scripts[0].script_id #=> String
resp.scripts[0].script_arn #=> String
resp.scripts[0].name #=> String
resp.scripts[0].version #=> String
resp.scripts[0].size_on_disk #=> Integer
resp.scripts[0].creation_time #=> Time
resp.scripts[0].storage_location.bucket #=> String
resp.scripts[0].storage_location.key #=> String
resp.scripts[0].storage_location.role_arn #=> String
resp.scripts[0].storage_location.object_version #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
:next_token (String) —
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.

Returns:

(Types::ListScriptsOutput) —
Returns a response object which responds to the following methods:
- #scripts => Array<Types::Script>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 6010

def list_scripts(params = {}, options = {})
  req = build_request(:list_scripts, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ `Types::ListTagsForResourceResponse`

Retrieves all tags that are assigned to a GameLift resource. Resource tags are used to organize AWS resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:

Build
Script
Fleet
Alias
GameSessionQueue
MatchmakingConfiguration
MatchmakingRuleSet

To list tags for a resource, specify the unique ARN value for the resource.

Learn more

Tagging AWS Resources in the AWS General Reference

AWS Tagging Strategies

Related operations

TagResource
UntagResource
ListTagsForResource

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:resource_arn (required, String) —
The Amazon Resource Name (ARN) 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.

Returns:

(Types::ListTagsForResourceResponse) —
Returns a response object which responds to the following methods:
- #tags => Array<Types::Tag>

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 6087

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_scaling_policy(params = {}) ⇒ `Types::PutScalingPolicyOutput`

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.

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.

You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions with the same fleet action. To stop just one scaling policy--or to permanently remove it, you must delete the policy with DeleteScalingPolicy.

Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling.

Target-based policy

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.

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.

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 TargetConfiguration 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.

Rule-based policy

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.

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%."

A policy's rule statement has the following structure:

If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].

To implement the example, the rule statement would look like this:

If [PercentIdleInstances] is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10].

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.

DescribeFleetCapacity
UpdateFleetCapacity
DescribeEC2InstanceLimits
Manage scaling policies:
- PutScalingPolicy (auto-scaling)
- DescribeScalingPolicies (auto-scaling)
- DeleteScalingPolicy (auto-scaling)
Manage fleet actions:
- StartFleetActions
- StopFleetActions

Examples:

Request syntax with placeholder values


resp = client.put_scaling_policy({
  name: "NonZeroAndMaxString", # required
  fleet_id: "FleetIdOrArn", # required
  scaling_adjustment: 1,
  scaling_adjustment_type: "ChangeInCapacity", # accepts ChangeInCapacity, ExactCapacity, PercentChangeInCapacity
  threshold: 1.0,
  comparison_operator: "GreaterThanOrEqualToThreshold", # accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
  evaluation_periods: 1,
  metric_name: "ActivatingGameSessions", # required, accepts ActivatingGameSessions, ActiveGameSessions, ActiveInstances, AvailableGameSessions, AvailablePlayerSessions, CurrentPlayerSessions, IdleInstances, PercentAvailableGameSessions, PercentIdleInstances, QueueDepth, WaitTime
  policy_type: "RuleBased", # accepts RuleBased, TargetBased
  target_configuration: {
    target_value: 1.0, # required
  },
})

Response structure


resp.name #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:name (required, String) —
A descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.
:fleet_id (required, String) —
A unique identifier for a 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.
:scaling_adjustment (Integer) —
Amount of adjustment to make, based on the scaling adjustment type.
:scaling_adjustment_type (String) —
The type of adjustment to make to a fleet's instance count (see FleetCapacity):
- ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
- ExactCapacity -- set the instance count to the scaling adjustment value.
- PercentChangeInCapacity -- 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%.
:threshold (Float) —
Metric value used to trigger a scaling event.
:comparison_operator (String) —
Comparison operator to use when measuring the metric against the threshold value.
:evaluation_periods (Integer) —
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
:metric_name (required, String) —
Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.
- ActivatingGameSessions -- Game sessions in the process of being created.
- ActiveGameSessions -- Game sessions that are currently running.
- ActiveInstances -- Fleet instances that are currently running at least one game session.
- AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, given current capacity.
- AvailablePlayerSessions -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.
- CurrentPlayerSessions -- Player slots in active game sessions that are being used by a player or are reserved for a player.
- IdleInstances -- Active instances that are currently hosting zero game sessions.
- PercentAvailableGameSessions -- 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.
- PercentIdleInstances -- Percentage of the total number of active instances that are hosting zero game sessions.
- QueueDepth -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.
- WaitTime -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination.
:policy_type (String) —
The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
:target_configuration (Types::TargetConfiguration) —
The settings for a target-based scaling policy.

Returns:

(Types::PutScalingPolicyOutput) —
Returns a response object which responds to the following methods:
- #name => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 6324

def put_scaling_policy(params = {}, options = {})
  req = build_request(:put_scaling_policy, params)
  req.send_request(options)
end

#register_game_server(params = {}) ⇒ `Types::RegisterGameServerOutput`

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

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.

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. When a game client or service requests a game server by calling ClaimGameServer, this information is returned in the response.

Once a game server is successfully registered, it is put in status AVAILABLE. 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.

Learn more

Create a Build with Files in S3

Related operations

RegisterGameServer
ListGameServers
ClaimGameServer
DescribeGameServer
UpdateGameServer
DeregisterGameServer

Examples:

Request syntax with placeholder values


resp = client.register_game_server({
  game_server_group_name: "GameServerGroupNameOrArn", # required
  game_server_id: "GameServerId", # required
  instance_id: "GameServerInstanceId", # required
  connection_info: "GameServerConnectionInfo",
  game_server_data: "GameServerData",
})

Response structure


resp.game_server.game_server_group_name #=> String
resp.game_server.game_server_group_arn #=> String
resp.game_server.game_server_id #=> String
resp.game_server.instance_id #=> String
resp.game_server.connection_info #=> String
resp.game_server.game_server_data #=> String
resp.game_server.claim_status #=> String, one of "CLAIMED"
resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
resp.game_server.registration_time #=> Time
resp.game_server.last_claim_time #=> Time
resp.game_server.last_health_check_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:game_server_group_name (required, String) —
A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.
:game_server_id (required, String) —
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 AWS account.
:instance_id (required, String) —
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: i-1234567890abcdef0.
:connection_info (String) —
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.
:game_server_data (String) —
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 using ListGameServers or ClaimGameServer.

Returns:

(Types::RegisterGameServerOutput) —
Returns a response object which responds to the following methods:
- #game_server => Types::GameServer

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 6429

def register_game_server(params = {}, options = {})
  req = build_request(:register_game_server, params)
  req.send_request(options)
end

#request_upload_credentials(params = {}) ⇒ `Types::RequestUploadCredentialsOutput`

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 CreateBuild.

To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.

Learn more

Related operations

CreateBuild
ListBuilds
DescribeBuild
UpdateBuild
DeleteBuild

Examples:

Request syntax with placeholder values


resp = client.request_upload_credentials({
  build_id: "BuildIdOrArn", # required
})

Response structure


resp.upload_credentials.access_key_id #=> String
resp.upload_credentials.secret_access_key #=> String
resp.upload_credentials.session_token #=> String
resp.storage_location.bucket #=> String
resp.storage_location.key #=> String
resp.storage_location.role_arn #=> String
resp.storage_location.object_version #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:build_id (required, String) —
A unique identifier for a build to get credentials for. You can use either the build ID or ARN value.

Returns:

(Types::RequestUploadCredentialsOutput) —
Returns a response object which responds to the following methods:
- #upload_credentials => Types::AwsCredentials
- #storage_location => Types::S3Location

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 6492

def request_upload_credentials(params = {}, options = {})
  req = build_request(:request_upload_credentials, params)
  req.send_request(options)
end

#resolve_alias(params = {}) ⇒ `Types::ResolveAliasOutput`

Retrieves the fleet ID that an alias is currently pointing to.

CreateAlias
ListAliases
DescribeAlias
UpdateAlias
DeleteAlias
ResolveAlias

Examples:

Request syntax with placeholder values


resp = client.resolve_alias({
  alias_id: "AliasIdOrArn", # required
})

Response structure


resp.fleet_id #=> String
resp.fleet_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:alias_id (required, String) —
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.

Returns:

(Types::ResolveAliasOutput) —
Returns a response object which responds to the following methods:
- #fleet_id => String
- #fleet_arn => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 6535

def resolve_alias(params = {}, options = {})
  req = build_request(:resolve_alias, params)
  req.send_request(options)
end

#resume_game_server_group(params = {}) ⇒ `Types::ResumeGameServerGroupOutput`

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Reinstates activity on a game server group after it has been suspended. A game server group might be suspended by theSuspendGameServerGroup 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.

To resume activity, specify a game server group ARN and the type of activity to be resumed. If successful, a GameServerGroup object is returned showing that the resumed activity is no longer listed in SuspendedActions.

Learn more

Related operations

CreateGameServerGroup
ListGameServerGroups
DescribeGameServerGroup
UpdateGameServerGroup
DeleteGameServerGroup
ResumeGameServerGroup
SuspendGameServerGroup
DescribeGameServerInstances

Examples:

Request syntax with placeholder values


resp = client.resume_game_server_group({
  game_server_group_name: "GameServerGroupNameOrArn", # required
  resume_actions: ["REPLACE_INSTANCE_TYPES"], # required, accepts REPLACE_INSTANCE_TYPES
})

Response structure


resp.game_server_group.game_server_group_name #=> String
resp.game_server_group.game_server_group_arn #=> String
resp.game_server_group.role_arn #=> String
resp.game_server_group.instance_definitions #=> Array
resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
resp.game_server_group.auto_scaling_group_arn #=> String
resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
resp.game_server_group.status_reason #=> String
resp.game_server_group.suspended_actions #=> Array
resp.game_server_group.suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
resp.game_server_group.creation_time #=> Time
resp.game_server_group.last_updated_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:game_server_group_name (required, String) —
A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
:resume_actions (required, Array<String>) —
The activity to resume for this game server group.

Returns:

(Types::ResumeGameServerGroupOutput) —
Returns a response object which responds to the following methods:
- #game_server_group => Types::GameServerGroup

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 6622

def resume_game_server_group(params = {}, options = {})
  req = build_request(:resume_game_server_group, params)
  req.send_request(options)
end

#search_game_sessions(params = {}) ⇒ `Types::SearchGameSessionsOutput`

Retrieves all active game sessions that match a set of search criteria and sorts them in a specified order. You can search or sort by the following game session attributes:

gameSessionId -- A unique identifier for the game session. You can use either a GameSessionId or GameSessionArn value.
gameSessionName -- Name assigned to a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession. Game session names do not need to be unique to a game session.
gameSessionProperties -- Custom data defined in a game session's GameProperty parameter. GameProperty 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: gameSessionProperties.gameMode = "brawl". All custom data values are searched as strings.
maximumSessions -- Maximum number of player sessions allowed for a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession.
creationTimeMillis -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds.
playerSessionCount -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out.
hasAvailablePlayerSessions -- 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.

Returned values for playerSessionCount and hasAvailablePlayerSessions 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.

To search or sort, specify either a fleet ID or an alias ID, and provide a search filter expression, a sort expression, or both. If successful, a collection of GameSession objects matching the request is returned. Use the pagination parameters to retrieve results as a set of sequential pages.

You can search for game sessions one fleet at a time only. To find game sessions across multiple fleets, you must search each fleet separately and combine the results. This search feature finds only game sessions that are in ACTIVE status. To locate games in statuses other than active, use DescribeGameSessionDetails.

CreateGameSession
DescribeGameSessions
DescribeGameSessionDetails
SearchGameSessions
UpdateGameSession
GetGameSessionLogUrl
Game session placements
- StartGameSessionPlacement
- DescribeGameSessionPlacement
- StopGameSessionPlacement

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_game_sessions({
  fleet_id: "FleetIdOrArn",
  alias_id: "AliasIdOrArn",
  filter_expression: "NonZeroAndMaxString",
  sort_expression: "NonZeroAndMaxString",
  limit: 1,
  next_token: "NonZeroAndMaxString",
})

Response structure


resp.game_sessions #=> Array
resp.game_sessions[0].game_session_id #=> String
resp.game_sessions[0].name #=> String
resp.game_sessions[0].fleet_id #=> String
resp.game_sessions[0].fleet_arn #=> String
resp.game_sessions[0].creation_time #=> Time
resp.game_sessions[0].termination_time #=> Time
resp.game_sessions[0].current_player_session_count #=> Integer
resp.game_sessions[0].maximum_player_session_count #=> Integer
resp.game_sessions[0].status #=> String, one of "ACTIVE", "ACTIVATING", "TERMINATED", "TERMINATING", "ERROR"
resp.game_sessions[0].status_reason #=> String, one of "INTERRUPTED"
resp.game_sessions[0].game_properties #=> Array
resp.game_sessions[0].game_properties[0].key #=> String
resp.game_sessions[0].game_properties[0].value #=> String
resp.game_sessions[0].ip_address #=> String
resp.game_sessions[0].dns_name #=> String
resp.game_sessions[0].port #=> Integer
resp.game_sessions[0].player_session_creation_policy #=> String, one of "ACCEPT_ALL", "DENY_ALL"
resp.game_sessions[0].creator_id #=> String
resp.game_sessions[0].game_session_data #=> String
resp.game_sessions[0].matchmaker_data #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (String) —
A unique identifier for a 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.
:alias_id (String) —
A unique identifier for an 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.
:filter_expression (String) —
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 ACTIVE status.

A filter expression can contain one or multiple conditions. Each condition consists of the following:
- Operand -- Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
- Comparator -- Valid comparators are: =, <>, <, >, <=, >=.
- Value -- 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 = and <>. For example, the following filter expression searches on gameSessionName: "FilterExpression": "gameSessionName = 'Matt\'s Awesome Game 1'".
To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y).

Session search evaluates conditions from left to right using the following precedence rules:
1. =, <>, <, >, <=, >=
2. Parentheses
3. NOT
4. AND
5. OR
For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true".
:sort_expression (String) —
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:
- Operand -- Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
- Order -- Valid sort orders are ASC (ascending) and DESC (descending).
For example, this sort expression returns the oldest active sessions first: "SortExpression": "creationTimeMillis ASC". Results with a null value for the sort operand are returned at the end of the list.
:limit (Integer) —
The maximum number of results to return. Use this parameter with NextToken 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.
:next_token (String) —
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.

Returns:

(Types::SearchGameSessionsOutput) —
Returns a response object which responds to the following methods:
- #game_sessions => Array<Types::GameSession>
- #next_token => String

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 6837

def search_game_sessions(params = {}, options = {})
  req = build_request(:search_game_sessions, params)
  req.send_request(options)
end

#start_fleet_actions(params = {}) ⇒ `Struct`

Resumes activity on a fleet that was suspended with StopFleetActions. Currently, this operation is used to restart a fleet's auto-scaling activity.

To start fleet actions, specify the fleet ID and the type of actions to restart. When auto-scaling fleet actions are restarted, Amazon GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet were never stopped, this operation will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes.

Learn more

Backfill Existing Games with FlexMatch

Related operations

CreateFleet
ListFleets
DeleteFleet
DescribeFleetAttributes
UpdateFleetAttributes
StartFleetActions or StopFleetActions

Examples:

Request syntax with placeholder values


resp = client.start_fleet_actions({
  fleet_id: "FleetIdOrArn", # required
  actions: ["AUTO_SCALING"], # required, accepts AUTO_SCALING
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (required, String) —
A unique identifier for a fleet to start actions on. You can use either the fleet ID or ARN value.
:actions (required, Array<String>) —
List of actions to restart on the fleet.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 6895

def start_fleet_actions(params = {}, options = {})
  req = build_request(:start_fleet_actions, params)
  req.send_request(options)
end

#start_game_session_placement(params = {}) ⇒ `Types::StartGameSessionPlacementOutput`

Places a request for a new game session in a queue (see CreateGameSessionQueue). 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.

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.

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.

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.

To place a new game session request, specify the following:

The queue name and a set of game session properties and settings
A unique ID (such as a UUID) for the placement. You use this ID to track the status of the placement request
(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)
Latency data for all players (if you want to optimize game play for the players)

If successful, a new game session placement is created.

To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the status is FULFILLED, 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.

CreateGameSession
DescribeGameSessions
DescribeGameSessionDetails
SearchGameSessions
UpdateGameSession
GetGameSessionLogUrl
Game session placements
- StartGameSessionPlacement
- DescribeGameSessionPlacement
- StopGameSessionPlacement

Examples:

Request syntax with placeholder values


resp = client.start_game_session_placement({
  placement_id: "IdStringModel", # required
  game_session_queue_name: "GameSessionQueueNameOrArn", # required
  game_properties: [
    {
      key: "GamePropertyKey", # required
      value: "GamePropertyValue", # required
    },
  ],
  maximum_player_session_count: 1, # required
  game_session_name: "NonZeroAndMaxString",
  player_latencies: [
    {
      player_id: "NonZeroAndMaxString",
      region_identifier: "NonZeroAndMaxString",
      latency_in_milliseconds: 1.0,
    },
  ],
  desired_player_sessions: [
    {
      player_id: "NonZeroAndMaxString",
      player_data: "PlayerData",
    },
  ],
  game_session_data: "GameSessionData",
})

Response structure


resp.game_session_placement.placement_id #=> String
resp.game_session_placement.game_session_queue_name #=> String
resp.game_session_placement.status #=> String, one of "PENDING", "FULFILLED", "CANCELLED", "TIMED_OUT", "FAILED"
resp.game_session_placement.game_properties #=> Array
resp.game_session_placement.game_properties[0].key #=> String
resp.game_session_placement.game_properties[0].value #=> String
resp.game_session_placement.maximum_player_session_count #=> Integer
resp.game_session_placement.game_session_name #=> String
resp.game_session_placement.game_session_id #=> String
resp.game_session_placement.game_session_arn #=> String
resp.game_session_placement.game_session_region #=> String
resp.game_session_placement.player_latencies #=> Array
resp.game_session_placement.player_latencies[0].player_id #=> String
resp.game_session_placement.player_latencies[0].region_identifier #=> String
resp.game_session_placement.player_latencies[0].latency_in_milliseconds #=> Float
resp.game_session_placement.start_time #=> Time
resp.game_session_placement.end_time #=> Time
resp.game_session_placement.ip_address #=> String
resp.game_session_placement.dns_name #=> String
resp.game_session_placement.port #=> Integer
resp.game_session_placement.placed_player_sessions #=> Array
resp.game_session_placement.placed_player_sessions[0].player_id #=> String
resp.game_session_placement.placed_player_sessions[0].player_session_id #=> String
resp.game_session_placement.game_session_data #=> String
resp.game_session_placement.matchmaker_data #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:placement_id (required, String) —
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 unless you are resubmitting a canceled or timed-out placement request.
:game_session_queue_name (required, String) —
Name of the queue to use to place the new game session. You can use either the queue name or ARN value.
:game_properties (Array<Types::GameProperty>) —
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).
:maximum_player_session_count (required, Integer) —
The maximum number of players that can be connected simultaneously to the game session.
:game_session_name (String) —
A descriptive label that is associated with a game session. Session names do not need to be unique.
:player_latencies (Array<Types::PlayerLatency>) —
Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS 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.
:desired_player_sessions (Array<Types::DesiredPlayerSession>) —
Set of information on each player to create a player session for.
:game_session_data (String) —
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Returns:

(Types::StartGameSessionPlacementOutput) —
Returns a response object which responds to the following methods:
- #game_session_placement => Types::GameSessionPlacement

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 7078

def start_game_session_placement(params = {}, options = {})
  req = build_request(:start_game_session_placement, params)
  req.send_request(options)
end

#start_match_backfill(params = {}) ⇒ `Types::StartMatchBackfillOutput`

Finds new players to fill open slots in an existing game session. This operation can be used to add players to matched games that start with fewer than the maximum number of players or to replace players when they drop out. By backfilling with the same matchmaker used to create the original match, you ensure that new players meet the match criteria and maintain a consistent experience throughout the game session. You can backfill a match anytime after a game session has been created.

To request a match backfill, specify a unique ticket ID, the existing game session's ARN, a matchmaking configuration, and a set of data that describes all current players in the game session. If successful, a match backfill ticket is created and returned with status set to QUEUED. The ticket is placed in the matchmaker's ticket pool and processed. Track the status of the ticket to respond as needed.

The process of finding backfill matches is essentially identical to the initial matchmaking process. The matchmaker searches the pool and groups tickets together to form potential matches, allowing only one backfill ticket per potential match. Once the a match is formed, the matchmaker creates player sessions for the new players. All tickets in the match are updated with the game session's connection information, and the GameSession object is updated to include matchmaker data on the new players. For more detail on how match backfill requests are processed, see How Amazon GameLift FlexMatch Works.

Learn more

How GameLift FlexMatch Works

Related operations

StartMatchmaking
DescribeMatchmaking
StopMatchmaking
AcceptMatch
StartMatchBackfill

Examples:

Request syntax with placeholder values


resp = client.start_match_backfill({
  ticket_id: "MatchmakingIdStringModel",
  configuration_name: "MatchmakingConfigurationName", # required
  game_session_arn: "ArnStringModel",
  players: [ # required
    {
      player_id: "NonZeroAndMaxString",
      player_attributes: {
        "NonZeroAndMaxString" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
      },
      team: "NonZeroAndMaxString",
      latency_in_ms: {
        "NonEmptyString" => 1,
      },
    },
  ],
})

Response structure


resp.matchmaking_ticket.ticket_id #=> String
resp.matchmaking_ticket.configuration_name #=> String
resp.matchmaking_ticket.configuration_arn #=> String
resp.matchmaking_ticket.status #=> String, one of "CANCELLED", "COMPLETED", "FAILED", "PLACING", "QUEUED", "REQUIRES_ACCEPTANCE", "SEARCHING", "TIMED_OUT"
resp.matchmaking_ticket.status_reason #=> String
resp.matchmaking_ticket.status_message #=> String
resp.matchmaking_ticket.start_time #=> Time
resp.matchmaking_ticket.end_time #=> Time
resp.matchmaking_ticket.players #=> Array
resp.matchmaking_ticket.players[0].player_id #=> String
resp.matchmaking_ticket.players[0].player_attributes #=> Hash
resp.matchmaking_ticket.players[0].player_attributes["NonZeroAndMaxString"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.matchmaking_ticket.players[0].team #=> String
resp.matchmaking_ticket.players[0].latency_in_ms #=> Hash
resp.matchmaking_ticket.players[0].latency_in_ms["NonEmptyString"] #=> Integer
resp.matchmaking_ticket.game_session_connection_info.game_session_arn #=> String
resp.matchmaking_ticket.game_session_connection_info.ip_address #=> String
resp.matchmaking_ticket.game_session_connection_info.dns_name #=> String
resp.matchmaking_ticket.game_session_connection_info.port #=> Integer
resp.matchmaking_ticket.game_session_connection_info.matched_player_sessions #=> Array
resp.matchmaking_ticket.game_session_connection_info.matched_player_sessions[0].player_id #=> String
resp.matchmaking_ticket.game_session_connection_info.matched_player_sessions[0].player_session_id #=> String
resp.matchmaking_ticket.estimated_wait_time #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:ticket_id (String) —
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.
:configuration_name (required, String) —
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 GameSession object, MatchmakerData property.
:game_session_arn (String) —
Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it. This is the same as the game session ID.
:players (required, Array<Types::Player>) —
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.
- PlayerID, PlayerAttributes, Team -\\- This information is maintained in the GameSession object, MatchmakerData 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 Match Data.
- 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.

Returns:

(Types::StartMatchBackfillOutput) —
Returns a response object which responds to the following methods:
- #matchmaking_ticket => Types::MatchmakingTicket

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 7225

def start_match_backfill(params = {}, options = {})
  req = build_request(:start_match_backfill, params)
  req.send_request(options)
end

#start_matchmaking(params = {}) ⇒ `Types::StartMatchmakingOutput`

Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. If you're also using GameLift hosting, a new game session is started for the matched players. Each matchmaking request identifies one or more players to find a match for, and specifies the type of match to build, including the team configuration and the rules for an acceptable match. When a matchmaking request identifies a group of players who want to play together, FlexMatch finds additional players to fill the match. Match type, rules, and other features are defined in a MatchmakingConfiguration.

To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. For each player, you must also include the player attribute values that are required by the matchmaking configuration (in the rule set). If successful, a matchmaking ticket is returned with status set to QUEUED.

Track the status of the ticket to respond as needed. If you're also using GameLift hosting, a successfully completed ticket contains game session connection information. Ticket status updates are tracked using event notification through Amazon Simple Notification Service (SNS), which is defined in the matchmaking configuration.

Learn more

Set Up FlexMatch Event Notification

FlexMatch Integration Roadmap

How GameLift FlexMatch Works

Related operations

StartMatchmaking
DescribeMatchmaking
StopMatchmaking
AcceptMatch
StartMatchBackfill

Examples:

Request syntax with placeholder values


resp = client.start_matchmaking({
  ticket_id: "MatchmakingIdStringModel",
  configuration_name: "MatchmakingConfigurationName", # required
  players: [ # required
    {
      player_id: "NonZeroAndMaxString",
      player_attributes: {
        "NonZeroAndMaxString" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
      },
      team: "NonZeroAndMaxString",
      latency_in_ms: {
        "NonEmptyString" => 1,
      },
    },
  ],
})

Response structure


resp.matchmaking_ticket.ticket_id #=> String
resp.matchmaking_ticket.configuration_name #=> String
resp.matchmaking_ticket.configuration_arn #=> String
resp.matchmaking_ticket.status #=> String, one of "CANCELLED", "COMPLETED", "FAILED", "PLACING", "QUEUED", "REQUIRES_ACCEPTANCE", "SEARCHING", "TIMED_OUT"
resp.matchmaking_ticket.status_reason #=> String
resp.matchmaking_ticket.status_message #=> String
resp.matchmaking_ticket.start_time #=> Time
resp.matchmaking_ticket.end_time #=> Time
resp.matchmaking_ticket.players #=> Array
resp.matchmaking_ticket.players[0].player_id #=> String
resp.matchmaking_ticket.players[0].player_attributes #=> Hash
resp.matchmaking_ticket.players[0].player_attributes["NonZeroAndMaxString"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.matchmaking_ticket.players[0].team #=> String
resp.matchmaking_ticket.players[0].latency_in_ms #=> Hash
resp.matchmaking_ticket.players[0].latency_in_ms["NonEmptyString"] #=> Integer
resp.matchmaking_ticket.game_session_connection_info.game_session_arn #=> String
resp.matchmaking_ticket.game_session_connection_info.ip_address #=> String
resp.matchmaking_ticket.game_session_connection_info.dns_name #=> String
resp.matchmaking_ticket.game_session_connection_info.port #=> Integer
resp.matchmaking_ticket.game_session_connection_info.matched_player_sessions #=> Array
resp.matchmaking_ticket.game_session_connection_info.matched_player_sessions[0].player_id #=> String
resp.matchmaking_ticket.game_session_connection_info.matched_player_sessions[0].player_session_id #=> String
resp.matchmaking_ticket.estimated_wait_time #=> Integer

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:ticket_id (String) —
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.
:configuration_name (required, String) —
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.
:players (required, Array<Types::Player>) —
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, Player objects contain the name of the team the player is assigned to.

Returns:

(Types::StartMatchmakingOutput) —
Returns a response object which responds to the following methods:
- #matchmaking_ticket => Types::MatchmakingTicket

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 7353

def start_matchmaking(params = {}, options = {})
  req = build_request(:start_matchmaking, params)
  req.send_request(options)
end

#stop_fleet_actions(params = {}) ⇒ `Struct`

Suspends activity on a fleet. Currently, this operation is used to stop a fleet's auto-scaling activity. It is used to temporarily stop triggering scaling events. The policies can be retained and auto-scaling activity can be restarted using StartFleetActions. You can view a fleet's stopped actions using DescribeFleetAttributes.

To stop fleet actions, specify the fleet ID and the type of actions to suspend. When auto-scaling fleet actions are stopped, Amazon GameLift no longer initiates scaling events except in response to manual changes using UpdateFleetCapacity.

Learn more

Related operations

CreateFleet
ListFleets
DeleteFleet
DescribeFleetAttributes
UpdateFleetAttributes
StartFleetActions or StopFleetActions

Examples:

Request syntax with placeholder values


resp = client.stop_fleet_actions({
  fleet_id: "FleetIdOrArn", # required
  actions: ["AUTO_SCALING"], # required, accepts AUTO_SCALING
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:fleet_id (required, String) —
A unique identifier for a fleet to stop actions on. You can use either the fleet ID or ARN value.
:actions (required, Array<String>) —
List of actions to suspend on the fleet.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 7411

def stop_fleet_actions(params = {}, options = {})
  req = build_request(:stop_fleet_actions, params)
  req.send_request(options)
end

#stop_game_session_placement(params = {}) ⇒ `Types::StopGameSessionPlacementOutput`

Cancels a game session placement that is in PENDING status. To stop a placement, provide the placement ID values. If successful, the placement is moved to CANCELLED status.

CreateGameSession
DescribeGameSessions
DescribeGameSessionDetails
SearchGameSessions
UpdateGameSession
GetGameSessionLogUrl
Game session placements
- StartGameSessionPlacement
- DescribeGameSessionPlacement
- StopGameSessionPlacement

Examples:

Request syntax with placeholder values


resp = client.stop_game_session_placement({
  placement_id: "IdStringModel", # required
})

Response structure


resp.game_session_placement.placement_id #=> String
resp.game_session_placement.game_session_queue_name #=> String
resp.game_session_placement.status #=> String, one of "PENDING", "FULFILLED", "CANCELLED", "TIMED_OUT", "FAILED"
resp.game_session_placement.game_properties #=> Array
resp.game_session_placement.game_properties[0].key #=> String
resp.game_session_placement.game_properties[0].value #=> String
resp.game_session_placement.maximum_player_session_count #=> Integer
resp.game_session_placement.game_session_name #=> String
resp.game_session_placement.game_session_id #=> String
resp.game_session_placement.game_session_arn #=> String
resp.game_session_placement.game_session_region #=> String
resp.game_session_placement.player_latencies #=> Array
resp.game_session_placement.player_latencies[0].player_id #=> String
resp.game_session_placement.player_latencies[0].region_identifier #=> String
resp.game_session_placement.player_latencies[0].latency_in_milliseconds #=> Float
resp.game_session_placement.start_time #=> Time
resp.game_session_placement.end_time #=> Time
resp.game_session_placement.ip_address #=> String
resp.game_session_placement.dns_name #=> String
resp.game_session_placement.port #=> Integer
resp.game_session_placement.placed_player_sessions #=> Array
resp.game_session_placement.placed_player_sessions[0].player_id #=> String
resp.game_session_placement.placed_player_sessions[0].player_session_id #=> String
resp.game_session_placement.game_session_data #=> String
resp.game_session_placement.matchmaker_data #=> String

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:placement_id (required, String) —
A unique identifier for a game session placement to cancel.

Returns:

(Types::StopGameSessionPlacementOutput) —
Returns a response object which responds to the following methods:
- #game_session_placement => Types::GameSessionPlacement

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 7485

def stop_game_session_placement(params = {}, options = {})
  req = build_request(:stop_game_session_placement, params)
  req.send_request(options)
end

#stop_matchmaking(params = {}) ⇒ `Struct`

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 CANCELLED.

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 MatchmakerData of an updated game session object, which is provided to the game server.

If the operation is successful, the service sends back an empty JSON struct with the HTTP 200 response (not an empty HTTP body).

Learn more

Related operations

StartMatchmaking
DescribeMatchmaking
StopMatchmaking
AcceptMatch
StartMatchBackfill

Examples:

Request syntax with placeholder values


resp = client.stop_matchmaking({
  ticket_id: "MatchmakingIdStringModel", # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:ticket_id (required, String) —
A unique identifier for a matchmaking ticket.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 7541

def stop_matchmaking(params = {}, options = {})
  req = build_request(:stop_matchmaking, params)
  req.send_request(options)
end

#suspend_game_server_group(params = {}) ⇒ `Types::SuspendGameServerGroupOutput`

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Temporarily stops activity on a game server group without terminating instances or the game server group. You can restart activity by calling ResumeGameServerGroup. You can suspend the following activity:

Instance type replacement - 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.

To suspend activity, specify a game server group ARN and the type of activity to be suspended. If successful, a GameServerGroup object is returned showing that the activity is listed in SuspendedActions.

Learn more

Related operations

CreateGameServerGroup
ListGameServerGroups
DescribeGameServerGroup
UpdateGameServerGroup
DeleteGameServerGroup
ResumeGameServerGroup
SuspendGameServerGroup
DescribeGameServerInstances

Examples:

Request syntax with placeholder values


resp = client.suspend_game_server_group({
  game_server_group_name: "GameServerGroupNameOrArn", # required
  suspend_actions: ["REPLACE_INSTANCE_TYPES"], # required, accepts REPLACE_INSTANCE_TYPES
})

Response structure


resp.game_server_group.game_server_group_name #=> String
resp.game_server_group.game_server_group_arn #=> String
resp.game_server_group.role_arn #=> String
resp.game_server_group.instance_definitions #=> Array
resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
resp.game_server_group.auto_scaling_group_arn #=> String
resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
resp.game_server_group.status_reason #=> String
resp.game_server_group.suspended_actions #=> Array
resp.game_server_group.suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
resp.game_server_group.creation_time #=> Time
resp.game_server_group.last_updated_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:game_server_group_name (required, String) —
A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
:suspend_actions (required, Array<String>) —
The activity to suspend for this game server group.

Returns:

(Types::SuspendGameServerGroupOutput) —
Returns a response object which responds to the following methods:
- #game_server_group => Types::GameServerGroup

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 7635

def suspend_game_server_group(params = {}, options = {})
  req = build_request(:suspend_game_server_group, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ `Struct`

Assigns a tag to a GameLift resource. AWS 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 AWS cost breakdowns, etc. This operation handles the permissions necessary to manage tags for the following GameLift resource types:

Build
Script
Fleet
Alias
GameSessionQueue
MatchmakingConfiguration
MatchmakingRuleSet

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.

Learn more

Tagging AWS Resources in the AWS General Reference

AWS Tagging Strategies

Related operations

TagResource
UntagResource
ListTagsForResource

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:resource_arn (required, String) —
The Amazon Resource Name (ARN) 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.
:tags (required, Array<Types::Tag>) —
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 Tagging AWS Resources for actual tagging limits.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 7724

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ `Struct`

Removes a tag that is assigned to a GameLift resource. Resource tags are used to organize AWS resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:

Build
Script
Fleet
Alias
GameSessionQueue
MatchmakingConfiguration
MatchmakingRuleSet

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.

Learn more

Tagging AWS Resources in the AWS General Reference

AWS Tagging Strategies

Related operations

TagResource
UntagResource
ListTagsForResource

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:resource_arn (required, String) —
The Amazon Resource Name (ARN) 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.
:tag_keys (required, Array<String>) —
A list of one or more tag keys to remove from the specified GameLift resource. An AWS resource can have only one tag with a specific tag key, so specifying the tag key identifies which tag to remove.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 7801

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_alias(params = {}) ⇒ `Types::UpdateAliasOutput`

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.

CreateAlias
ListAliases
DescribeAlias
UpdateAlias
DeleteAlias
ResolveAlias

Examples:

Request syntax with placeholder values


resp = client.update_alias({
  alias_id: "AliasIdOrArn", # required
  name: "NonBlankAndLengthConstraintString",
  description: "NonZeroAndMaxString",
  routing_strategy: {
    type: "SIMPLE", # accepts SIMPLE, TERMINAL
    fleet_id: "FleetId",
    message: "FreeText",
  },
})

Response structure


resp.alias.alias_id #=> String
resp.alias.name #=> String
resp.alias.alias_arn #=> String
resp.alias.description #=> String
resp.alias.routing_strategy.type #=> String, one of "SIMPLE", "TERMINAL"
resp.alias.routing_strategy.fleet_id #=> String
resp.alias.routing_strategy.message #=> String
resp.alias.creation_time #=> Time
resp.alias.last_updated_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:alias_id (required, String) —
A unique identifier for the alias that you want to update. You can use either the alias ID or ARN value.
:name (String) —
A descriptive label that is associated with an alias. Alias names do not need to be unique.
:description (String) —
A human-readable description of the alias.
:routing_strategy (Types::RoutingStrategy) —
The routing configuration, including routing type and fleet target, for the alias.

Returns:

(Types::UpdateAliasOutput) —
Returns a response object which responds to the following methods:
- #alias => Types::Alias

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 7871

def update_alias(params = {}, options = {})
  req = build_request(:update_alias, params)
  req.send_request(options)
end

#update_build(params = {}) ⇒ `Types::UpdateBuildOutput`

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.

Learn more

Related operations

CreateBuild
ListBuilds
DescribeBuild
UpdateBuild
DeleteBuild

Examples:

Request syntax with placeholder values


resp = client.update_build({
  build_id: "BuildIdOrArn", # required
  name: "NonZeroAndMaxString",
  version: "NonZeroAndMaxString",
})

Response structure


resp.build.build_id #=> String
resp.build.build_arn #=> String
resp.build.name #=> String
resp.build.version #=> String
resp.build.status #=> String, one of "INITIALIZED", "READY", "FAILED"
resp.build.size_on_disk #=> Integer
resp.build.operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2"
resp.build.creation_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —
({})

Options Hash (params):

:build_id (required, String) —
A unique identifier for a build to update. You can use either the build ID or ARN value.
:name (String) —
A descriptive label that is associated with a build. Build names do not need to be unique.
:version (String) —
Version information that is associated with a build or script. Version strings do not need to be unique.

Returns:

(Types::UpdateBuildOutput) —
Returns a response object which responds to the following methods:
- #build => Types::Build

See Also:

AWS API Documentation

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 7940

def update_build(params = {}, options = {})
  req = build_request(:update_build, params)
  req.send_request(options)
end

#update_fleet_attributes(params = {}) ⇒ `Types::UpdateFleetAttributesOutput`

Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values that you want to change. If successful, the fleet ID for the updated fleet is returned.

Learn more