Registers a player's acceptance or rejection of a proposed FlexMatch match. A\n matchmaking configuration may require player acceptance; if so, then matches built with\n that configuration cannot be completed unless all players accept the proposed match\n within a specified time limit.
\nWhen FlexMatch builds a match, all the matchmaking tickets involved in the proposed\n match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for\n your game to get acceptance from all players in the ticket. Acceptances are only valid\n for tickets when they are in this status; all other acceptances result in an\n error.
To register acceptance, specify the ticket ID, a response, and one or more players.\n Once all players have registered acceptance, the matchmaking tickets advance to status\n PLACING, where a new game session is created for the match.
If any player rejects the match, or if acceptances are not received before a specified\n timeout, the proposed match is dropped. The matchmaking tickets are then handled in one\n of two ways: For tickets where one or more players rejected the match, the ticket status\n is returned to SEARCHING to find a new match. For tickets where one or more\n players failed to respond, the ticket status is set to CANCELLED, and\n processing is terminated. A new matchmaking request for these players can be submitted\n as needed.
\n Learn more\n
\n\n \n Add FlexMatch to a game client\n
\n\n FlexMatch events (reference)
\n\n Related actions\n
\n\n StartMatchmaking | \n DescribeMatchmaking | \n StopMatchmaking | \n AcceptMatch | \n StartMatchBackfill | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#AcceptMatchInput": { "type": "structure", "members": { "TicketId": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { "smithy.api#documentation": "A unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE; otherwise this\n request will fail.
A unique identifier for a player delivering the response. This parameter can include one or multiple\n player IDs.
", "smithy.api#required": {} } }, "AcceptanceType": { "target": "com.amazonaws.gamelift#AcceptanceType", "traits": { "smithy.api#documentation": "Player response to the proposed match.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#AcceptMatchOutput": { "type": "structure", "members": {} }, "com.amazonaws.gamelift#AcceptanceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACCEPT", "name": "ACCEPT" }, { "value": "REJECT", "name": "REJECT" } ] } }, "com.amazonaws.gamelift#Alias": { "type": "structure", "members": { "AliasId": { "target": "com.amazonaws.gamelift#AliasId", "traits": { "smithy.api#documentation": "A unique identifier for the alias. Alias IDs are unique within a Region.
" } }, "Name": { "target": "com.amazonaws.gamelift#NonBlankAndLengthConstraintString", "traits": { "smithy.api#documentation": "A descriptive label that is associated with an alias. Alias names do not need to be unique.
" } }, "AliasArn": { "target": "com.amazonaws.gamelift#AliasArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift alias resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:. In a GameLift alias ARN, the resource ID matches the alias ID value.
A human-readable description of an alias.
" } }, "RoutingStrategy": { "target": "com.amazonaws.gamelift#RoutingStrategy", "traits": { "smithy.api#documentation": "The routing configuration, including routing type and fleet target, for the alias.
" } }, "CreationTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { "smithy.api#documentation": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
The time that this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Properties that describe an alias resource.
\n\n Related actions\n
\n\n CreateAlias | \n ListAliases | \n DescribeAlias | \n UpdateAlias | \n DeleteAlias | \n ResolveAlias | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#AliasArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:.*:alias\\/alias-\\S+" } }, "com.amazonaws.gamelift#AliasId": { "type": "string", "traits": { "smithy.api#pattern": "^alias-\\S+" } }, "com.amazonaws.gamelift#AliasIdOrArn": { "type": "string", "traits": { "smithy.api#pattern": "^alias-\\S+|^arn:.*:alias\\/alias-\\S+" } }, "com.amazonaws.gamelift#AliasList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#Alias" } }, "com.amazonaws.gamelift#AmazonResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1011 } } }, "com.amazonaws.gamelift#ArnStringModel": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "[a-zA-Z0-9:/-]+" } }, "com.amazonaws.gamelift#AttributeValue": { "type": "structure", "members": { "S": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "For single string values. Maximum string length is 100 characters.
" } }, "N": { "target": "com.amazonaws.gamelift#DoubleObject", "traits": { "smithy.api#documentation": "For number values, expressed as double.
" } }, "SL": { "target": "com.amazonaws.gamelift#StringList", "traits": { "smithy.api#documentation": "For a list of up to 10 strings. Maximum length for each string is 100 characters.\n Duplicate values are not recognized; all occurrences of the repeated value after the\n first of a repeated value are ignored.
" } }, "SDM": { "target": "com.amazonaws.gamelift#StringDoubleMap", "traits": { "smithy.api#documentation": "For a map of up to 10 data type:value pairs. Maximum length for each string value\n is 100 characters.
" } } }, "traits": { "smithy.api#documentation": "Values for use in Player attribute key-value pairs. This object lets\n you specify an attribute value using any of the valid data types: string, number, string\n array, or data map. Each AttributeValue object can use only one of the\n available properties.
Temporary key allowing access to the Amazon GameLift S3 account.
" } }, "SecretAccessKey": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { "smithy.api#documentation": "Temporary secret key allowing access to the Amazon GameLift S3 account.
" } }, "SessionToken": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { "smithy.api#documentation": "Token used to associate a specific build ID with the files uploaded using these\n credentials.
" } } }, "traits": { "smithy.api#documentation": "Temporary access credentials used for uploading game build files to Amazon GameLift. They\n are valid for a limited time. If they expire before you upload your game build, get a\n new set by calling RequestUploadCredentials.
", "smithy.api#sensitive": {} } }, "com.amazonaws.gamelift#BackfillMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "AUTOMATIC", "name": "AUTOMATIC" }, { "value": "MANUAL", "name": "MANUAL" } ] } }, "com.amazonaws.gamelift#BalancingStrategy": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SPOT_ONLY", "name": "SPOT_ONLY" }, { "value": "SPOT_PREFERRED", "name": "SPOT_PREFERRED" }, { "value": "ON_DEMAND_ONLY", "name": "ON_DEMAND_ONLY" } ] } }, "com.amazonaws.gamelift#BooleanModel": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.gamelift#Build": { "type": "structure", "members": { "BuildId": { "target": "com.amazonaws.gamelift#BuildId", "traits": { "smithy.api#documentation": "A unique identifier for the build.
" } }, "BuildArn": { "target": "com.amazonaws.gamelift#BuildArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:. In a GameLift build ARN, the resource ID matches the\n BuildId value.
A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.
" } }, "Version": { "target": "com.amazonaws.gamelift#FreeText", "traits": { "smithy.api#documentation": "Version information that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.
" } }, "Status": { "target": "com.amazonaws.gamelift#BuildStatus", "traits": { "smithy.api#documentation": "Current status of the build.
\nPossible build statuses include the following:
\n\n INITIALIZED -- A new build has been defined,\n but no files have been uploaded. You cannot create fleets for builds that are in\n this status. When a build is successfully created, the build status is set to\n this value.
\n\n READY -- The game build has been successfully\n uploaded. You can now create new fleets for this build.
\n\n FAILED -- The game build upload failed. You\n cannot create new fleets for this build.
\nFile size of the uploaded game build, expressed in bytes. When the build status is\n INITIALIZED, this value is 0.
Operating system that the game server binaries are built to run on. This value\n determines the type of fleet resources that you can use for this build.
" } }, "CreationTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { "smithy.api#documentation": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Properties describing a custom game build.
\n\n Related actions\n
\n\n CreateBuild | \n ListBuilds | \n DescribeBuild | \n UpdateBuild | \n DeleteBuild | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#BuildArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:.*:build\\/build-\\S+" } }, "com.amazonaws.gamelift#BuildId": { "type": "string", "traits": { "smithy.api#pattern": "^build-\\S+" } }, "com.amazonaws.gamelift#BuildIdOrArn": { "type": "string", "traits": { "smithy.api#pattern": "^build-\\S+|^arn:.*:build\\/build-\\S+" } }, "com.amazonaws.gamelift#BuildList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#Build" } }, "com.amazonaws.gamelift#BuildStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "INITIALIZED", "name": "INITIALIZED" }, { "value": "READY", "name": "READY" }, { "value": "FAILED", "name": "FAILED" } ] } }, "com.amazonaws.gamelift#CertificateConfiguration": { "type": "structure", "members": { "CertificateType": { "target": "com.amazonaws.gamelift#CertificateType", "traits": { "smithy.api#documentation": "Indicates whether a TLS/SSL certificate is generated for a fleet.
\nValid values include:
\n\n GENERATED - Generate a TLS/SSL certificate\n for this fleet.
\n\n DISABLED - (default) Do not generate a\n TLS/SSL certificate for this fleet.
\n", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "
Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be\n enabled when creating the fleet. All instances in a fleet share the same\n certificate. The certificate can be retrieved by calling the\n GameLift Server\n SDK operation GetInstanceCertificate.
A fleet's certificate configuration is part of FleetAttributes.
" } }, "com.amazonaws.gamelift#CertificateType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "DISABLED", "name": "Disabled" }, { "value": "GENERATED", "name": "Generated" } ] } }, "com.amazonaws.gamelift#ClaimGameServer": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#ClaimGameServerInput" }, "output": { "target": "com.amazonaws.gamelift#ClaimGameServerOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#ConflictException" }, { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#OutOfCapacityException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "\n This operation is used with the GameLift FleetIQ solution and game server groups.\n
\nLocates an available game server and temporarily reserves it to host gameplay and\n players. This operation is called from a game client or client service (such as a\n matchmaker) to request hosting resources for a new game session. In response, GameLift FleetIQ\n locates an available game server, places it in CLAIMED status for 60\n seconds, and returns connection information that players can use to connect to the game\n server.
To claim a game server, identify a game server group. You can also specify a game\n server ID, although this approach bypasses GameLift FleetIQ placement optimization. Optionally,\n include game data to pass to the game server at the start of a game session, such as a\n game map or player information.
\nWhen a game server is successfully claimed, connection information is returned. A\n claimed game server's utilization status remains AVAILABLE while the claim\n status is set to CLAIMED for up to 60 seconds. This time period gives the\n game server time to update its status to UTILIZED (using UpdateGameServer) once players join. If the game server's status is not\n updated within 60 seconds, the game server reverts to unclaimed status and is available\n to be claimed by another request. The claim time period is a fixed value and is not\n configurable.
If you try to claim a specific game server, this request will fail in the following\n cases:
\nIf 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\n server is running on an instance in DRAINING status. To avoid this,\n first check the instance status by calling DescribeGameServerInstances.
\n Learn more\n
\n \n\n Related actions\n
\n\n RegisterGameServer | \n ListGameServers | \n ClaimGameServer | \n DescribeGameServer | \n UpdateGameServer | \n DeregisterGameServer | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#ClaimGameServerInput": { "type": "structure", "members": { "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value. If you are not specifying a game server to claim, this value identifies\n where you want GameLift FleetIQ to look for an available game server to claim.
", "smithy.api#required": {} } }, "GameServerId": { "target": "com.amazonaws.gamelift#GameServerId", "traits": { "smithy.api#documentation": "A custom string that uniquely identifies the game server to claim. If this parameter\n is left empty, GameLift FleetIQ searches for an available game server in the specified game\n server group.
" } }, "GameServerData": { "target": "com.amazonaws.gamelift#GameServerData", "traits": { "smithy.api#documentation": "A set of custom game server properties, formatted as a single string value. This data \n is passed to a game client or service when it requests information on game servers using\n ListGameServers or ClaimGameServer.
" } } } }, "com.amazonaws.gamelift#ClaimGameServerOutput": { "type": "structure", "members": { "GameServer": { "target": "com.amazonaws.gamelift#GameServer", "traits": { "smithy.api#documentation": "Object that describes the newly claimed game server.
" } } } }, "com.amazonaws.gamelift#ComparisonOperatorType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "GreaterThanOrEqualToThreshold", "name": "GreaterThanOrEqualToThreshold" }, { "value": "GreaterThanThreshold", "name": "GreaterThanThreshold" }, { "value": "LessThanThreshold", "name": "LessThanThreshold" }, { "value": "LessThanOrEqualToThreshold", "name": "LessThanOrEqualToThreshold" } ] } }, "com.amazonaws.gamelift#ConflictException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.gamelift#NonEmptyString" } }, "traits": { "smithy.api#documentation": "The requested operation would cause a conflict with the current state of a service\n resource associated with the request. Resolve the conflict before retrying this\n request.
", "smithy.api#error": "client" } }, "com.amazonaws.gamelift#CreateAlias": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#CreateAliasInput" }, "output": { "target": "com.amazonaws.gamelift#CreateAliasOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#ConflictException" }, { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#LimitExceededException" }, { "target": "com.amazonaws.gamelift#TaggingFailedException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Creates an alias for a fleet. In most situations, you can use an alias ID in place of\n a fleet ID. An alias provides a level of abstraction for a fleet that is useful when\n redirecting player traffic from one fleet to another, such as when updating your game\n build.
\nAmazon GameLift supports two types of routing strategies for aliases: simple and terminal. A\n simple alias points to an active fleet. A terminal alias is used to display messaging or\n link to a URL instead of routing players to an active fleet. For example, you might use\n a terminal alias when a game version is no longer supported and you want to direct\n players to an upgrade site.
\nTo create a fleet alias, specify an alias name, routing strategy, and optional\n description. Each simple alias can point to only one fleet, but a fleet can have\n multiple aliases. If successful, a new alias record is returned, including an alias ID\n and an ARN. You can reassign an alias to another fleet by calling\n UpdateAlias.
\n Related actions\n
\n\n CreateAlias | \n ListAliases | \n DescribeAlias | \n UpdateAlias | \n DeleteAlias | \n ResolveAlias | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#CreateAliasInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.gamelift#NonBlankAndLengthConstraintString", "traits": { "smithy.api#documentation": "A descriptive label that is associated with an alias. Alias names do not need to be unique.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A human-readable description of the alias.
" } }, "RoutingStrategy": { "target": "com.amazonaws.gamelift#RoutingStrategy", "traits": { "smithy.api#documentation": "The routing configuration, including routing type and fleet target, for the alias.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.gamelift#TagList", "traits": { "smithy.api#documentation": "A list of labels to assign to the new alias resource. Tags are developer-defined \n key-value pairs. Tagging\n AWS resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging AWS Resources in the\n AWS General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the AWS General Reference for actual \n tagging limits.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#CreateAliasOutput": { "type": "structure", "members": { "Alias": { "target": "com.amazonaws.gamelift#Alias", "traits": { "smithy.api#documentation": "The newly created alias resource.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#CreateBuild": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#CreateBuildInput" }, "output": { "target": "com.amazonaws.gamelift#CreateBuildOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#ConflictException" }, { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#TaggingFailedException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Creates a new Amazon GameLift build resource for your game server binary files. Game server\n binaries must be combined into a zip file for use with Amazon GameLift.
\nWhen setting up a new game build for GameLift, we recommend using the AWS CLI\n command \n upload-build\n . This helper command combines two tasks: (1) it\n uploads your build files from a file directory to a GameLift Amazon S3 location, and (2)\n it creates a new build resource.
\nThe CreateBuild operation can used in the following scenarios:
To create a new game build with build files that are in an Amazon S3 location under\n an AWS account that you control. To use this option, you must first give Amazon GameLift\n access to the Amazon S3 bucket. With permissions in place, call\n CreateBuild and specify a build name, operating system, and the\n Amazon S3 storage location of your game build.
To directly upload your build files to a GameLift Amazon S3 location. To use this\n option, first call CreateBuild and specify a build name and\n operating system. This operation creates a new build resource and also returns an\n Amazon S3 location with temporary access credentials. Use the credentials to manually\n upload your build files to the specified Amazon S3 location. For more information,\n see Uploading Objects in the Amazon S3 Developer\n Guide. Build files can be uploaded to the GameLift Amazon S3 location\n once only; that can't be updated.
If successful, this operation creates a new build resource with a unique build ID and\n places it in INITIALIZED status. A build must be in READY\n status before you can create fleets with it.
\n Learn more\n
\n \n\n Create a Build with Files in Amazon S3\n
\n\n Related actions\n
\n\n CreateBuild | \n ListBuilds | \n DescribeBuild | \n UpdateBuild | \n DeleteBuild | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#CreateBuildInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "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.\n
" } }, "Version": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "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.\n
" } }, "StorageLocation": { "target": "com.amazonaws.gamelift#S3Location", "traits": { "smithy.api#documentation": "Information indicating where your game build files are stored. Use this parameter only\n when creating a build with files stored in an Amazon S3 bucket that you own. The storage\n location must specify an Amazon S3 bucket name and key. The location must also specify a role\n ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your\n new build must be in the same Region.
" } }, "OperatingSystem": { "target": "com.amazonaws.gamelift#OperatingSystem", "traits": { "smithy.api#documentation": "The operating system that the game server binaries are built to run on. This value\n determines the type of fleet resources that you can use for this build. If your game\n build contains multiple executables, they all must run on the same operating system. If\n an operating system is not specified when creating a build, Amazon GameLift uses the\n default value (WINDOWS_2012). This value cannot be changed later.
" } }, "Tags": { "target": "com.amazonaws.gamelift#TagList", "traits": { "smithy.api#documentation": "A list of labels to assign to the new build resource. Tags are developer-defined \n key-value pairs. Tagging\n AWS resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging AWS Resources in the\n AWS General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the AWS General Reference for actual \n tagging limits.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#CreateBuildOutput": { "type": "structure", "members": { "Build": { "target": "com.amazonaws.gamelift#Build", "traits": { "smithy.api#documentation": "The newly created build resource, including a unique build IDs and status.
" } }, "UploadCredentials": { "target": "com.amazonaws.gamelift#AwsCredentials", "traits": { "smithy.api#documentation": "This element is returned only when the operation is called without a storage\n location. It contains credentials to use when you are uploading a build file to an Amazon S3\n bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these\n credentials, call RequestUploadCredentials.
" } }, "StorageLocation": { "target": "com.amazonaws.gamelift#S3Location", "traits": { "smithy.api#documentation": "Amazon S3 location for your game build file, including bucket name and\n key.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#CreateFleet": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#CreateFleetInput" }, "output": { "target": "com.amazonaws.gamelift#CreateFleetOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#ConflictException" }, { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#LimitExceededException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#TaggingFailedException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Creates a fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your\n custom game server or Realtime Servers. Use this operation to configure the computing resources for\n your fleet and provide instructions for running game servers on each instance.
\nMost GameLift fleets can deploy instances to multiple locations, including the home\n Region (where the fleet is created) and an optional set of remote locations. Fleets that\n are created in the following AWS Regions support multiple locations: us-east-1 (N.\n Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland),\n ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that\n are created in other GameLift Regions can deploy instances in the fleet's home Region\n only. All fleet instances use the same configuration regardless of location; however,\n you can adjust capacity settings and turn auto-scaling on/off for each location.
\nTo create a fleet, choose the hardware for your instances, specify a game server build\n or Realtime script to deploy, and provide a runtime configuration to direct GameLift how\n to start and run game servers on each instance in the fleet. Set permissions for inbound\n traffic to your game servers, and enable optional features as needed. When creating a\n multi-location fleet, provide a list of additional remote locations.
\n \nIf successful, this operation creates a new Fleet resource and places it in\n NEW status, which prompts GameLift to initiate the fleet creation\n workflow. You can track fleet creation by checking fleet status using DescribeFleetAttributes and DescribeFleetLocationAttributes/, or by monitoring fleet creation events\n using DescribeFleetEvents. As soon as the fleet status changes to\n ACTIVE, you can enable automatic scaling for the fleet with PutScalingPolicy and set capacity for the home Region with UpdateFleetCapacity. When the status of each remote location reaches\n ACTIVE, you can set capacity by location using UpdateFleetCapacity.
\n Learn more\n
\n\n Setting up fleets\n
\n\n Debug fleet creation issues\n
\n \n\n Related actions\n
\n\n CreateFleet | \n UpdateFleetCapacity | \n PutScalingPolicy | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetLocationAttributes | \n UpdateFleetAttributes | \n StopFleetActions | \n DeleteFleet | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#CreateFleetInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A human-readable description of the fleet.
" } }, "BuildId": { "target": "com.amazonaws.gamelift#BuildIdOrArn", "traits": { "smithy.api#documentation": "The unique identifier for a custom game server build to be deployed on fleet\n instances. You can use either the build ID or ARN. The build must be uploaded to GameLift\n and in READY status. This fleet property cannot be changed later.
The unique identifier for a Realtime configuration script to be deployed on fleet\n instances. You can use either the script ID or ARN. Scripts must be uploaded to GameLift\n prior to creating the fleet. This fleet property cannot be changed later.
" } }, "ServerLaunchPath": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "\n This parameter is no longer used. Specify a server\n launch path using the RuntimeConfiguration parameter. Requests that use\n this parameter instead continue to be valid.
\n This parameter is no longer used. Specify server\n launch parameters using the RuntimeConfiguration parameter. Requests that\n use this parameter instead continue to be valid.
\n This parameter is no longer used. To specify where\n GameLift should store log files once a server process shuts down, use the GameLift server\n API ProcessReady() and specify one or more directory paths in\n logParameters. See more information in the Server API Reference.
The GameLift-supported EC2 instance type to use for all fleet instances. Instance\n type determines the computing resources that will be used to host your game servers,\n including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions\n of EC2 instance types.
", "smithy.api#required": {} } }, "EC2InboundPermissions": { "target": "com.amazonaws.gamelift#IpPermissionsList", "traits": { "smithy.api#documentation": "The allowed IP address ranges and port settings that allow inbound traffic to access\n game sessions on this fleet. If the fleet is hosting a custom game build, this property\n must be set before players can connect to game sessions. For Realtime Servers fleets, GameLift\n automatically sets TCP and UDP ranges.
" } }, "NewGameSessionProtectionPolicy": { "target": "com.amazonaws.gamelift#ProtectionPolicy", "traits": { "smithy.api#documentation": "The status of termination protection for active game sessions on the fleet. By\n default, this property is set to NoProtection. You can also set game\n session protection for an individual game session by calling UpdateGameSession.
\n NoProtection - Game sessions can be terminated\n during active gameplay as a result of a scale-down event.
\n\n FullProtection - Game sessions in\n ACTIVE status cannot be terminated during a scale-down\n event.
Instructions for how to launch and maintain server processes on instances in the\n fleet. The runtime configuration defines one or more server process configurations, each\n identifying a build executable or Realtime script file and the number of processes of\n that type to run concurrently.
\nThe RuntimeConfiguration parameter is required unless the fleet is\n being configured using the older parameters ServerLaunchPath and\n ServerLaunchParameters, which are still supported for backward\n compatibility.
A policy that limits the number of game sessions that an individual player can create\n on instances in this fleet within a specified span of time.
" } }, "MetricGroups": { "target": "com.amazonaws.gamelift#MetricGroupList", "traits": { "smithy.api#documentation": "The name of an AWS CloudWatch metric group to add this fleet to. A metric group is\n used to aggregate the metrics for multiple fleets. You can specify an existing metric\n group name or set a new name to create a new metric group. A fleet can be included in\n only one metric group at a time.
" } }, "PeerVpcAwsAccountId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "Used when peering your GameLift fleet with a VPC, the unique identifier for the AWS\n account that owns the VPC. You can find your account ID in the AWS Management Console under account\n settings.
" } }, "PeerVpcId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The\n VPC must be in the same Region as your fleet. To look up a VPC ID, use the \n VPC Dashboard in the AWS Management Console. \n Learn more about VPC peering in VPC Peering with GameLift Fleets.
" } }, "FleetType": { "target": "com.amazonaws.gamelift#FleetType", "traits": { "smithy.api#documentation": "Indicates whether to use On-Demand or Spot instances for this fleet. By default, this\n property is set to ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the\n fleet is created.
A unique identifier for an AWS IAM role that manages access to your AWS services. \n With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, \n including install scripts, server processes, and daemons (background processes). Create a role or look up a role's \n ARN by using the IAM dashboard in the AWS Management Console.\n Learn more about using on-box credentials for your game servers at \n \n Access external resources from a game server. This property cannot be changed after the fleet is created.
" } }, "CertificateConfiguration": { "target": "com.amazonaws.gamelift#CertificateConfiguration", "traits": { "smithy.api#documentation": "Prompts GameLift to generate a TLS/SSL certificate for the fleet. TLS certificates are\n used for encrypting traffic between game clients and the game servers that are running\n on GameLift. By default, the CertificateConfiguration is set to\n DISABLED. Learn more at Securing Client/Server Communication. This property cannot be changed after\n the fleet is created.
Note: This feature requires the AWS Certificate Manager (ACM) service, which is not\n available in all AWS regions. When working in a region that does not support this\n feature, a fleet creation request with certificate generation fails with a 4xx\n error.
" } }, "Locations": { "target": "com.amazonaws.gamelift#LocationConfigurationList", "traits": { "smithy.api#documentation": "A set of remote locations to deploy additional instances to and manage as part of the\n fleet. This parameter can only be used when creating fleets in AWS Regions that support\n multiple locations. You can add any GameLift-supported AWS Region as a remote location,\n in the form of an AWS Region code such as us-west-2. To create a fleet with\n instances in the home Region only, omit this parameter.
A list of labels to assign to the new fleet resource. Tags are developer-defined\n key-value pairs. Tagging AWS resources are useful for resource management, access\n management and cost allocation. For more information, see Tagging AWS Resources in the\n AWS General Reference. Once the fleet is created, you can use\n TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit\n may be lower than stated. See the AWS General Reference for actual\n tagging limits.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#CreateFleetLocations": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#CreateFleetLocationsInput" }, "output": { "target": "com.amazonaws.gamelift#CreateFleetLocationsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidFleetStatusException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Adds remote locations to a fleet and begins populating the new locations with EC2\n instances. The new instances conform to the fleet's instance type, auto-scaling, and\n other configuration settings.
\nThis operation cannot be used with fleets that don't support remote locations. Fleets\n can have multiple locations only if they reside in AWS Regions that support this\n feature (see CreateFleet for the complete list) and were created\n after the feature was released in March 2021.
\nTo add fleet locations, specify the fleet to be updated and provide a list of one or\n more locations.
\nIf successful, this operation returns the list of added locations with their status set\n to NEW. GameLift initiates the process of starting an instance in each added\n location. You can track the status of each new location by monitoring location creation\n events using DescribeFleetEvents. Alternatively, you can poll location\n status by calling DescribeFleetLocationAttributes. After a location\n status becomes ACTIVE, you can adjust the location's capacity as needed\n with UpdateFleetCapacity.
\n Learn more\n
\n\n Setting up fleets\n
\n \n\n Related actions\n
\n\n CreateFleetLocations |\n DescribeFleetLocationAttributes |\n DescribeFleetLocationCapacity | \n DescribeFleetLocationUtilization | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetUtilization | \n UpdateFleetCapacity | \n StopFleetActions | \n DeleteFleetLocations | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#CreateFleetLocationsInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to add locations to. You can use either the fleet ID or ARN value.
", "smithy.api#required": {} } }, "Locations": { "target": "com.amazonaws.gamelift#LocationConfigurationList", "traits": { "smithy.api#documentation": "A list of locations to deploy additional instances to and manage as part of the fleet.\n You can add any GameLift-supported AWS Region as a remote location, in the form of an AWS\n Region code such as us-west-2.
Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#CreateFleetLocationsOutput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet that was updated with new locations.
" } }, "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:.
The remote locations that are being added to the fleet, and the life-cycle status of each location. \n For new locations, the status is set to NEW.\n During location creation, GameLift updates each location's status as instances \n are deployed there and prepared for game hosting.\n This list does not include the fleet home Region or any remote locations that were already \n added to the fleet.
Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#CreateFleetOutput": { "type": "structure", "members": { "FleetAttributes": { "target": "com.amazonaws.gamelift#FleetAttributes", "traits": { "smithy.api#documentation": "The properties for the new fleet, including the current status. All fleets are placed\n in NEW status on creation.
The fleet's locations and life-cycle status of each location. For new fleets, the\n status of all locations is set to NEW. During fleet creation, GameLift\n updates each location status as instances are deployed there and prepared for game\n hosting. This list includes an entry for the fleet's home Region. For fleets with no\n remote locations, only one entry, representing the home Region, is returned.
Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#CreateGameServerGroup": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#CreateGameServerGroupInput" }, "output": { "target": "com.amazonaws.gamelift#CreateGameServerGroupOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#ConflictException" }, { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#LimitExceededException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "\n This operation is used with the GameLift FleetIQ solution and game server groups.\n
\nCreates a GameLift FleetIQ game server group for managing game hosting on a collection of\n Amazon EC2 instances for game hosting. This operation creates the game server group,\n creates an Auto Scaling group in your AWS account, and establishes a link between the\n two groups. You can view the status of your game server groups in the GameLift console.\n Game server group metrics and events are emitted to Amazon CloudWatch.
\nBefore creating a new game server group, you must have the following:
\nAn Amazon EC2 launch template that specifies how to launch Amazon EC2 instances\n with your game server build. For more information, see Launching an Instance from a Launch Template in the\n Amazon EC2 User Guide.
\nAn IAM role that extends limited access to your AWS account to allow GameLift FleetIQ to create and\n interact with the Auto Scaling group. For more information, see Create IAM roles for cross-service interaction in the GameLift FleetIQ Developer\n Guide.
\nTo create a new game server group, specify a unique group name, IAM role and Amazon EC2\n launch template, and provide a list of instance types that can be used in the group. You\n must also set initial maximum and minimum limits on the group's instance count. You can\n optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ\n metric.
\nOnce the game server group and corresponding Auto Scaling group are created, you have\n full access to change the Auto Scaling group's configuration as needed. Several\n properties that are set when creating a game server group, including maximum/minimum\n size and auto-scaling policy settings, must be updated directly in the Auto Scaling\n group. Keep in mind that some Auto Scaling group properties are periodically updated by\n GameLift FleetIQ as part of its balancing activities to optimize for availability and\n cost.
\n\n Learn more\n
\n \n \n\n Related actions\n
\n\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#CreateGameServerGroupInput": { "type": "structure", "members": { "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupName", "traits": { "smithy.api#documentation": "An identifier for the new game server group. This value is used to generate unique ARN\n identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name\n must be unique per Region per AWS account.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.gamelift#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon GameLift to access your EC2 Auto Scaling groups.
", "smithy.api#required": {} } }, "MinSize": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The minimum number of instances allowed in the EC2 Auto Scaling group. During\n automatic scaling events, GameLift FleetIQ and EC2 do not scale down the group below this\n minimum. In production, this value should be set to at least 1. After the Auto Scaling\n group is created, update this value directly in the Auto Scaling group using the AWS\n console or APIs.
", "smithy.api#required": {} } }, "MaxSize": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#documentation": "The maximum number of instances allowed in the EC2 Auto Scaling group. During\n automatic scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum.\n After the Auto Scaling group is created, update this value directly in the Auto Scaling\n group using the AWS console or APIs.
", "smithy.api#required": {} } }, "LaunchTemplate": { "target": "com.amazonaws.gamelift#LaunchTemplateSpecification", "traits": { "smithy.api#documentation": "The EC2 launch template that contains configuration settings and game server code to\n be deployed to all instances in the game server group. You can specify the template\n using either the template name or ID. For help with creating a launch template, see\n Creating a Launch\n Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling\n User Guide. After the Auto Scaling group is created, update this value\n directly in the Auto Scaling group using the AWS console or APIs.
\nIf you specify network interfaces in your launch template, you must explicitly set\n the property AssociatePublicIpAddress to \"true\". If no network\n interface is specified in the launch template, GameLift FleetIQ uses your account's default\n VPC.
The EC2 instance types and sizes to use in the Auto Scaling group. The instance\n definitions must specify at least two different instance types that are supported by\n GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the\n Amazon EC2 User Guide. You can optionally specify capacity\n weighting for each instance type. If no weight value is specified for an instance type,\n it is set to the default value \"1\". For more information about capacity weighting, see\n Instance Weighting for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#required": {} } }, "AutoScalingPolicy": { "target": "com.amazonaws.gamelift#GameServerGroupAutoScalingPolicy", "traits": { "smithy.api#documentation": "Configuration settings to define a scaling policy for the Auto Scaling group that is\n optimized for game hosting. The scaling policy uses the metric\n \"PercentUtilizedGameServers\" to maintain a buffer of idle game servers\n that can immediately accommodate new games and players. After the Auto Scaling group is\n created, update this value directly in the Auto Scaling group using the AWS console or\n APIs.
Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the\n game server group. Method options include the following:
\n\n SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot\n Instances are unavailable or not viable for game hosting, the game server group\n provides no hosting capacity until Spot Instances can again be used. Until then,\n no new instances are started, and the existing nonviable Spot Instances are\n terminated (after current gameplay ends) and are not replaced.
\n SPOT_PREFERRED - (default value) Spot Instances are used whenever available in\n the game server group. If Spot Instances are unavailable, the game server group\n continues to provide hosting capacity by falling back to On-Demand Instances.\n Existing nonviable Spot Instances are terminated (after current gameplay ends)\n and are replaced with new On-Demand Instances.
\n ON_DEMAND_ONLY - Only On-Demand Instances are used in the game\n server group. No Spot Instances are used, even when available, while this\n balancing strategy is in force.
A flag that indicates whether instances in the game server group are protected \n from early termination. Unprotected instances that have active game servers running might \n be terminated during a scale-down event, causing players to be dropped from the game. \n Protected instances cannot be terminated while there are active game servers running except \n in the event of a forced game server group deletion (see ). An exception to this is with Spot \n Instances, which can be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.
A list of virtual private cloud (VPC) subnets to use with instances in the game server\n group. By default, all GameLift FleetIQ-supported Availability Zones are used. You can use this\n parameter to specify VPCs that you've set up. This property cannot be updated after the\n game server group is created, and the corresponding Auto Scaling group will always use\n the property value that is set with this request, even if the Auto Scaling group is\n updated directly.
" } }, "Tags": { "target": "com.amazonaws.gamelift#TagList", "traits": { "smithy.api#documentation": "A list of labels to assign to the new game server group resource. Tags are\n developer-defined key-value pairs. Tagging AWS resources is useful for resource\n management, access management, and cost allocation. For more information, see Tagging AWS\n Resources in the AWS General Reference. Once the\n resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove,\n and view tags, respectively. The maximum tag limit may be lower than stated. See the\n AWS General Reference for actual tagging limits.
" } } } }, "com.amazonaws.gamelift#CreateGameServerGroupOutput": { "type": "structure", "members": { "GameServerGroup": { "target": "com.amazonaws.gamelift#GameServerGroup", "traits": { "smithy.api#documentation": "The newly created game server group object, including the new ARN value for the GameLift FleetIQ\n game server group and the object's status. The EC2 Auto Scaling group ARN is initially\n null, since the group has not yet been created. This value is added once the game server\n group status reaches ACTIVE.
Creates a multiplayer game session for players in a specific fleet location. This\n operation prompts an available server process to start a game session and retrieves\n connection information for the new game session. As an alternative, consider using the\n GameLift game session placement feature with
\nwith StartGameSessionPlacement, which uses FleetIQ algorithms and\n queues to optimize the placement process.
\nWhen creating a game session, you specify exactly where you want to place it and\n provide a set of game session configuration settings. The fleet must be in\n ACTIVE status before a game session can be created in it.
This operation can be used in the following ways:
\nTo create a game session on an instance in a fleet's home Region, provide a\n fleet or alias ID along with your game session configuration.
\nTo create a game session on an instance in a fleet's remote location, provide\n a fleet or alias ID and a location name, along with your game session\n configuration.
\nIf successful, a workflow is initiated to start a new game session. A\n GameSession object is returned containing the game session\n configuration and status. When the status is ACTIVE, game session\n connection information is provided and player sessions can be created for the game\n session. By default, newly created game sessions are open to new players. You can\n restrict new player access by using UpdateGameSession to change the\n game session's player session creation policy.
Game session logs are retained for all active game sessions for 14 days. To access the\n logs, call GetGameSessionLogUrl to download the log files.
\n\n Available in GameLift Local.\n
\n\n Learn more\n
\n\n Start a game session\n
\n\n Related actions\n
\n\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#CreateGameSessionInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to create a game session in. You can use either the fleet ID or ARN value. Each\n request must reference either a fleet ID or alias ID, but not both.
" } }, "AliasId": { "target": "com.amazonaws.gamelift#AliasIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the alias associated with the fleet to create a game session in. You can use either the\n alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but\n not both.
" } }, "MaximumPlayerSessionCount": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The maximum number of players that can be connected simultaneously to the game session.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A descriptive label that is associated with a game session. Session names do not need to be unique.
" } }, "GameProperties": { "target": "com.amazonaws.gamelift#GamePropertyList", "traits": { "smithy.api#documentation": "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 \n GameSession object with a request to start a new game session.
" } }, "CreatorId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for a player or entity creating the game session. This parameter is required when\n requesting a new game session on a fleet with a resource creation limit policy. This\n type of policy limits the number of concurrent active game sessions that one player can\n create within a certain time span. GameLift uses the CreatorId to evaluate the new\n request against the policy.
" } }, "GameSessionId": { "target": "com.amazonaws.gamelift#IdStringModel", "traits": { "smithy.api#documentation": "\n This parameter is no longer preferred. Please use\n IdempotencyToken instead. Custom string that uniquely\n identifies a request for a new game session. Maximum token length is 48 characters. If\n provided, this string is included in the new game session's ID.
Custom string that uniquely identifies the new game session request. This is useful\n for ensuring that game session requests with the same idempotency token are processed\n only once. Subsequent requests with the same string return the original\n GameSession object, with an updated status. Maximum token length is 48\n characters. If provided, this string is included in the new game session's ID.\n A game session ARN has the following format: \n arn:aws:gamelift:. Idempotency tokens remain in use for 30 days after a game session has ended;\n game session objects are retained for this time period and then deleted.
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session.
" } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "A fleet's remote location to place the new game session in. If this parameter is not\n set, the new game session is placed in the fleet's home Region. Specify a remote\n location with an AWS Region code such as us-west-2.
Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#CreateGameSessionOutput": { "type": "structure", "members": { "GameSession": { "target": "com.amazonaws.gamelift#GameSession", "traits": { "smithy.api#documentation": "Object that describes the newly created game session record.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#CreateGameSessionQueue": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#CreateGameSessionQueueInput" }, "output": { "target": "com.amazonaws.gamelift#CreateGameSessionQueueOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#LimitExceededException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#TaggingFailedException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Creates a placement queue that processes requests for new game sessions. A queue uses\n FleetIQ algorithms to determine the best placement locations and find an\n available game server there, then prompts the game server process to start a new game\n session.
\nA game session queue is configured with a set of destinations (GameLift fleets or\n aliases), which determine the locations where the queue can place new game sessions.\n These destinations can span multiple fleet types (Spot and On-Demand), instance types,\n and AWS Regions. If the queue includes multi-location fleets, the queue is able to place\n game sessions in all of a fleet's remote locations. You can opt to filter out individual\n locations if needed.
\nThe queue configuration also determines how FleetIQ selects the best available placement\n for a new game session. Before searching for an available game server, FleetIQ first\n prioritizes the queue's destinations and locations, with the best placement locations on\n top. You can set up the queue to use the FleetIQ default prioritization or provide an\n alternate set of priorities.
\nTo create a new queue, provide a name, timeout value, and a list of destinations.\n Optionally, specify a sort configuration and/or a filter, and define a set of latency\n cap policies. You can also include the ARN for an Amazon Simple Notification Service\n (SNS) topic to receive notifications of game session placement activity. Notifications\n using SNS or CloudWatch events is the preferred way to track placement activity.
\nIf successful, a new GameSessionQueue object is returned with an assigned\n queue ARN. New game session requests, which are submitted to the queue with StartGameSessionPlacement or StartMatchmaking,\n reference a queue's name or ARN.
\n Learn more\n
\n\n \n Design a game session queue\n
\n\n \n Create a game session queue\n
\n\n Related actions\n
\n\n CreateGameSessionQueue | \n DescribeGameSessionQueues | \n UpdateGameSessionQueue | \n DeleteGameSessionQueue | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#CreateGameSessionQueueInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.gamelift#GameSessionQueueName", "traits": { "smithy.api#documentation": "A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
", "smithy.api#required": {} } }, "TimeoutInSeconds": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "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.
A set of policies that act as a sliding cap on player latency. FleetIQ works to\n deliver low latency for most players in a game session. These policies ensure that no\n individual player can be placed into a game with unreasonably high latency. Use multiple\n policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their\n maximum allowed latency, starting with the lowest value.
" } }, "Destinations": { "target": "com.amazonaws.gamelift#GameSessionQueueDestinationList", "traits": { "smithy.api#documentation": "A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. \n Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
" } }, "FilterConfiguration": { "target": "com.amazonaws.gamelift#FilterConfiguration", "traits": { "smithy.api#documentation": "A list of locations where a queue is allowed to place new game sessions. Locations \n are specified in the form of AWS Region codes, such as us-west-2. If this parameter is \n not set, game sessions can be placed in any queue location.
Custom settings to use when prioritizing destinations and locations for game session placements. This \n configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly \n named will be automatically applied at the end of the prioritization process.
" } }, "CustomEventData": { "target": "com.amazonaws.gamelift#QueueCustomEventData", "traits": { "smithy.api#documentation": "\n Information to be added to all events that are related to this game session queue.\n
" } }, "NotificationTarget": { "target": "com.amazonaws.gamelift#QueueSnsArnStringModel", "traits": { "smithy.api#documentation": "An SNS topic ARN that is set up to receive game session placement notifications. See \n Setting up notifications for game session placement.
" } }, "Tags": { "target": "com.amazonaws.gamelift#TagList", "traits": { "smithy.api#documentation": "A list of labels to assign to the new game session queue resource. Tags are developer-defined \n key-value pairs. Tagging\n AWS resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging AWS Resources in the\n AWS General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the AWS General Reference for actual \n tagging limits.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#CreateGameSessionQueueOutput": { "type": "structure", "members": { "GameSessionQueue": { "target": "com.amazonaws.gamelift#GameSessionQueue", "traits": { "smithy.api#documentation": "An object that describes the newly created game session queue.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#CreateMatchmakingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#CreateMatchmakingConfigurationInput" }, "output": { "target": "com.amazonaws.gamelift#CreateMatchmakingConfigurationOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#LimitExceededException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#TaggingFailedException" }, { "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { "smithy.api#documentation": "Defines a new matchmaking configuration for use with FlexMatch. Whether your are using\n FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking\n configuration sets out rules for matching players and forming teams. If you're also\n using GameLift hosting, it defines how to start game sessions for each match. Your\n matchmaking system can use multiple configurations to handle different game scenarios.\n All matchmaking requests (StartMatchmaking or StartMatchBackfill) identify the matchmaking configuration to use and\n provide player attributes consistent with that configuration.
\nTo create a matchmaking configuration, you must provide the following: configuration\n name and FlexMatch mode (with or without GameLift hosting); a rule set that specifies how\n to evaluate players and find acceptable matches; whether player acceptance is required;\n and the maximum time allowed for a matchmaking attempt. When using FlexMatch with GameLift\n hosting, you also need to identify the game session queue to use when starting a game\n session for the match.
\nIn addition, you must set up an Amazon Simple Notification Service (SNS) topic to receive matchmaking notifications.\n Provide the topic ARN in the matchmaking configuration. An alternative method,\n continuously polling ticket status with DescribeMatchmaking, is only\n suitable for games in development with low matchmaking usage.
\n\n Learn more\n
\n\n \n Design a FlexMatch matchmaker\n
\n\n \n Set up FlexMatch event notification\n
\n\n Related actions\n
\n\n CreateMatchmakingConfiguration | \n DescribeMatchmakingConfigurations | \n UpdateMatchmakingConfiguration | \n DeleteMatchmakingConfiguration | \n CreateMatchmakingRuleSet | \n DescribeMatchmakingRuleSets | \n ValidateMatchmakingRuleSet | \n DeleteMatchmakingRuleSet | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#CreateMatchmakingConfigurationInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { "smithy.api#documentation": "A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a\n matchmaking request or ticket.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A human-readable description of the matchmaking configuration.
" } }, "GameSessionQueueArns": { "target": "com.amazonaws.gamelift#QueueArnsList", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:. Queues can be located in any Region. Queues are used to start new\n GameLift-hosted game sessions for matches that are created with this matchmaking\n configuration. If FlexMatchMode is set to STANDALONE, do not\n set this parameter.
The maximum duration, in seconds, that a matchmaking ticket can remain in process\n before timing out. Requests that fail due to timing out can be resubmitted as\n needed.
", "smithy.api#required": {} } }, "AcceptanceTimeoutSeconds": { "target": "com.amazonaws.gamelift#MatchmakingAcceptanceTimeoutInteger", "traits": { "smithy.api#documentation": "The length of time (in seconds) to wait for players to accept a proposed match, if\n acceptance is required.
" } }, "AcceptanceRequired": { "target": "com.amazonaws.gamelift#BooleanModel", "traits": { "smithy.api#documentation": "A flag that determines whether a match that was created with this configuration must\n be accepted by the matched players. To require acceptance, set to TRUE.\n With this option enabled, matchmaking tickets use the status\n REQUIRES_ACCEPTANCE to indicate when a completed potential match is\n waiting for player acceptance.
A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN\n value. A matchmaking configuration can only use rule sets that are defined in the same\n Region.
", "smithy.api#required": {} } }, "NotificationTarget": { "target": "com.amazonaws.gamelift#SnsArnStringModel", "traits": { "smithy.api#documentation": "An SNS topic ARN that is set up to receive matchmaking notifications. See \n Setting up notifications for matchmaking for more information.
" } }, "AdditionalPlayerCount": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies \n a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if FlexMatchMode is set to\n STANDALONE.
Information to be added to all events related to this matchmaking configuration.\n
" } }, "GameProperties": { "target": "com.amazonaws.gamelift#GamePropertyList", "traits": { "smithy.api#documentation": "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 \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession\n object that is created for a successful match. This parameter is not used if\n FlexMatchMode is set to STANDALONE.
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n 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\n that is created for a successful match. This parameter is not used if\n FlexMatchMode is set to STANDALONE.
The method used to backfill game sessions that are created with this matchmaking\n configuration. Specify MANUAL when your game manages backfill requests\n manually or does not use the match backfill feature. Specify AUTOMATIC to\n have GameLift create a StartMatchBackfill request whenever a game\n session has one or more open slots. Learn more about manual and automatic backfill in\n Backfill Existing Games with FlexMatch. Automatic backfill is not\n available when FlexMatchMode is set to STANDALONE.
Indicates whether this matchmaking configuration is being used with GameLift hosting or\n as a standalone matchmaking solution.
\n\n STANDALONE - FlexMatch forms matches and returns\n match information, including players and team assignments, in a \n \n MatchmakingSucceeded event.
\n\n WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift queue to\n start a game session for the match.
\nA list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined \n key-value pairs. Tagging\n AWS resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging AWS Resources in the\n AWS General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the AWS General Reference for actual \n tagging limits.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#CreateMatchmakingConfigurationOutput": { "type": "structure", "members": { "Configuration": { "target": "com.amazonaws.gamelift#MatchmakingConfiguration", "traits": { "smithy.api#documentation": "Object that describes the newly created matchmaking configuration.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#CreateMatchmakingRuleSet": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#CreateMatchmakingRuleSetInput" }, "output": { "target": "com.amazonaws.gamelift#CreateMatchmakingRuleSetOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#TaggingFailedException" }, { "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { "smithy.api#documentation": "Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match\n to create, such as the number and size of teams. It also sets the parameters for\n acceptable player matches, such as minimum skill level or character type. A rule set is\n used by a MatchmakingConfiguration.
\nTo create a matchmaking rule set, provide unique rule set name and the rule set body\n in JSON format. Rule sets must be defined in the same Region as the matchmaking\n configuration they are used with.
\nSince matchmaking rule sets cannot be edited, it is a good idea to check the rule\n set syntax using ValidateMatchmakingRuleSet before creating a new rule\n set.
\n\n Learn more\n
\n\n Build a rule\n set\n
\n\n Related actions\n
\n\n CreateMatchmakingConfiguration | \n DescribeMatchmakingConfigurations | \n UpdateMatchmakingConfiguration | \n DeleteMatchmakingConfiguration | \n CreateMatchmakingRuleSet | \n DescribeMatchmakingRuleSets | \n ValidateMatchmakingRuleSet | \n DeleteMatchmakingRuleSet | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#CreateMatchmakingRuleSetInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { "smithy.api#documentation": "A unique identifier for the matchmaking rule set. A matchmaking configuration identifies the rule set it uses by this name\n value. Note that the rule set name is different from the optional name\n field in the rule set body.
A collection of matchmaking rules, formatted as a JSON string. Comments are not\n allowed in JSON, but most elements support a description field.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.gamelift#TagList", "traits": { "smithy.api#documentation": "A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined \n key-value pairs. Tagging\n AWS resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging AWS Resources in the\n AWS General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the AWS General Reference for actual \n tagging limits.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#CreateMatchmakingRuleSetOutput": { "type": "structure", "members": { "RuleSet": { "target": "com.amazonaws.gamelift#MatchmakingRuleSet", "traits": { "smithy.api#documentation": "The newly created matchmaking rule set.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#CreatePlayerSession": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#CreatePlayerSessionInput" }, "output": { "target": "com.amazonaws.gamelift#CreatePlayerSessionOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#GameSessionFullException" }, { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidGameSessionStatusException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#TerminalRoutingStrategyException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Reserves an open player slot in a game session for a player. New player sessions can be\n created in any game session with an open slot that is in ACTIVE status and\n has a player creation policy of ACCEPT_ALL. You can add a group of players\n to a game session with CreatePlayerSessions.
To create a player session, specify a game session ID, player ID, and optionally a set of\n player data.
\nIf successful, a slot is reserved in the game session for the player and a new PlayerSession object is returned with a player session ID. The player\n references the player session ID when sending a connection request to the game session,\n and the game server can use it to validate the player reservation with the GameLift service. Player\n sessions cannot be updated.
\n\n Available in Amazon GameLift Local.\n
\n\n Related actions\n
\n\n CreatePlayerSession |\n CreatePlayerSessions |\n DescribePlayerSessions |\n StartGameSessionPlacement | \n DescribeGameSessionPlacement |\n All APIs by task\n
" } }, "com.amazonaws.gamelift#CreatePlayerSessionInput": { "type": "structure", "members": { "GameSessionId": { "target": "com.amazonaws.gamelift#ArnStringModel", "traits": { "smithy.api#documentation": "A unique identifier for the game session to add a player to.
", "smithy.api#required": {} } }, "PlayerId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for a player. Player IDs are developer-defined.
", "smithy.api#required": {} } }, "PlayerData": { "target": "com.amazonaws.gamelift#PlayerData", "traits": { "smithy.api#documentation": "Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#CreatePlayerSessionOutput": { "type": "structure", "members": { "PlayerSession": { "target": "com.amazonaws.gamelift#PlayerSession", "traits": { "smithy.api#documentation": "Object that describes the newly created player session record.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#CreatePlayerSessions": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#CreatePlayerSessionsInput" }, "output": { "target": "com.amazonaws.gamelift#CreatePlayerSessionsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#GameSessionFullException" }, { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidGameSessionStatusException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#TerminalRoutingStrategyException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Reserves open slots in a game session for a group of players. New player sessions can be\n created in any game session with an open slot that is in ACTIVE status and\n has a player creation policy of ACCEPT_ALL. To add a single player to a\n game session, use CreatePlayerSession.
To create player sessions, specify a game session ID and a list of player IDs. Optionally,\n provide a set of player data for each player ID.
\nIf successful, a slot is reserved in the game session for each player, and new PlayerSession objects are returned with player session IDs. Each player\n references their player session ID when sending a connection request to the game\n session, and the game server can use it to validate the player reservation with the\n GameLift service. Player sessions cannot be updated.
\n\n Available in Amazon GameLift Local.\n
\n\n Related actions\n
\n\n CreatePlayerSession |\n CreatePlayerSessions |\n DescribePlayerSessions |\n StartGameSessionPlacement | \n DescribeGameSessionPlacement |\n All APIs by task\n
" } }, "com.amazonaws.gamelift#CreatePlayerSessionsInput": { "type": "structure", "members": { "GameSessionId": { "target": "com.amazonaws.gamelift#ArnStringModel", "traits": { "smithy.api#documentation": "A unique identifier for the game session to add players to.
", "smithy.api#required": {} } }, "PlayerIds": { "target": "com.amazonaws.gamelift#PlayerIdList", "traits": { "smithy.api#documentation": "List of unique identifiers for the players to be added.
", "smithy.api#required": {} } }, "PlayerDataMap": { "target": "com.amazonaws.gamelift#PlayerDataMap", "traits": { "smithy.api#documentation": "Map of string pairs, each specifying a player ID and a set of developer-defined\n information related to the player. Amazon GameLift does not use this data, so it can be formatted\n as needed for use in the game. Any player data strings for player IDs that are not\n included in the PlayerIds parameter are ignored.
Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#CreatePlayerSessionsOutput": { "type": "structure", "members": { "PlayerSessions": { "target": "com.amazonaws.gamelift#PlayerSessionList", "traits": { "smithy.api#documentation": "A collection of player session objects created for the added players.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#CreateScript": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#CreateScriptInput" }, "output": { "target": "com.amazonaws.gamelift#CreateScriptOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#ConflictException" }, { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#TaggingFailedException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that\n provide configuration settings and optional custom game logic for your game. The script\n is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is\n executed during an active game session.
\nTo create a new script record, specify a script name and provide the script file(s).\n The script files and all dependencies must be zipped into a single file. You can pull\n the zip file from either of these locations:
\nA locally available directory. Use the ZipFile parameter for this\n option.
\nAn Amazon Simple Storage Service (Amazon S3) bucket under your AWS account. Use the\n StorageLocation parameter for this option. You'll need\n to have an Identity Access Management (IAM) role that allows the Amazon GameLift\n service to access your S3 bucket.
\nIf the call is successful, a new script record is created with a unique script ID. If the \n script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket \n and the script record's storage location reflects this location. If the script file is provided\n as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.
\n\n Learn more\n
\n \n\n Amazon GameLift Realtime Servers\n
\n\n Set Up a Role for Amazon GameLift Access\n
\n\n Related actions\n
\n\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#CreateScriptInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "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.\n
" } }, "Version": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "Version information 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.\n
" } }, "StorageLocation": { "target": "com.amazonaws.gamelift#S3Location", "traits": { "smithy.api#documentation": "The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is\n stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the\n \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3\n bucket must be in the same Region where you want to create a new script. By default,\n Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning\n turned on, you can use the ObjectVersion parameter to specify an earlier\n version.
A data object containing your Realtime scripts and dependencies as a zip file. The zip\n file can have one or multiple files. Maximum size of a zip file is 5 MB.
\nWhen using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the \n string \"fileb://\" to indicate that the file data is a binary object. For example: --zip-file fileb://myRealtimeScript.zip.
A list of labels to assign to the new script resource. Tags are developer-defined \n key-value pairs. Tagging\n AWS resources are useful for resource management, access management and cost allocation.\n For more information, see Tagging AWS Resources in the\n AWS General Reference. Once the resource is created, you can\n use TagResource, UntagResource, and \n ListTagsForResource to add, remove, and view tags. The\n maximum tag limit may be lower than stated. See the AWS General Reference for actual \n tagging limits.
" } } } }, "com.amazonaws.gamelift#CreateScriptOutput": { "type": "structure", "members": { "Script": { "target": "com.amazonaws.gamelift#Script", "traits": { "smithy.api#documentation": "The newly created script record with a unique script ID and ARN. The new script's\n storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3\n bucket under your account, the storage location reflects the information that was\n provided in the CreateScript request; (2) If the script file was\n uploaded from a local zip file, the storage location reflects an S3 location controls by\n the Amazon GameLift service.
" } } } }, "com.amazonaws.gamelift#CreateVpcPeeringAuthorization": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#CreateVpcPeeringAuthorizationInput" }, "output": { "target": "com.amazonaws.gamelift#CreateVpcPeeringAuthorizationOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Requests authorization to create or delete a peer connection between the VPC for\n your Amazon GameLift fleet and a virtual private cloud (VPC) in your AWS account. VPC peering enables the game\n servers on your fleet to communicate directly with other AWS resources. Once you've\n received authorization, call CreateVpcPeeringConnection to establish\n the peering connection. For more information, see VPC Peering with Amazon GameLift\n Fleets.
\nYou can peer with VPCs that are owned by any AWS account you have access to,\n including the account that you use to manage your Amazon GameLift fleets. You cannot peer with\n VPCs that are in different Regions.
\nTo request authorization to create a connection, call this operation from the AWS\n account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to\n enable your game servers to retrieve data from a DynamoDB table, use the account that\n manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC\n that you want to peer with, and (2) the ID of the AWS account that you use to manage\n Amazon GameLift. If successful, VPC peering is authorized for the specified VPC.
\nTo request authorization to delete a connection, call this operation from the AWS\n account with the VPC that is peered with your Amazon GameLift fleet. Identify the following\n values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the\n AWS account that you use to manage Amazon GameLift.
\nThe authorization remains valid for 24 hours unless it is canceled by a call to\n DeleteVpcPeeringAuthorization. You must create or delete the\n peering connection while the authorization is valid.
\n\n Related actions\n
\n\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#CreateVpcPeeringAuthorizationInput": { "type": "structure", "members": { "GameLiftAwsAccountId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for the AWS account that you use to manage your GameLift fleet. \n You can find your Account ID in the AWS Management Console under account settings.
", "smithy.api#required": {} } }, "PeerVpcId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The\n VPC must be in the same Region as your fleet. To look up a VPC ID, use the \n VPC Dashboard in the AWS Management Console. \n Learn more about VPC peering in VPC Peering with GameLift Fleets.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#CreateVpcPeeringAuthorizationOutput": { "type": "structure", "members": { "VpcPeeringAuthorization": { "target": "com.amazonaws.gamelift#VpcPeeringAuthorization", "traits": { "smithy.api#documentation": "Details on the requested VPC peering authorization, including expiration.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#CreateVpcPeeringConnection": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#CreateVpcPeeringConnectionInput" }, "output": { "target": "com.amazonaws.gamelift#CreateVpcPeeringConnectionOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Establishes a VPC peering connection between a virtual private cloud (VPC) in an AWS account with the VPC\n for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to\n communicate directly with other AWS resources. You can peer with VPCs in any AWS account\n that you have access to, including the account that you use to manage your Amazon GameLift\n fleets. You cannot peer with VPCs that are in different Regions. For more information,\n see VPC Peering with Amazon GameLift Fleets.
\nBefore calling this operation to establish the peering connection, you first need\n to call CreateVpcPeeringAuthorization and identify the VPC you want to\n peer with. Once the authorization for the specified VPC is issued, you have 24 hours to\n establish the connection. These two operations handle all tasks necessary to peer the\n two VPCs, including acceptance, updating routing tables, etc.
\nTo establish the connection, call this operation from the AWS account that is used\n to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet\n you want to be enable a VPC peering connection for; (2) The AWS account with the VPC\n that you want to peer with; and (3) The ID of the VPC you want to peer with. This\n operation is asynchronous. If successful, a VpcPeeringConnection\n request is created. You can use continuous polling to track the request's status using\n DescribeVpcPeeringConnections, or by monitoring fleet events for\n success or failure using DescribeFleetEvents.
\n\n Related actions\n
\n\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#CreateVpcPeeringConnectionInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "A unique identifier for the fleet. You can use either the fleet ID or ARN value. This tells Amazon GameLift which GameLift\n VPC to peer with.
", "smithy.api#required": {} } }, "PeerVpcAwsAccountId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for the AWS account with the VPC that you want to peer your\n Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account\n settings.
", "smithy.api#required": {} } }, "PeerVpcId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The\n VPC must be in the same Region as your fleet. To look up a VPC ID, use the \n VPC Dashboard in the AWS Management Console. \n Learn more about VPC peering in VPC Peering with GameLift Fleets.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#CreateVpcPeeringConnectionOutput": { "type": "structure", "members": {} }, "com.amazonaws.gamelift#CustomEventData": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.gamelift#DeleteAlias": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DeleteAliasInput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#TaggingFailedException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Deletes an alias. This operation removes all record of the alias. Game clients\n attempting to access a server process using the deleted alias receive an error. To\n delete an alias, specify the alias ID to be deleted.
\n\n Related actions\n
\n\n CreateAlias | \n ListAliases | \n DescribeAlias | \n UpdateAlias | \n DeleteAlias | \n ResolveAlias | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DeleteAliasInput": { "type": "structure", "members": { "AliasId": { "target": "com.amazonaws.gamelift#AliasIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier of the alias that you want to delete. You can use either the alias\n ID or ARN value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DeleteBuild": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DeleteBuildInput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#TaggingFailedException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Deletes a build. This operation permanently deletes the build resource and any uploaded\n build files. Deleting a build does not affect the status of any active fleets using the\n build, but you can no longer create new fleets with the deleted build.
\nTo delete a build, specify the build ID.
\n\n Learn more\n
\n\n \n Upload a Custom Server Build\n
\n\n Related actions\n
\n\n CreateBuild | \n ListBuilds | \n DescribeBuild | \n UpdateBuild | \n DeleteBuild | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DeleteBuildInput": { "type": "structure", "members": { "BuildId": { "target": "com.amazonaws.gamelift#BuildIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the build to delete. You can use either the build ID or ARN value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DeleteFleet": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DeleteFleetInput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidFleetStatusException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#TaggingFailedException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Deletes all resources and information related a fleet. Any current fleet instances,\n including those in remote locations, are shut down. You don't need to call\n DeleteFleetLocations separately.
If the fleet being deleted has a VPC peering connection, you first need to get a\n valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You do not need to explicitly delete\n the VPC peering connection--this is done as part of the delete fleet process.
\nTo delete a fleet, specify the fleet ID to be terminated. During the deletion process\n the fleet status is changed to DELETING. When completed, the status\n switches to TERMINATED and the fleet event FLEET_DELETED is\n sent.
\n Learn more\n
\n\n Setting up GameLift Fleets\n
\n\n Related actions\n
\n\n CreateFleetLocations | \n UpdateFleetAttributes | \n UpdateFleetCapacity | \n UpdateFleetPortSettings | \n UpdateRuntimeConfiguration | \n StopFleetActions | \n StartFleetActions | \n PutScalingPolicy | \n DeleteFleet | \n DeleteFleetLocations | \n DeleteScalingPolicy | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DeleteFleetInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DeleteFleetLocations": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DeleteFleetLocationsInput" }, "output": { "target": "com.amazonaws.gamelift#DeleteFleetLocationsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Removes locations from a multi-location fleet. When deleting a location, all game\n server process and all instances that are still active in the location are shut down.
\nTo delete fleet locations, identify the fleet ID and provide a list of the locations\n to be deleted.
\nIf successful, GameLift sets the location status to DELETING, and begins\n to shut down existing server processes and terminate instances in each location being\n deleted. When completed, the location status changes to TERMINATED.
\n Learn more\n
\n\n Setting up GameLift fleets\n
\n\n Related actions\n
\n\n CreateFleetLocations |\n DescribeFleetLocationAttributes |\n DescribeFleetLocationCapacity | \n DescribeFleetLocationUtilization | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetUtilization | \n UpdateFleetCapacity | \n StopFleetActions | \n DeleteFleetLocations | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DeleteFleetLocationsInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to delete locations for.\n You can use either the fleet ID or ARN value.
", "smithy.api#required": {} } }, "Locations": { "target": "com.amazonaws.gamelift#LocationList", "traits": { "smithy.api#documentation": "The list of fleet locations to delete. Specify locations in the form of an AWS Region code, such as\n us-west-2.
Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DeleteFleetLocationsOutput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet that location attributes are being deleted for.
" } }, "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:.
The remote locations that are being deleted, with each location status set to\n DELETING.
Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DeleteGameServerGroup": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DeleteGameServerGroupInput" }, "output": { "target": "com.amazonaws.gamelift#DeleteGameServerGroupOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "\n This operation is used with the GameLift FleetIQ solution and game server groups.\n
\nTerminates a game server group and permanently deletes the game server group record.\n You have several options for how these resources are impacted when deleting the game\n server group. Depending on the type of delete operation selected, this operation might\n affect these resources:
\nThe game server group
\nThe corresponding Auto Scaling group
\nAll game servers that are currently running in the group
\nTo delete a game server group, identify the game server group to delete and specify\n the type of delete operation to initiate. Game server groups can only be deleted if they\n are in ACTIVE or ERROR status.
If the delete request is successful, a series of operations are kicked off. The game\n server group status is changed to DELETE_SCHEDULED, which prevents new game\n servers from being registered and stops automatic scaling activity. Once all game\n servers in the game server group are deregistered, GameLift FleetIQ can begin deleting resources.\n If any of the delete operations fail, the game server group is placed in\n ERROR status.
GameLift FleetIQ emits delete events to Amazon CloudWatch.
\n\n Learn more\n
\n \n\n Related actions\n
\n\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DeleteGameServerGroupInput": { "type": "structure", "members": { "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
", "smithy.api#required": {} } }, "DeleteOption": { "target": "com.amazonaws.gamelift#GameServerGroupDeleteOption", "traits": { "smithy.api#documentation": "The type of delete to perform. Options include the following:
\n\n SAFE_DELETE – (default) Terminates the game server group and\n EC2 Auto Scaling group only when it has no game servers that are in\n UTILIZED status.
\n FORCE_DELETE – Terminates the game server group, including all\n active game servers regardless of their utilization status, and the EC2 Auto\n Scaling group.
\n RETAIN – Does a safe delete of the game server group but retains\n the EC2 Auto Scaling group as is.
An object that describes the deleted game server group resource, with status updated\n to DELETE_SCHEDULED.
Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement requests that reference the queue will fail.\n To delete a queue, specify the queue name.
\n\n Learn more\n
\n\n \n Using Multi-Region Queues\n
\n\n Related actions\n
\n\n CreateGameSessionQueue | \n DescribeGameSessionQueues | \n UpdateGameSessionQueue | \n DeleteGameSessionQueue | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DeleteGameSessionQueueInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.gamelift#GameSessionQueueNameOrArn", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DeleteGameSessionQueueOutput": { "type": "structure", "members": {} }, "com.amazonaws.gamelift#DeleteMatchmakingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DeleteMatchmakingConfigurationInput" }, "output": { "target": "com.amazonaws.gamelift#DeleteMatchmakingConfigurationOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#TaggingFailedException" }, { "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { "smithy.api#documentation": "Permanently removes a FlexMatch matchmaking configuration. To delete, specify the\n configuration name. A matchmaking configuration cannot be deleted if it is being used in\n any active matchmaking tickets.
\n\n Related actions\n
\n\n CreateMatchmakingConfiguration | \n DescribeMatchmakingConfigurations | \n UpdateMatchmakingConfiguration | \n DeleteMatchmakingConfiguration | \n CreateMatchmakingRuleSet | \n DescribeMatchmakingRuleSets | \n ValidateMatchmakingRuleSet | \n DeleteMatchmakingRuleSet | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DeleteMatchmakingConfigurationInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.gamelift#MatchmakingConfigurationName", "traits": { "smithy.api#documentation": "A unique identifier for the matchmaking configuration. You can use either the configuration name or ARN value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DeleteMatchmakingConfigurationOutput": { "type": "structure", "members": {} }, "com.amazonaws.gamelift#DeleteMatchmakingRuleSet": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DeleteMatchmakingRuleSetInput" }, "output": { "target": "com.amazonaws.gamelift#DeleteMatchmakingRuleSetOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#TaggingFailedException" }, { "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { "smithy.api#documentation": "Deletes an existing matchmaking rule set. To delete the rule set, provide the rule\n set name. Rule sets cannot be deleted if they are currently being used by a matchmaking\n configuration.
\n\n Learn more\n
\n\n Build a rule\n set\n
\n\n Related actions\n
\n\n CreateMatchmakingConfiguration | \n DescribeMatchmakingConfigurations | \n UpdateMatchmakingConfiguration | \n DeleteMatchmakingConfiguration | \n CreateMatchmakingRuleSet | \n DescribeMatchmakingRuleSets | \n ValidateMatchmakingRuleSet | \n DeleteMatchmakingRuleSet | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DeleteMatchmakingRuleSetInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.gamelift#MatchmakingRuleSetName", "traits": { "smithy.api#documentation": "A unique identifier for the matchmaking rule set to be deleted. (Note: The rule set name is different from the optional \"name\"\n field in the rule set body.) You can use either the rule set name or ARN value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DeleteMatchmakingRuleSetOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DeleteScalingPolicy": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DeleteScalingPolicyInput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Deletes a fleet scaling policy. Once deleted, the policy is no longer in\n force and GameLift removes all record of it. To delete a scaling policy, specify both the scaling\n policy name and the fleet ID it is associated with.
\nTo temporarily suspend scaling policies, call StopFleetActions.\n This operation suspends all policies for the fleet.
\n\n Related actions\n
\n\n DescribeFleetCapacity | \n UpdateFleetCapacity | \n DescribeEC2InstanceLimits | \n PutScalingPolicy | \n DescribeScalingPolicies | \n DeleteScalingPolicy | \n StopFleetActions | \n StartFleetActions | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DeleteScalingPolicyInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
", "smithy.api#required": {} } }, "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DeleteScript": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DeleteScriptInput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#TaggingFailedException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Deletes a Realtime script. This operation permanently deletes the script record. If\n script files were uploaded, they are also deleted (files stored in an S3 bucket are not\n deleted).
\nTo delete a script, specify the script ID. Before deleting a script, be sure to\n terminate all fleets that are deployed with the script being deleted. Fleet instances\n periodically check for script updates, and if the script record no longer exists, the\n instance will go into an error state and be unable to host game sessions.
\n\n Learn more\n
\n\n Amazon GameLift Realtime Servers\n
\n\n Related actions\n
\n\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DeleteScriptInput": { "type": "structure", "members": { "ScriptId": { "target": "com.amazonaws.gamelift#ScriptIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the Realtime script to delete. You can use either the script ID or ARN value.
", "smithy.api#required": {} } } } }, "com.amazonaws.gamelift#DeleteVpcPeeringAuthorization": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DeleteVpcPeeringAuthorizationInput" }, "output": { "target": "com.amazonaws.gamelift#DeleteVpcPeeringAuthorizationOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Cancels a pending VPC peering authorization for the specified VPC. If you need to\n delete an existing VPC peering connection, call DeleteVpcPeeringConnection.
\n\n Related actions\n
\n\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DeleteVpcPeeringAuthorizationInput": { "type": "structure", "members": { "GameLiftAwsAccountId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for the AWS account that you use to manage your GameLift fleet. \n You can find your Account ID in the AWS Management Console under account settings.
", "smithy.api#required": {} } }, "PeerVpcId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The\n VPC must be in the same Region as your fleet. To look up a VPC ID, use the \n VPC Dashboard in the AWS Management Console. \n Learn more about VPC peering in VPC Peering with GameLift Fleets.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DeleteVpcPeeringAuthorizationOutput": { "type": "structure", "members": {} }, "com.amazonaws.gamelift#DeleteVpcPeeringConnection": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DeleteVpcPeeringConnectionInput" }, "output": { "target": "com.amazonaws.gamelift#DeleteVpcPeeringConnectionOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Removes a VPC peering connection. To delete the connection, you must have a valid\n authorization for the VPC peering connection that you want to delete. You can check for\n an authorization by calling DescribeVpcPeeringAuthorizations or\n request a new one using CreateVpcPeeringAuthorization.
\nOnce a valid authorization exists, call this operation from the AWS account that is\n used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection\n ID and fleet ID. If successful, the connection is removed.
\n\n Related actions\n
\n\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DeleteVpcPeeringConnectionInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "A unique identifier for the fleet. This fleet specified must match the fleet referenced in the VPC peering\n connection record. You can use either the fleet ID or ARN value.
", "smithy.api#required": {} } }, "VpcPeeringConnectionId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for a VPC peering connection. This value is included in the VpcPeeringConnection object, which can be retrieved by calling DescribeVpcPeeringConnections.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DeleteVpcPeeringConnectionOutput": { "type": "structure", "members": {} }, "com.amazonaws.gamelift#DeregisterGameServer": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DeregisterGameServerInput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "\n This operation is used with the GameLift FleetIQ solution and game server groups.\n
\nRemoves the game server from a game server group. As a result of this operation, the\n deregistered game server can no longer be claimed and will not be returned in a list of\n active game servers.
\nTo deregister a game server, specify the game server group and game server ID. If\n successful, this operation emits a CloudWatch event with termination timestamp and\n reason.
\n\n Learn more\n
\n \n\n Related actions\n
\n\n RegisterGameServer | \n ListGameServers | \n ClaimGameServer | \n DescribeGameServer | \n UpdateGameServer | \n DeregisterGameServer | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DeregisterGameServerInput": { "type": "structure", "members": { "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value.
", "smithy.api#required": {} } }, "GameServerId": { "target": "com.amazonaws.gamelift#GameServerId", "traits": { "smithy.api#documentation": "A custom string that uniquely identifies the game server to deregister.
", "smithy.api#required": {} } } } }, "com.amazonaws.gamelift#DescribeAlias": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeAliasInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeAliasOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves properties for an alias. This operation returns all alias metadata and\n 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\n record is returned.
\n\n Related actions\n
\n\n CreateAlias | \n ListAliases | \n DescribeAlias | \n UpdateAlias | \n DeleteAlias | \n ResolveAlias | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DescribeAliasInput": { "type": "structure", "members": { "AliasId": { "target": "com.amazonaws.gamelift#AliasIdOrArn", "traits": { "smithy.api#documentation": "The unique identifier for the fleet alias that you want to retrieve. You can use\n either the alias ID or ARN value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeAliasOutput": { "type": "structure", "members": { "Alias": { "target": "com.amazonaws.gamelift#Alias", "traits": { "smithy.api#documentation": "The requested alias resource.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeBuild": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeBuildInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeBuildOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves properties for a custom game build. To request a build resource, specify a\n build ID. If successful, an object containing the build properties is returned.
\n\n Learn more\n
\n\n \n Upload a Custom Server Build\n
\n\n Related actions\n
\n\n CreateBuild | \n ListBuilds | \n DescribeBuild | \n UpdateBuild | \n DeleteBuild | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DescribeBuildInput": { "type": "structure", "members": { "BuildId": { "target": "com.amazonaws.gamelift#BuildIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the build to retrieve properties for. You can use either the build ID or ARN value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeBuildOutput": { "type": "structure", "members": { "Build": { "target": "com.amazonaws.gamelift#Build", "traits": { "smithy.api#documentation": "Set of properties describing the requested build.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeEC2InstanceLimits": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeEC2InstanceLimitsInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeEC2InstanceLimitsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "The GameLift service limits and current utilization for an AWS Region or location.\n Instance limits control the number of instances, per instance type, per location, that\n your AWS account can use. Learn more at Amazon EC2 Instance Types. The information\n returned includes the maximum number of instances allowed and your account's current\n usage across all fleets. This information can affect your ability to scale your GameLift\n fleets. You can request a limit increase for your account by using the Service limits page in the GameLift console.
\nInstance limits differ based on whether the instances are deployed in a fleet's home\n Region or in a remote location. For remote locations, limits also differ based on the\n combination of home Region and remote location. All requests must specify an AWS Region\n (either explicitly or as your default settings). To get the limit for a remote location,\n you must also specify the location. For example, the following requests all return\n different results:
\nRequest specifies the Region ap-northeast-1 with no location. The\n result is limits and usage data on all instance types that are deployed in\n us-east-2, by all of the fleets that reside in\n ap-northeast-1.
Request specifies the Region us-east-1 with location\n ca-central-1. The result is limits and usage data on all\n instance types that are deployed in ca-central-1, by all of the\n fleets that reside in us-east-2. These limits do not affect fleets\n in any other Regions that deploy instances to ca-central-1.
Request specifies the Region eu-west-1 with location\n ca-central-1. The result is limits and usage data on all\n instance types that are deployed in ca-central-1, by all of the\n fleets that reside in eu-west-1.
This operation can be used in the following ways:
\nTo get limit and usage data for all instance types that are deployed in an AWS\n Region by fleets that reside in the same Region: Specify the Region only.\n Optionally, specify a single instance type to retrieve information for.
\nTo get limit and usage data for all instance types that are deployed to a\n remote location by fleets that reside in different AWS Region: Provide both the\n AWS Region and the remote location. Optionally, specify a single instance type\n to retrieve information for.
\nIf successful, an EC2InstanceLimits object is returned with limits and\n usage data for each requested instance type.
\n Learn more\n
\n\n Setting up GameLift fleets\n
\n \n\n Related actions\n
\n\n CreateFleet | \n UpdateFleetCapacity | \n PutScalingPolicy | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetLocationAttributes | \n UpdateFleetAttributes | \n StopFleetActions | \n DeleteFleet | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DescribeEC2InstanceLimitsInput": { "type": "structure", "members": { "EC2InstanceType": { "target": "com.amazonaws.gamelift#EC2InstanceType", "traits": { "smithy.api#documentation": "Name of an EC2 instance type that is supported in GameLift. A fleet instance type\n determines the computing resources of each instance in the fleet, including CPU, memory,\n storage, and networking capacity. Do not specify a value for this parameter to retrieve\n limits for all instance types.
" } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "The name of a remote location to request instance limits for, in the form of an AWS\n Region code such as us-west-2.
Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeEC2InstanceLimitsOutput": { "type": "structure", "members": { "EC2InstanceLimits": { "target": "com.amazonaws.gamelift#EC2InstanceLimitList", "traits": { "smithy.api#documentation": "The maximum number of instances for the specified instance\n type.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeFleetAttributes": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeFleetAttributesInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeFleetAttributesOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves core fleet-wide properties, including the computing hardware and deployment\n configuration for all instances in the fleet.
\nThis operation can be used in the following ways:
\nTo get attributes for one or more specific fleets, provide a list of fleet IDs\n or fleet ARNs.
\nTo get attributes for all fleets, do not provide a fleet identifier.
\nWhen requesting attributes for multiple fleets, use the pagination parameters to\n retrieve results as a set of sequential pages.
\nIf successful, a FleetAttributes object is returned for each fleet\n requested, unless the fleet identifier is not found.
Some API operations limit the number of fleet IDs that allowed in one request. If a\n request exceeds this limit, the request fails and the error message contains the\n maximum allowed number.
\n\n Learn more\n
\n\n Setting up GameLift fleets\n
\n\n Related actions\n
\n\n ListFleets | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetEvents | \n DescribeFleetLocationAttributes | \n DescribeFleetPortSettings | \n DescribeFleetUtilization | \n DescribeRuntimeConfiguration | \n DescribeScalingPolicies | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#DescribeFleetAttributesInput": { "type": "structure", "members": { "FleetIds": { "target": "com.amazonaws.gamelift#FleetIdOrArnList", "traits": { "smithy.api#documentation": "A list of unique fleet identifiers to retrieve attributes for. You can use either the\n fleet ID or ARN value. To retrieve attributes for all current fleets, do not include\n this parameter.
" } }, "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#documentation": "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\n IDs.
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet\n IDs.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeFleetAttributesOutput": { "type": "structure", "members": { "FleetAttributes": { "target": "com.amazonaws.gamelift#FleetAttributesList", "traits": { "smithy.api#documentation": "A collection of objects containing attribute metadata for each requested fleet ID.\n Attribute objects are returned only for fleets that currently exist.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeFleetCapacity": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeFleetCapacityInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeFleetCapacityOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves the resource capacity settings for one or more fleets. The data returned\n includes the current fleet capacity (number of EC2 instances), and settings that can\n control how capacity scaling. For fleets with remote locations, this operation retrieves\n data for the fleet's home Region only. See DescribeFleetLocationCapacity to get capacity settings for a fleet's remote locations.
\nThis operation can be used in the following ways:
\nTo get capacity data for one or more specific fleets, provide a list of fleet\n IDs or fleet ARNs.
\nTo get capacity data for all fleets, do not provide a fleet identifier.
\nWhen requesting multiple fleets, use the pagination parameters to retrieve results as\n a set of sequential pages.
\nIf successful, a FleetCapacity object is returned for each requested\n fleet ID. Each FleetCapacity object includes a Location property, which is\n set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects\n are returned only for fleets that currently exist.
Some API operations may limit the number of fleet IDs that are allowed in one\n request. If a request exceeds this limit, the request fails and the error message\n includes the maximum allowed.
\n\n Learn more\n
\n\n Setting up GameLift fleets\n
\n\n GameLift metrics for fleets\n
\n\n Related actions\n
\n\n ListFleets | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetEvents | \n DescribeFleetLocationAttributes | \n DescribeFleetPortSettings | \n DescribeFleetUtilization | \n DescribeRuntimeConfiguration | \n DescribeScalingPolicies | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#DescribeFleetCapacityInput": { "type": "structure", "members": { "FleetIds": { "target": "com.amazonaws.gamelift#FleetIdOrArnList", "traits": { "smithy.api#documentation": "A unique identifier for the fleet(s) to retrieve capacity information for. You can use either the fleet ID or ARN\n value. Leave this parameter empty to retrieve capacity information for all\n fleets.
" } }, "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#documentation": "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\n IDs.
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet\n IDs.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeFleetCapacityOutput": { "type": "structure", "members": { "FleetCapacity": { "target": "com.amazonaws.gamelift#FleetCapacityList", "traits": { "smithy.api#documentation": "A collection of objects that contains capacity information for each requested fleet\n ID. Capacity objects are returned only for fleets that currently exist.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeFleetEvents": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeFleetEventsInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeFleetEventsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves entries from a fleet's event log. Fleet events are initiated by changes in\n status, such as during fleet creation and termination, changes in capacity, etc. If a\n fleet has multiple locations, events are also initiated by changes to status and\n capacity in remote locations.
\nYou can specify a time range to limit the result set. Use the pagination parameters to\n retrieve results as a set of sequential pages.
\nIf successful, a collection of event log entries matching the request are\n returned.
\n\n Learn more\n
\n\n Setting up GameLift fleets\n
\n\n Related actions\n
\n\n ListFleets | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetEvents | \n DescribeFleetLocationAttributes | \n DescribeFleetPortSettings | \n DescribeFleetUtilization | \n DescribeRuntimeConfiguration | \n DescribeScalingPolicies | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#DescribeFleetEventsInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to get event logs for. You can use either the fleet ID or ARN value.
", "smithy.api#required": {} } }, "StartTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { "smithy.api#documentation": "The earliest date to retrieve event logs for. If no start time is specified, this call\n returns entries starting from when the fleet was created to the specified end time.\n Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").
" } }, "EndTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { "smithy.api#documentation": "The most recent date to retrieve event logs for. If no end time is specified, this\n call returns entries from the specified start time up to the present. Format is a number\n expressed in Unix time as milliseconds (ex: \"1469498468.057\").
" } }, "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeFleetEventsOutput": { "type": "structure", "members": { "Events": { "target": "com.amazonaws.gamelift#EventList", "traits": { "smithy.api#documentation": "A collection of objects containing event log entries for the specified\n fleet.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeFleetLocationAttributes": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeFleetLocationAttributesInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeFleetLocationAttributesOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves information on a fleet's remote locations, including life-cycle status and\n any suspended fleet activity.
\nThis operation can be used in the following ways:
\nTo get data for specific locations, provide a fleet identifier and a list of\n locations. Location data is returned in the order that it is requested.
\nTo get data for all locations, provide a fleet identifier only. Location data\n is returned in no particular order.
\nWhen requesting attributes for multiple locations, use the pagination parameters to\n retrieve results as a set of sequential pages.
\nIf successful, a LocationAttributes object is returned for each requested\n location. If the fleet does not have a requested location, no information is returned.\n This operation does not return the home Region. To get information on a fleet's home\n Region, call DescribeFleetAttributes.
\n Learn more\n
\n\n Setting up GameLift fleets\n
\n\n Related actions\n
\n\n CreateFleetLocations |\n DescribeFleetLocationAttributes |\n DescribeFleetLocationCapacity | \n DescribeFleetLocationUtilization | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetUtilization | \n UpdateFleetCapacity | \n StopFleetActions | \n DeleteFleetLocations | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#DescribeFleetLocationAttributesInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to retrieve remote locations for. You can use either the fleet ID or ARN\n value.
", "smithy.api#required": {} } }, "Locations": { "target": "com.amazonaws.gamelift#LocationList", "traits": { "smithy.api#documentation": "A list of fleet locations to retrieve information for. Specify locations in the form of an AWS Region code, such as\n us-west-2.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This limit is not currently enforced.
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.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeFleetLocationAttributesOutput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet that location attributes were requested for.
" } }, "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:.
Location-specific information on the requested fleet's remote locations.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeFleetLocationCapacity": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeFleetLocationCapacityInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeFleetLocationCapacityOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves the resource capacity settings for a fleet location. The data returned\n includes the current capacity (number of EC2 instances) and some scaling settings for\n the requested fleet location. Use this operation to retrieve capacity information for a\n fleet's remote location or home Region (you can also retrieve home Region capacity by\n calling DescribeFleetCapacity).
To retrieve capacity data, identify a fleet and location.
\nIf successful, a FleetCapacity object is returned for the requested fleet\n location.
\n Learn more\n
\n\n Setting up GameLift fleets\n
\n\n GameLift metrics for fleets\n
\n\n Related actions\n
\n\n CreateFleetLocations |\n DescribeFleetLocationAttributes |\n DescribeFleetLocationCapacity | \n DescribeFleetLocationUtilization | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetUtilization | \n UpdateFleetCapacity | \n StopFleetActions | \n DeleteFleetLocations | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DescribeFleetLocationCapacityInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to request location capacity for.\n You can use either the fleet ID or ARN value.
", "smithy.api#required": {} } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "The fleet location to retrieve capacity information for. Specify a location in the form of an AWS Region code, such as\n us-west-2.
Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeFleetLocationCapacityOutput": { "type": "structure", "members": { "FleetCapacity": { "target": "com.amazonaws.gamelift#FleetCapacity", "traits": { "smithy.api#documentation": "Resource capacity information for the requested fleet location. Capacity objects are\n returned only for fleets and locations that currently exist.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeFleetLocationUtilization": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeFleetLocationUtilizationInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeFleetLocationUtilizationOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves current usage data for a fleet location. Utilization data provides a\n snapshot of current game hosting activity at the requested location. Use this operation\n to retrieve utilization information for a fleet's remote location or home Region (you\n can also retrieve home Region utilization by calling\n DescribeFleetUtilization).
To retrieve utilization data, identify a fleet and location.
\nIf successful, a FleetUtilization object is returned for the requested\n fleet location.
\n Learn more\n
\n\n Setting up GameLift fleets\n
\n\n GameLift metrics for fleets\n
\n\n Related actions\n
\n\n CreateFleetLocations |\n DescribeFleetLocationAttributes |\n DescribeFleetLocationCapacity | \n DescribeFleetLocationUtilization | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetUtilization | \n UpdateFleetCapacity | \n StopFleetActions | \n DeleteFleetLocations | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DescribeFleetLocationUtilizationInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to request location utilization for.\n You can use either the fleet ID or ARN value.
", "smithy.api#required": {} } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "The fleet location to retrieve utilization information for. Specify a location in the form of an AWS Region code, such as\n us-west-2.
Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeFleetLocationUtilizationOutput": { "type": "structure", "members": { "FleetUtilization": { "target": "com.amazonaws.gamelift#FleetUtilization", "traits": { "smithy.api#documentation": "Utilization information for the requested fleet location. Utilization objects are\n returned only for fleets and locations that currently exist.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeFleetPortSettings": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeFleetPortSettingsInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeFleetPortSettingsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves a fleet's inbound connection permissions. Connection permissions specify the\n range of IP addresses and port settings that incoming traffic can use to access server\n processes in the fleet. Game sessions that are running on instances in the fleet must\n use connections that fall in this range.
\nThis operation can be used in the following ways:
\nTo retrieve the inbound connection permissions for a fleet, identify the\n fleet's unique identifier.
\nTo check the status of recent updates to a fleet remote location, specify\n the fleet ID and a location. Port setting updates can take time to\n propagate across all locations.
\nIf successful, a set of IpPermission objects is returned for the\n requested fleet ID. When a location is specified, a pending status is included. If the\n requested fleet has been deleted, the result set is empty.
\n\n Learn more\n
\n\n Setting up GameLift fleets\n
\n\n Related actions\n
\n\n ListFleets | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetEvents | \n DescribeFleetLocationAttributes | \n DescribeFleetPortSettings | \n DescribeFleetUtilization | \n DescribeRuntimeConfiguration | \n DescribeScalingPolicies | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DescribeFleetPortSettingsInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to retrieve port settings for. You can use either the fleet ID or ARN\n value.
", "smithy.api#required": {} } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "A remote location to check for status of port setting updates. Use the AWS Region code\n format, such as us-west-2.
Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeFleetPortSettingsOutput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "A unique identifier for the fleet that was requested.
" } }, "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:.
The port settings for the requested fleet ID.
" } }, "UpdateStatus": { "target": "com.amazonaws.gamelift#LocationUpdateStatus", "traits": { "smithy.api#documentation": "The current status of updates to the fleet's port settings in the requested fleet\n location. A status of PENDING_UPDATE indicates that an update was requested\n for the fleet but has not yet been completed for the location.
The requested fleet location, expressed as an AWS Region code, \n such as us-west-2.
Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeFleetUtilization": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeFleetUtilizationInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeFleetUtilizationOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves utilization statistics for one or more fleets. Utilization data provides a\n snapshot of how the fleet's hosting resources are currently being used. For fleets with\n remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization to get utilization statistics for a\n fleet's remote locations.
\nThis operation can be used in the following ways:
\nTo get utilization data for one or more specific fleets, provide a list of\n fleet IDs or fleet ARNs.
\nTo get utilization data for all fleets, do not provide a fleet identifier.\n
\nWhen requesting multiple fleets, use the pagination parameters to retrieve results as\n a set of sequential pages.
\nIf successful, a FleetUtilization object is returned for each\n requested fleet ID, unless the fleet identifier is not found. Each fleet utilization\n object includes a Location property, which is set to the fleet's home\n Region.
Some API operations may limit the number of fleet IDs allowed in one request. If a\n request exceeds this limit, the request fails and the error message includes the\n maximum allowed.
\n\n Learn more\n
\n\n Setting up GameLift Fleets\n
\n\n GameLift Metrics for Fleets\n
\n\n Related actions\n
\n\n ListFleets | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetEvents | \n DescribeFleetLocationAttributes | \n DescribeFleetPortSettings | \n DescribeFleetUtilization | \n DescribeRuntimeConfiguration | \n DescribeScalingPolicies | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#DescribeFleetUtilizationInput": { "type": "structure", "members": { "FleetIds": { "target": "com.amazonaws.gamelift#FleetIdOrArnList", "traits": { "smithy.api#documentation": "A unique identifier for the fleet(s) to retrieve utilization data for. You can use either the fleet ID or ARN\n value. To retrieve attributes for all current fleets, do not include this parameter.
" } }, "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#documentation": "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\n IDs.
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet\n IDs.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeFleetUtilizationOutput": { "type": "structure", "members": { "FleetUtilization": { "target": "com.amazonaws.gamelift#FleetUtilizationList", "traits": { "smithy.api#documentation": "A collection of objects containing utilization information for each requested fleet\n ID. Utilization objects are returned only for fleets that currently exist.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeGameServer": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeGameServerInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeGameServerOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "\n This operation is used with the GameLift FleetIQ solution and game server groups.\n
\nRetrieves information for a registered game server. Information includes game server\n status, health check info, and the instance that the game server is running on.
\nTo retrieve game server information, specify the game server ID. If successful, the\n requested game server object is returned.
\n\n Learn more\n
\n \n\n Related actions\n
\n\n RegisterGameServer | \n ListGameServers | \n ClaimGameServer | \n DescribeGameServer | \n UpdateGameServer | \n DeregisterGameServer | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DescribeGameServerGroup": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeGameServerGroupInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeGameServerGroupOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "\n This operation is used with the GameLift FleetIQ solution and game server groups.\n
\nRetrieves information on a game server group. This operation returns only properties\n related to GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group,\n such as launch template, auto scaling policies, and maximum/minimum group size, access\n the Auto Scaling group directly.
\nTo get attributes for a game server group, provide a group name or ARN value. If\n successful, a GameServerGroup object is returned.
\n\n Learn more\n
\n \n\n Related actions\n
\n\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DescribeGameServerGroupInput": { "type": "structure", "members": { "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
", "smithy.api#required": {} } } } }, "com.amazonaws.gamelift#DescribeGameServerGroupOutput": { "type": "structure", "members": { "GameServerGroup": { "target": "com.amazonaws.gamelift#GameServerGroup", "traits": { "smithy.api#documentation": "An object with the property settings for the requested game server group resource.
" } } } }, "com.amazonaws.gamelift#DescribeGameServerInput": { "type": "structure", "members": { "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value.
", "smithy.api#required": {} } }, "GameServerId": { "target": "com.amazonaws.gamelift#GameServerId", "traits": { "smithy.api#documentation": "A custom string that uniquely identifies the game server information to be retrieved.
", "smithy.api#required": {} } } } }, "com.amazonaws.gamelift#DescribeGameServerInstances": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeGameServerInstancesInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeGameServerInstancesOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "\n This operation is used with the GameLift FleetIQ solution and game server groups.\n
\nRetrieves status information about the Amazon EC2 instances associated with a GameLift FleetIQ\n game server group. Use this operation to detect when instances are active or not\n available to host new game servers. If you are looking for instance configuration\n information, call DescribeGameServerGroup or access the corresponding\n Auto Scaling group properties.
\nTo request status for all instances in the game server group, provide a game server\n group ID only. To request status for specific instances, provide the game server group\n ID and one or more instance IDs. Use the pagination parameters to retrieve results in\n sequential segments. If successful, a collection of GameServerInstance\n objects is returned.\n \n
This operation is not designed to be called with every game server claim request; this\n practice can cause you to exceed your API limit, which results in errors. Instead, as a\n best practice, cache the results and refresh your cache no more than once every 10\n seconds.
\n\n Learn more\n
\n \n\n Related actions\n
\n\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#DescribeGameServerInstancesInput": { "type": "structure", "members": { "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
", "smithy.api#required": {} } }, "InstanceIds": { "target": "com.amazonaws.gamelift#GameServerInstanceIds", "traits": { "smithy.api#documentation": "The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a\n 17-character format, for example: i-1234567890abcdef0. To retrieve all\n instances in the game server group, leave this parameter empty.
\n The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.\n
\n 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.\n
" } } } }, "com.amazonaws.gamelift#DescribeGameServerInstancesOutput": { "type": "structure", "members": { "GameServerInstances": { "target": "com.amazonaws.gamelift#GameServerInstances", "traits": { "smithy.api#documentation": "\n The collection of requested game server instances. \n
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "\n A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.\n
" } } } }, "com.amazonaws.gamelift#DescribeGameServerOutput": { "type": "structure", "members": { "GameServer": { "target": "com.amazonaws.gamelift#GameServer", "traits": { "smithy.api#documentation": "Object that describes the requested game server.
" } } } }, "com.amazonaws.gamelift#DescribeGameSessionDetails": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeGameSessionDetailsInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeGameSessionDetailsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#TerminalRoutingStrategyException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves additional game session properties, including the game session protection\n policy in force, a set of one or more game sessions in a specific fleet location. You\n can optionally filter the results by current game session status. Alternatively, use\n SearchGameSessions to request a set of active game sessions that\n are filtered by certain criteria. To retrieve all game session properties, use DescribeGameSessions.
\nThis operation can be used in the following ways:
\nTo retrieve details for all game sessions that are currently running on all\n locations in a fleet, provide a fleet or alias ID, with an optional status\n filter. This approach returns details from the fleet's home Region and all\n remote locations.
\nTo retrieve details for all game sessions that are currently running on a\n specific fleet location, provide a fleet or alias ID and a location name, with\n optional status filter. The location can be the fleet's home Region or any\n remote location.
\nTo retrieve details for a specific game session, provide the game session ID.\n This approach looks for the game session ID in all fleets that reside in the AWS\n Region defined in the request.
\nUse the pagination parameters to retrieve results as a set of sequential pages.
\nIf successful, a GameSessionDetail object is returned for each game\n session that matches the request.
\n Learn more\n
\n\n Find a game session\n
\n\n Related actions\n
\n\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#DescribeGameSessionDetailsInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet\n ID or ARN value.
" } }, "GameSessionId": { "target": "com.amazonaws.gamelift#ArnStringModel", "traits": { "smithy.api#documentation": "A unique identifier for the game session to retrieve.
" } }, "AliasId": { "target": "com.amazonaws.gamelift#AliasIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either\n the alias ID or ARN value.
" } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "A fleet location to get game sessions for. You can specify a fleet's home Region or a\n remote location. Use the AWS Region code format, such as us-west-2.
Game session status to filter results on. Possible game session statuses include\n ACTIVE, TERMINATED, ACTIVATING and\n TERMINATING (the last two are transitory).
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeGameSessionDetailsOutput": { "type": "structure", "members": { "GameSessionDetails": { "target": "com.amazonaws.gamelift#GameSessionDetailList", "traits": { "smithy.api#documentation": "A collection of properties for each game session that matches the request.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeGameSessionPlacement": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeGameSessionPlacementInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeGameSessionPlacementOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves information, including current status, about a game session placement request.
\nTo get game session placement details, specify the placement ID.
\nIf successful, a GameSessionPlacement object is returned.
\n\n Related actions\n
\n\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DescribeGameSessionPlacementInput": { "type": "structure", "members": { "PlacementId": { "target": "com.amazonaws.gamelift#IdStringModel", "traits": { "smithy.api#documentation": "A unique identifier for a game session placement to retrieve.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeGameSessionPlacementOutput": { "type": "structure", "members": { "GameSessionPlacement": { "target": "com.amazonaws.gamelift#GameSessionPlacement", "traits": { "smithy.api#documentation": "Object that describes the requested game session placement.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeGameSessionQueues": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeGameSessionQueuesInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeGameSessionQueuesOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves the properties for one or more game session queues. When requesting\n multiple queues, use the pagination parameters to retrieve results as a set of\n sequential pages. If successful, a GameSessionQueue object is returned\n for each requested queue. When specifying a list of queues, objects are returned only\n for queues that currently exist in the Region.
\n\n Learn more\n
\n\n \n View Your Queues\n
\n\n Related actions\n
\n\n CreateGameSessionQueue | \n DescribeGameSessionQueues | \n UpdateGameSessionQueue | \n DeleteGameSessionQueue | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#DescribeGameSessionQueuesInput": { "type": "structure", "members": { "Names": { "target": "com.amazonaws.gamelift#GameSessionQueueNameOrArnList", "traits": { "smithy.api#documentation": "A list of queue names to retrieve information for. You can use either the queue ID or\n ARN value. To request settings for all queues, leave this parameter empty.
" } }, "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#documentation": "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.
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.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeGameSessionQueuesOutput": { "type": "structure", "members": { "GameSessionQueues": { "target": "com.amazonaws.gamelift#GameSessionQueueList", "traits": { "smithy.api#documentation": "A collection of objects that describe the requested game session queues.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeGameSessions": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeGameSessionsInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeGameSessionsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#TerminalRoutingStrategyException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves a set of one or more game sessions in a specific fleet location. You can\n optionally filter the results by current game session status. Alternatively, use SearchGameSessions to request a set of active game sessions that are\n filtered by certain criteria. To retrieve the protection policy for game sessions, use\n DescribeGameSessionDetails.
\nThis operation can be used in the following ways:
\nTo retrieve all game sessions that are currently running on all locations in a\n fleet, provide a fleet or alias ID, with an optional status filter. This\n approach returns all game sessions in the fleet's home Region and all remote\n locations.
\nTo retrieve all game sessions that are currently running on a specific fleet\n location, provide a fleet or alias ID and a location name, with optional status\n filter. The location can be the fleet's home Region or any remote\n location.
\nTo retrieve a specific game session, provide the game session ID. This\n approach looks for the game session ID in all fleets that reside in the AWS\n Region defined in the request.
\nUse the pagination parameters to retrieve results as a set of sequential pages.
\nIf successful, a GameSession object is returned for each game session\n that matches the request.
\n Available in GameLift Local.\n
\n\n Learn more\n
\n\n Find a game session\n
\n\n Related actions\n
\n\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#DescribeGameSessionsInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value.
" } }, "GameSessionId": { "target": "com.amazonaws.gamelift#ArnStringModel", "traits": { "smithy.api#documentation": "A unique identifier for the game session to retrieve.
" } }, "AliasId": { "target": "com.amazonaws.gamelift#AliasIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the\n alias ID or ARN value.
" } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "A fleet location to get game session details for. You can specify a fleet's home\n Region or a remote location. Use the AWS Region code format, such as\n us-west-2.
Game session status to filter results on. You can filter on the following states:\n ACTIVE, TERMINATED, ACTIVATING, and\n TERMINATING. The last two are transitory and used for only very brief\n periods of time.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeGameSessionsOutput": { "type": "structure", "members": { "GameSessions": { "target": "com.amazonaws.gamelift#GameSessionList", "traits": { "smithy.api#documentation": "A collection of properties for each game session that matches the request.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeInstances": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeInstancesInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeInstancesOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves information about a fleet's instances, including instance IDs, connection\n data, and status.
\nThis operation can be used in the following ways:
\nTo get information on all instances that are deployed to a fleet's home\n Region, provide the fleet ID.
\nTo get information on all instances that are deployed to a fleet's remote\n location, provide the fleet ID and location name.
\nTo get information on a specific instance in a fleet, provide the fleet ID and\n instance ID.
\nUse the pagination parameters to retrieve results as a set of sequential pages.
\nIf successful, an Instance object is returned for each requested\n instance. Instances are not returned in any particular order.
\n Learn more\n
\n\n Remotely Access Fleet Instances\n
\n\n Debug Fleet Issues\n
\n \n\n Related actions\n
\n\n DescribeInstances | \n GetInstanceAccess | \n DescribeEC2InstanceLimits | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#DescribeInstancesInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN\n value.
", "smithy.api#required": {} } }, "InstanceId": { "target": "com.amazonaws.gamelift#InstanceId", "traits": { "smithy.api#documentation": "A unique identifier for an instance to retrieve. Specify an instance ID or leave\n blank to retrieve all instances in the fleet.
" } }, "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "The name of a location to retrieve instance information for, in the form of an AWS\n Region code such as us-west-2.
Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeInstancesOutput": { "type": "structure", "members": { "Instances": { "target": "com.amazonaws.gamelift#InstanceList", "traits": { "smithy.api#documentation": "A collection of objects containing properties for each instance returned.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeMatchmaking": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeMatchmakingInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeMatchmakingOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { "smithy.api#documentation": "Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket\n information, including--after a successful match is made--connection information for the\n resulting new game session.
\nTo request matchmaking tickets, provide a list of up to 10 ticket IDs. If the\n request is successful, a ticket object is returned for each requested ID that currently\n exists.
\nThis operation is not designed to be continually called to track matchmaking ticket\n status. This practice can cause you to exceed your API limit, which results in errors.\n Instead, as a best practice, set up an Amazon Simple Notification Service (SNS) to receive notifications, and provide\n the topic ARN in the matchmaking configuration. Continuously poling ticket status with\n DescribeMatchmaking should only be used for games in development\n with low matchmaking usage.
\n \n\n Learn more\n
\n\n \n Add FlexMatch to a game client\n
\n\n \n Set Up FlexMatch event notification\n
\n\n Related actions\n
\n\n StartMatchmaking | \n DescribeMatchmaking | \n StopMatchmaking | \n AcceptMatch | \n StartMatchBackfill | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DescribeMatchmakingConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeMatchmakingConfigurationsInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeMatchmakingConfigurationsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { "smithy.api#documentation": "Retrieves the details of FlexMatch matchmaking configurations.
\nThis operation offers the following options: (1) retrieve all matchmaking\n configurations, (2) retrieve configurations for a specified list, or (3) retrieve all\n configurations that use a specified rule set name. When requesting multiple items, use\n the pagination parameters to retrieve results as a set of sequential pages.
\nIf successful, a configuration is returned for each requested name. When specifying a\n list of names, only configurations that currently exist are returned.
\n\n Learn more\n
\n\n Setting up FlexMatch\n matchmakers\n
\n\n Related actions\n
\n\n CreateMatchmakingConfiguration | \n DescribeMatchmakingConfigurations | \n UpdateMatchmakingConfiguration | \n DeleteMatchmakingConfiguration | \n CreateMatchmakingRuleSet | \n DescribeMatchmakingRuleSets | \n ValidateMatchmakingRuleSet | \n DeleteMatchmakingRuleSet | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#DescribeMatchmakingConfigurationsInput": { "type": "structure", "members": { "Names": { "target": "com.amazonaws.gamelift#MatchmakingConfigurationNameList", "traits": { "smithy.api#documentation": "A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration name or ARN value. To\n request all existing configurations, leave this parameter empty.
" } }, "RuleSetName": { "target": "com.amazonaws.gamelift#MatchmakingRuleSetName", "traits": { "smithy.api#documentation": "A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use this parameter to\n retrieve all matchmaking configurations that use this rule set.
" } }, "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#documentation": "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.
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.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeMatchmakingConfigurationsOutput": { "type": "structure", "members": { "Configurations": { "target": "com.amazonaws.gamelift#MatchmakingConfigurationList", "traits": { "smithy.api#documentation": "A collection of requested matchmaking configurations.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeMatchmakingInput": { "type": "structure", "members": { "TicketIds": { "target": "com.amazonaws.gamelift#MatchmakingIdList", "traits": { "smithy.api#documentation": "A unique identifier for a matchmaking ticket. You can include up to 10 ID values.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeMatchmakingOutput": { "type": "structure", "members": { "TicketList": { "target": "com.amazonaws.gamelift#MatchmakingTicketList", "traits": { "smithy.api#documentation": "A collection of existing matchmaking ticket objects matching the request.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeMatchmakingRuleSets": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeMatchmakingRuleSetsInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeMatchmakingRuleSetsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { "smithy.api#documentation": "Retrieves the details for FlexMatch matchmaking rule sets. You can request all\n existing rule sets for the Region, or provide a list of one or more rule set names. When\n requesting multiple items, use the pagination parameters to retrieve results as a set of\n sequential pages. If successful, a rule set is returned for each requested name.
\n\n Learn more\n
\n\n Build a rule\n set\n
\n\n Related actions\n
\n\n CreateMatchmakingConfiguration | \n DescribeMatchmakingConfigurations | \n UpdateMatchmakingConfiguration | \n DeleteMatchmakingConfiguration | \n CreateMatchmakingRuleSet | \n DescribeMatchmakingRuleSets | \n ValidateMatchmakingRuleSet | \n DeleteMatchmakingRuleSet | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#DescribeMatchmakingRuleSetsInput": { "type": "structure", "members": { "Names": { "target": "com.amazonaws.gamelift#MatchmakingRuleSetNameList", "traits": { "smithy.api#documentation": "A list of one or more matchmaking rule set names to retrieve details for. (Note: The\n rule set name is different from the optional \"name\" field in the rule set body.) You can\n use either the rule set name or ARN value.
" } }, "Limit": { "target": "com.amazonaws.gamelift#RuleSetLimit", "traits": { "smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeMatchmakingRuleSetsOutput": { "type": "structure", "members": { "RuleSets": { "target": "com.amazonaws.gamelift#MatchmakingRuleSetList", "traits": { "smithy.api#documentation": "A collection of requested matchmaking rule set objects.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribePlayerSessions": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribePlayerSessionsInput" }, "output": { "target": "com.amazonaws.gamelift#DescribePlayerSessionsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves properties for one or more player sessions.
\nThis action can be used in the following ways:
\nTo retrieve a specific player session, provide the player session ID\n only.
\nTo retrieve all player sessions in a game session, provide the game session ID\n only.
\nTo retrieve all player sessions for a specific player, provide a player ID\n only.
\nTo request player sessions, specify either a player session ID, game session ID, or player\n ID. You can filter this request by player session status. Use the pagination parameters\n to retrieve results as a set of sequential pages.
\nIf successful, a PlayerSession object is returned for each session that\n matches the request.
\n Available in Amazon GameLift Local.\n
\n\n Related actions\n
\n\n CreatePlayerSession |\n CreatePlayerSessions |\n DescribePlayerSessions |\n StartGameSessionPlacement | \n DescribeGameSessionPlacement |\n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#DescribePlayerSessionsInput": { "type": "structure", "members": { "GameSessionId": { "target": "com.amazonaws.gamelift#ArnStringModel", "traits": { "smithy.api#documentation": "A unique identifier for the game session to retrieve player sessions for.
" } }, "PlayerId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for a player to retrieve player sessions for.
" } }, "PlayerSessionId": { "target": "com.amazonaws.gamelift#PlayerSessionId", "traits": { "smithy.api#documentation": "A unique identifier for a player session to retrieve.
" } }, "PlayerSessionStatusFilter": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "Player session status to filter results on.
\nPossible player session statuses include the following:
\n\n RESERVED -- The player session request has been\n received, but the player has not yet connected to the server process and/or been\n validated.
\n\n ACTIVE -- The player has been validated by the\n server process and is currently connected.
\n\n COMPLETED -- The player connection has been\n dropped.
\n\n TIMEDOUT -- A player session request was\n received, but the player did not connect and/or was not validated within the\n timeout limit (60 seconds).
\nThe 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.
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribePlayerSessionsOutput": { "type": "structure", "members": { "PlayerSessions": { "target": "com.amazonaws.gamelift#PlayerSessionList", "traits": { "smithy.api#documentation": "A collection of objects containing properties for each player session that matches\n the request.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeRuntimeConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeRuntimeConfigurationInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeRuntimeConfigurationOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves a fleet's runtime configuration settings. The runtime configuration tells\n GameLift which server processes to run (and how) on each instance in the fleet.
\nTo get the runtime configuration that is currently in forces for a fleet, provide the\n fleet ID.
\nIf successful, a RuntimeConfiguration object is returned for the\n requested fleet. If the requested fleet has been deleted, the result set is\n empty.
\n\n Learn more\n
\n\n Setting up GameLift fleets\n
\n\n Running multiple\n processes on a fleet\n
\n\n Related actions\n
\n\n ListFleets | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetCapacity | \n DescribeFleetEvents | \n DescribeFleetLocationAttributes | \n DescribeFleetPortSettings | \n DescribeFleetUtilization | \n DescribeRuntimeConfiguration | \n DescribeScalingPolicies | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DescribeRuntimeConfigurationInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to get the runtime configuration for. You can use either the fleet ID or ARN\n value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeRuntimeConfigurationOutput": { "type": "structure", "members": { "RuntimeConfiguration": { "target": "com.amazonaws.gamelift#RuntimeConfiguration", "traits": { "smithy.api#documentation": "Instructions that describe how server processes should be launched and maintained on\n each instance in the fleet.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeScalingPolicies": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeScalingPoliciesInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeScalingPoliciesOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves all scaling policies applied to a fleet.
\nTo get a fleet's scaling policies, specify the fleet ID. You can filter this\n request by policy status, such as to retrieve only active scaling policies. Use the\n pagination parameters to retrieve results as a set of sequential pages. If successful,\n set of ScalingPolicy objects is returned for the fleet.
\nA fleet may have all of its scaling policies suspended (StopFleetActions). This operation does not affect the status of the scaling\n policies, which remains ACTIVE. To see whether a fleet's scaling policies are in force\n or suspended, call DescribeFleetAttributes and check the stopped\n actions.
\n\n Related actions\n
\n\n DescribeFleetCapacity | \n UpdateFleetCapacity | \n DescribeEC2InstanceLimits | \n PutScalingPolicy | \n DescribeScalingPolicies | \n DeleteScalingPolicy | \n StopFleetActions | \n StartFleetActions | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#DescribeScalingPoliciesInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to retrieve scaling policies for. You can use either the fleet ID or ARN\n value.
", "smithy.api#required": {} } }, "StatusFilter": { "target": "com.amazonaws.gamelift#ScalingStatusType", "traits": { "smithy.api#documentation": "Scaling policy status to filter results on. A scaling policy is only in force when\n in an ACTIVE status.
\n ACTIVE -- The scaling policy is currently in\n force.
\n\n UPDATEREQUESTED -- A request to update the\n scaling policy has been received.
\n\n UPDATING -- A change is being made to the\n scaling policy.
\n\n DELETEREQUESTED -- A request to delete the\n scaling policy has been received.
\n\n DELETING -- The scaling policy is being\n deleted.
\n\n DELETED -- The scaling policy has been\n deleted.
\n\n ERROR -- An error occurred in creating the\n policy. It should be removed and recreated.
\nThe maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "\n CONTENT TODO\n
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeScalingPoliciesOutput": { "type": "structure", "members": { "ScalingPolicies": { "target": "com.amazonaws.gamelift#ScalingPolicyList", "traits": { "smithy.api#documentation": "A collection of objects containing the scaling policies matching the\n request.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DescribeScript": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeScriptInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeScriptOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves properties for a Realtime script.
\nTo request a script record, specify the script ID. If successful, an object containing the script properties \n is returned.
\n\n Learn more\n
\n\n Amazon GameLift Realtime Servers\n
\n\n Related actions\n
\n\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DescribeScriptInput": { "type": "structure", "members": { "ScriptId": { "target": "com.amazonaws.gamelift#ScriptIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the Realtime script to retrieve properties for. You can use either the script ID or ARN\n value.
", "smithy.api#required": {} } } } }, "com.amazonaws.gamelift#DescribeScriptOutput": { "type": "structure", "members": { "Script": { "target": "com.amazonaws.gamelift#Script", "traits": { "smithy.api#documentation": "A set of properties describing the requested script.
" } } } }, "com.amazonaws.gamelift#DescribeVpcPeeringAuthorizations": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeVpcPeeringAuthorizationsInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeVpcPeeringAuthorizationsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves valid VPC peering authorizations that are pending for the AWS account.\n This operation returns all VPC peering authorizations and requests for peering. This\n includes those initiated and received by this account.
\n\n Related actions\n
\n\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DescribeVpcPeeringAuthorizationsInput": { "type": "structure", "members": {} }, "com.amazonaws.gamelift#DescribeVpcPeeringAuthorizationsOutput": { "type": "structure", "members": { "VpcPeeringAuthorizations": { "target": "com.amazonaws.gamelift#VpcPeeringAuthorizationList", "traits": { "smithy.api#documentation": "A collection of objects that describe all valid VPC peering operations for the\n current AWS account.
" } } } }, "com.amazonaws.gamelift#DescribeVpcPeeringConnections": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#DescribeVpcPeeringConnectionsInput" }, "output": { "target": "com.amazonaws.gamelift#DescribeVpcPeeringConnectionsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves information on VPC peering connections. Use this operation to get peering\n information for all fleets or for one specific fleet ID.
\nTo retrieve connection information, call this operation from the AWS account that\n is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty\n to retrieve all connection records. If successful, the retrieved information includes\n both active and pending connections. Active connections identify the IpV4 CIDR block\n that the VPC uses to connect.
\n\n Related actions\n
\n\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#DescribeVpcPeeringConnectionsInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "A unique identifier for the fleet. You can use either the fleet ID or ARN value.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#DescribeVpcPeeringConnectionsOutput": { "type": "structure", "members": { "VpcPeeringConnections": { "target": "com.amazonaws.gamelift#VpcPeeringConnectionList", "traits": { "smithy.api#documentation": "A collection of VPC peering connection records that match the request.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#DesiredPlayerSession": { "type": "structure", "members": { "PlayerId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for a player to associate with the player session.
" } }, "PlayerData": { "target": "com.amazonaws.gamelift#PlayerData", "traits": { "smithy.api#documentation": "Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.
" } } }, "traits": { "smithy.api#documentation": "Player information for use when creating player sessions using a game session\n placement request with StartGameSessionPlacement.
" } }, "com.amazonaws.gamelift#DesiredPlayerSessionList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#DesiredPlayerSession" } }, "com.amazonaws.gamelift#DnsName": { "type": "string" }, "com.amazonaws.gamelift#Double": { "type": "double" }, "com.amazonaws.gamelift#DoubleObject": { "type": "double", "traits": { "smithy.api#box": {} } }, "com.amazonaws.gamelift#EC2InstanceCounts": { "type": "structure", "members": { "DESIRED": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "Ideal number of active instances. GameLift will always try to maintain the desired\n number of instances. Capacity is scaled up or down by changing the desired instances.
" } }, "MINIMUM": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The minimum instance count value allowed.
" } }, "MAXIMUM": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The maximum instance count value allowed.
" } }, "PENDING": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "Number of instances that are starting but not yet active.
" } }, "ACTIVE": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "Actual number of instances that are ready to host game sessions.
" } }, "IDLE": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "Number of active instances that are not currently hosting a game session.
" } }, "TERMINATING": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "Number of instances that are no longer active but haven't yet been terminated.
" } } }, "traits": { "smithy.api#documentation": "Resource capacity settings. Fleet capacity is measured in EC2 instances. Pending and\n terminating counts are non-zero when the fleet capacity is adjusting to a scaling event\n or if access to resources is temporarily affected.
\nEC2 instance counts are part of FleetCapacity.
" } }, "com.amazonaws.gamelift#EC2InstanceLimit": { "type": "structure", "members": { "EC2InstanceType": { "target": "com.amazonaws.gamelift#EC2InstanceType", "traits": { "smithy.api#documentation": "The name of an EC2 instance type. See Amazon EC2 Instance Types for detailed\n descriptions.
" } }, "CurrentInstances": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The number of instances for the specified type and location that are currently being\n used by the AWS account.
" } }, "InstanceLimit": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The number of instances that is allowed for the specified instance type and\n location.
" } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "An AWS Region code, such as us-west-2.
The GameLift service limits for an EC2 instance type and current utilization. GameLift\n allows AWS accounts a maximum number of instances, per instance type, per AWS Region or\n location, for use with GameLift. You can request an limit increase for your account by\n using the Service limits page in the GameLift\n console.
\n\n Related actions\n
\n\n DescribeEC2InstanceLimits\n
" } }, "com.amazonaws.gamelift#EC2InstanceLimitList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#EC2InstanceLimit" } }, "com.amazonaws.gamelift#EC2InstanceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "t2.micro", "name": "t2_micro" }, { "value": "t2.small", "name": "t2_small" }, { "value": "t2.medium", "name": "t2_medium" }, { "value": "t2.large", "name": "t2_large" }, { "value": "c3.large", "name": "c3_large" }, { "value": "c3.xlarge", "name": "c3_xlarge" }, { "value": "c3.2xlarge", "name": "c3_2xlarge" }, { "value": "c3.4xlarge", "name": "c3_4xlarge" }, { "value": "c3.8xlarge", "name": "c3_8xlarge" }, { "value": "c4.large", "name": "c4_large" }, { "value": "c4.xlarge", "name": "c4_xlarge" }, { "value": "c4.2xlarge", "name": "c4_2xlarge" }, { "value": "c4.4xlarge", "name": "c4_4xlarge" }, { "value": "c4.8xlarge", "name": "c4_8xlarge" }, { "value": "c5.large", "name": "c5_large" }, { "value": "c5.xlarge", "name": "c5_xlarge" }, { "value": "c5.2xlarge", "name": "c5_2xlarge" }, { "value": "c5.4xlarge", "name": "c5_4xlarge" }, { "value": "c5.9xlarge", "name": "c5_9xlarge" }, { "value": "c5.12xlarge", "name": "c5_12xlarge" }, { "value": "c5.18xlarge", "name": "c5_18xlarge" }, { "value": "c5.24xlarge", "name": "c5_24xlarge" }, { "value": "c5a.large", "name": "c5a_large" }, { "value": "c5a.xlarge", "name": "c5a_xlarge" }, { "value": "c5a.2xlarge", "name": "c5a_2xlarge" }, { "value": "c5a.4xlarge", "name": "c5a_4xlarge" }, { "value": "c5a.8xlarge", "name": "c5a_8xlarge" }, { "value": "c5a.12xlarge", "name": "c5a_12xlarge" }, { "value": "c5a.16xlarge", "name": "c5a_16xlarge" }, { "value": "c5a.24xlarge", "name": "c5a_24xlarge" }, { "value": "r3.large", "name": "r3_large" }, { "value": "r3.xlarge", "name": "r3_xlarge" }, { "value": "r3.2xlarge", "name": "r3_2xlarge" }, { "value": "r3.4xlarge", "name": "r3_4xlarge" }, { "value": "r3.8xlarge", "name": "r3_8xlarge" }, { "value": "r4.large", "name": "r4_large" }, { "value": "r4.xlarge", "name": "r4_xlarge" }, { "value": "r4.2xlarge", "name": "r4_2xlarge" }, { "value": "r4.4xlarge", "name": "r4_4xlarge" }, { "value": "r4.8xlarge", "name": "r4_8xlarge" }, { "value": "r4.16xlarge", "name": "r4_16xlarge" }, { "value": "r5.large", "name": "r5_large" }, { "value": "r5.xlarge", "name": "r5_xlarge" }, { "value": "r5.2xlarge", "name": "r5_2xlarge" }, { "value": "r5.4xlarge", "name": "r5_4xlarge" }, { "value": "r5.8xlarge", "name": "r5_8xlarge" }, { "value": "r5.12xlarge", "name": "r5_12xlarge" }, { "value": "r5.16xlarge", "name": "r5_16xlarge" }, { "value": "r5.24xlarge", "name": "r5_24xlarge" }, { "value": "r5a.large", "name": "r5a_large" }, { "value": "r5a.xlarge", "name": "r5a_xlarge" }, { "value": "r5a.2xlarge", "name": "r5a_2xlarge" }, { "value": "r5a.4xlarge", "name": "r5a_4xlarge" }, { "value": "r5a.8xlarge", "name": "r5a_8xlarge" }, { "value": "r5a.12xlarge", "name": "r5a_12xlarge" }, { "value": "r5a.16xlarge", "name": "r5a_16xlarge" }, { "value": "r5a.24xlarge", "name": "r5a_24xlarge" }, { "value": "m3.medium", "name": "m3_medium" }, { "value": "m3.large", "name": "m3_large" }, { "value": "m3.xlarge", "name": "m3_xlarge" }, { "value": "m3.2xlarge", "name": "m3_2xlarge" }, { "value": "m4.large", "name": "m4_large" }, { "value": "m4.xlarge", "name": "m4_xlarge" }, { "value": "m4.2xlarge", "name": "m4_2xlarge" }, { "value": "m4.4xlarge", "name": "m4_4xlarge" }, { "value": "m4.10xlarge", "name": "m4_10xlarge" }, { "value": "m5.large", "name": "m5_large" }, { "value": "m5.xlarge", "name": "m5_xlarge" }, { "value": "m5.2xlarge", "name": "m5_2xlarge" }, { "value": "m5.4xlarge", "name": "m5_4xlarge" }, { "value": "m5.8xlarge", "name": "m5_8xlarge" }, { "value": "m5.12xlarge", "name": "m5_12xlarge" }, { "value": "m5.16xlarge", "name": "m5_16xlarge" }, { "value": "m5.24xlarge", "name": "m5_24xlarge" }, { "value": "m5a.large", "name": "m5a_large" }, { "value": "m5a.xlarge", "name": "m5a_xlarge" }, { "value": "m5a.2xlarge", "name": "m5a_2xlarge" }, { "value": "m5a.4xlarge", "name": "m5a_4xlarge" }, { "value": "m5a.8xlarge", "name": "m5a_8xlarge" }, { "value": "m5a.12xlarge", "name": "m5a_12xlarge" }, { "value": "m5a.16xlarge", "name": "m5a_16xlarge" }, { "value": "m5a.24xlarge", "name": "m5a_24xlarge" } ] } }, "com.amazonaws.gamelift#Event": { "type": "structure", "members": { "EventId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for a fleet event.
" } }, "ResourceId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for an event resource, such as a fleet ID.
" } }, "EventCode": { "target": "com.amazonaws.gamelift#EventCode", "traits": { "smithy.api#documentation": "The type of event being logged.
\n\n Fleet creation events (ordered by fleet creation activity):\n
\nFLEET_CREATED -- A fleet resource was successfully created with a status of\n NEW. Event messaging includes the fleet ID.
FLEET_STATE_DOWNLOADING -- Fleet status changed from NEW to\n DOWNLOADING. The compressed build has started downloading to a\n fleet instance for installation.
FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the fleet\n instance.
\nFLEET_CREATION_EXTRACTING_BUILD – The game server build was successfully\n downloaded to an instance, and the build files are now being extracted from the\n uploaded build and saved to an instance. Failure at this stage prevents a fleet\n from moving to ACTIVE status. Logs for this stage display a list of\n the files that are extracted and saved on the instance. Access the logs by using\n the URL in PreSignedLogUrl.
FLEET_CREATION_RUNNING_INSTALLER – The game server build files were\n successfully extracted, and the GameLift is now running the build's install\n script (if one is included). Failure in this stage prevents a fleet from moving\n to ACTIVE status. Logs for this stage list the installation steps\n and whether or not the install completed successfully. Access the logs by using\n the URL in PreSignedLogUrl.
FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful,\n and the GameLift is now verifying that the game server launch paths, which are\n specified in the fleet's runtime configuration, exist. If any listed launch path\n exists, GameLift tries to launch a game server process and waits for the process\n to report ready. Failures in this stage prevent a fleet from moving to\n ACTIVE status. Logs for this stage list the launch paths in the\n runtime configuration and indicate whether each is found. Access the logs by\n using the URL in PreSignedLogUrl.\n \n
FLEET_STATE_VALIDATING -- Fleet status changed from\n DOWNLOADING to VALIDATING.
FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the runtime\n configuration failed because the executable specified in a launch path does not\n exist on the instance.
\nFLEET_STATE_BUILDING -- Fleet status changed from VALIDATING\n to BUILDING.
FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime\n configuration failed because the executable specified in a launch path failed to\n run on the fleet instance.
\nFLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING\n to ACTIVATING.
FLEET_ACTIVATION_FAILED - The fleet failed to successfully complete one of\n the steps in the fleet activation process. This event code indicates that the\n game build was successfully downloaded to a fleet instance, built, and\n validated, but was not able to start a server process. Learn more at \n Debug Fleet\n Creation Issues\n
\nFLEET_STATE_ACTIVE -- The fleet's status changed from\n ACTIVATING to ACTIVE. The fleet is now ready to\n host game sessions.
\n VPC peering events:\n
\nFLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been\n established between the VPC for an GameLift fleet and a VPC in your AWS\n account.
\nFLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed.\n Event details and status information (see DescribeVpcPeeringConnections) provide additional detail. A\n common reason for peering failure is that the two VPCs have overlapping CIDR\n blocks of IPv4 addresses. To resolve this, change the CIDR block for the VPC in\n your AWS account. For more information on VPC peering failures, see https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html\n
\nFLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully\n deleted.
\n\n Spot instance events:\n
\nINSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a\n two-minute notification.
\n\n Other fleet events:\n
\nFLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings\n (desired instances, minimum/maximum scaling limits). Event messaging includes\n the new capacity settings.
\nFLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to\n the fleet's game session protection policy setting. Event messaging includes\n both the old and new policy setting.
\nFLEET_DELETED -- A request to delete a fleet was initiated.
\nGENERIC_EVENT -- An unspecified event has occurred.
\nAdditional information related to the event.
" } }, "EventTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { "smithy.api#documentation": "Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Location of stored logs with additional detail that is related to the event. This\n is useful for debugging issues. The URL is valid for 15 minutes. You can also access\n fleet creation logs through the GameLift console.
" } } }, "traits": { "smithy.api#documentation": "Log entry describing an event that involves GameLift resources (such as a fleet). In\n addition to tracking activity, event codes and messages can provide additional\n information for troubleshooting and debugging problems.
\n\n Related actions\n
\n\n DescribeFleetEvents\n
" } }, "com.amazonaws.gamelift#EventCode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "GENERIC_EVENT", "name": "GENERIC_EVENT" }, { "value": "FLEET_CREATED", "name": "FLEET_CREATED" }, { "value": "FLEET_DELETED", "name": "FLEET_DELETED" }, { "value": "FLEET_SCALING_EVENT", "name": "FLEET_SCALING_EVENT" }, { "value": "FLEET_STATE_DOWNLOADING", "name": "FLEET_STATE_DOWNLOADING" }, { "value": "FLEET_STATE_VALIDATING", "name": "FLEET_STATE_VALIDATING" }, { "value": "FLEET_STATE_BUILDING", "name": "FLEET_STATE_BUILDING" }, { "value": "FLEET_STATE_ACTIVATING", "name": "FLEET_STATE_ACTIVATING" }, { "value": "FLEET_STATE_ACTIVE", "name": "FLEET_STATE_ACTIVE" }, { "value": "FLEET_STATE_ERROR", "name": "FLEET_STATE_ERROR" }, { "value": "FLEET_INITIALIZATION_FAILED", "name": "FLEET_INITIALIZATION_FAILED" }, { "value": "FLEET_BINARY_DOWNLOAD_FAILED", "name": "FLEET_BINARY_DOWNLOAD_FAILED" }, { "value": "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND", "name": "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND" }, { "value": "FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE", "name": "FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE" }, { "value": "FLEET_VALIDATION_TIMED_OUT", "name": "FLEET_VALIDATION_TIMED_OUT" }, { "value": "FLEET_ACTIVATION_FAILED", "name": "FLEET_ACTIVATION_FAILED" }, { "value": "FLEET_ACTIVATION_FAILED_NO_INSTANCES", "name": "FLEET_ACTIVATION_FAILED_NO_INSTANCES" }, { "value": "FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED", "name": "FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED" }, { "value": "SERVER_PROCESS_INVALID_PATH", "name": "SERVER_PROCESS_INVALID_PATH" }, { "value": "SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT", "name": "SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT" }, { "value": "SERVER_PROCESS_PROCESS_READY_TIMEOUT", "name": "SERVER_PROCESS_PROCESS_READY_TIMEOUT" }, { "value": "SERVER_PROCESS_CRASHED", "name": "SERVER_PROCESS_CRASHED" }, { "value": "SERVER_PROCESS_TERMINATED_UNHEALTHY", "name": "SERVER_PROCESS_TERMINATED_UNHEALTHY" }, { "value": "SERVER_PROCESS_FORCE_TERMINATED", "name": "SERVER_PROCESS_FORCE_TERMINATED" }, { "value": "SERVER_PROCESS_PROCESS_EXIT_TIMEOUT", "name": "SERVER_PROCESS_PROCESS_EXIT_TIMEOUT" }, { "value": "GAME_SESSION_ACTIVATION_TIMEOUT", "name": "GAME_SESSION_ACTIVATION_TIMEOUT" }, { "value": "FLEET_CREATION_EXTRACTING_BUILD", "name": "FLEET_CREATION_EXTRACTING_BUILD" }, { "value": "FLEET_CREATION_RUNNING_INSTALLER", "name": "FLEET_CREATION_RUNNING_INSTALLER" }, { "value": "FLEET_CREATION_VALIDATING_RUNTIME_CONFIG", "name": "FLEET_CREATION_VALIDATING_RUNTIME_CONFIG" }, { "value": "FLEET_VPC_PEERING_SUCCEEDED", "name": "FLEET_VPC_PEERING_SUCCEEDED" }, { "value": "FLEET_VPC_PEERING_FAILED", "name": "FLEET_VPC_PEERING_FAILED" }, { "value": "FLEET_VPC_PEERING_DELETED", "name": "FLEET_VPC_PEERING_DELETED" }, { "value": "INSTANCE_INTERRUPTED", "name": "INSTANCE_INTERRUPTED" } ] } }, "com.amazonaws.gamelift#EventList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#Event" } }, "com.amazonaws.gamelift#FilterConfiguration": { "type": "structure", "members": { "AllowedLocations": { "target": "com.amazonaws.gamelift#LocationList", "traits": { "smithy.api#documentation": " A list of locations to allow game session placement in, in the form of AWS Region\n codes such as us-west-2.
A list of fleet locations where a game session queue can place new game sessions. You\n can use a filter to temporarily turn off placements for specific locations. For queues\n that have multi-location fleets, you can use a filter configuration allow placement with\n some, but not all of these locations.
\nFilter configurations are part of a GameSessionQueue.
" } }, "com.amazonaws.gamelift#FleetAction": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "AUTO_SCALING", "name": "AutoScaling" } ] } }, "com.amazonaws.gamelift#FleetActionList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#FleetAction" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.gamelift#FleetArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:.*:fleet\\/fleet-\\S+" } }, "com.amazonaws.gamelift#FleetAttributes": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "A unique identifier for the fleet.
" } }, "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:. In a GameLift fleet ARN, the resource ID matches the FleetId\n value.
The kind of instances, On-Demand or Spot, that this fleet uses.
" } }, "InstanceType": { "target": "com.amazonaws.gamelift#EC2InstanceType", "traits": { "smithy.api#documentation": "The EC2 instance type that determines the computing resources of each instance in\n the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See\n Amazon EC2 Instance Types\n for detailed descriptions.
" } }, "Description": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A human-readable description of the fleet.
" } }, "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
" } }, "CreationTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { "smithy.api#documentation": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Current status of the fleet. Possible fleet statuses include the following:
\n\n NEW -- A new fleet has been defined and desired\n instances is set to 1.
\n\n DOWNLOADING/VALIDATING/BUILDING/ACTIVATING --\n GameLift is setting up the new fleet, creating new instances with the game build\n or Realtime script and starting server processes.
\n\n ACTIVE -- Hosts can now accept game\n sessions.
\n\n ERROR -- An error occurred when downloading,\n validating, building, or activating the fleet.
\n\n DELETING -- Hosts are responding to a delete\n fleet request.
\n\n TERMINATED -- The fleet no longer\n exists.
\nA unique identifier for the build resource that is deployed on instances in this fleet.
" } }, "BuildArn": { "target": "com.amazonaws.gamelift#BuildArn", "traits": { "smithy.api#documentation": " The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in\n this fleet. In a GameLift build ARN, the resource ID matches the BuildId\n value.
A unique identifier for the Realtime script resource that is deployed on instances in this fleet.
" } }, "ScriptArn": { "target": "com.amazonaws.gamelift#ScriptArn", "traits": { "smithy.api#documentation": " The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances\n in this fleet. In a GameLift script ARN, the resource ID matches the\n ScriptId value.
\n This parameter is no longer used. Server launch paths\n are now defined using the fleet's RuntimeConfiguration parameter.\n Requests that use this parameter instead continue to be valid.
" } }, "ServerLaunchParameters": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "\n This parameter is no longer used. Server launch\n parameters are now defined using the fleet's RuntimeConfiguration\n parameter. Requests that use this parameter instead continue to be valid.
" } }, "LogPaths": { "target": "com.amazonaws.gamelift#StringList", "traits": { "smithy.api#documentation": "\n This parameter is no longer used. Game session log\n paths are now defined using the GameLift server API ProcessReady()\n logParameters. See more information in the Server API Reference.
The type of game session protection to set on all new instances that are started in\n the fleet.
\n\n NoProtection -- The game session can be\n terminated during a scale-down event.
\n\n FullProtection -- If the game session is in an\n ACTIVE status, it cannot be terminated during a scale-down\n event.
The operating system of the fleet's computing resources. A fleet's operating system is\n determined by the OS of the build or script that is deployed on this fleet.
" } }, "ResourceCreationLimitPolicy": { "target": "com.amazonaws.gamelift#ResourceCreationLimitPolicy", "traits": { "smithy.api#documentation": "The fleet policy that limits the number of game sessions an individual player can\n create over a span of time.
" } }, "MetricGroups": { "target": "com.amazonaws.gamelift#MetricGroupList", "traits": { "smithy.api#documentation": "Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch,\n you can view aggregated metrics for fleets that are in a metric group. A fleet can be\n included in only one metric group at a time.
" } }, "StoppedActions": { "target": "com.amazonaws.gamelift#FleetActionList", "traits": { "smithy.api#documentation": "A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling.
" } }, "InstanceRoleArn": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { "smithy.api#documentation": "A unique identifier for an AWS IAM role that manages access to your AWS services. \n With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, \n including install scripts, server processes, and daemons (background processes). Create a role or look up a role's \n ARN by using the IAM dashboard in the AWS Management Console.\n Learn more about using on-box credentials for your game servers at \n \n Access external resources from a game server.
" } }, "CertificateConfiguration": { "target": "com.amazonaws.gamelift#CertificateConfiguration", "traits": { "smithy.api#documentation": "Indicates whether a TLS/SSL certificate was generated for the fleet.
" } } }, "traits": { "smithy.api#documentation": "Describes a GameLift fleet of game hosting resources.
\n\n Related actions\n
\n\n CreateFleet | DescribeFleetAttributes\n
" } }, "com.amazonaws.gamelift#FleetAttributesList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#FleetAttributes" } }, "com.amazonaws.gamelift#FleetCapacity": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "A unique identifier for the fleet associated with the location.
" } }, "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:.
The EC2 instance type that is used for all instances in a fleet. The instance type\n determines the computing resources in use, including CPU, memory, storage, and\n networking capacity. See Amazon EC2\n Instance Types for detailed descriptions.
" } }, "InstanceCounts": { "target": "com.amazonaws.gamelift#EC2InstanceCounts", "traits": { "smithy.api#documentation": "The current instance count and capacity settings for the fleet location.
" } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "The fleet location for the instance count information, expressed as an AWS Region\n code, such as us-west-2.
Current resource capacity settings in a specified fleet or location. The location\n value might refer to a fleet's remote location or its home Region.
\n\n Related actions\n
\n\n DescribeFleetCapacity | \n DescribeFleetLocationCapacity | \n UpdateFleetCapacity\n
" } }, "com.amazonaws.gamelift#FleetCapacityExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.gamelift#NonEmptyString" } }, "traits": { "smithy.api#documentation": "The specified fleet has no available instances to fulfill a\n CreateGameSession request. Clients can retry such requests immediately\n or after a waiting period.
A unique identifier for the fleet associated with the location.
" } }, "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:.
The number of server processes in ACTIVE status that are currently\n running across all instances in the fleet location.
The number of active game sessions that are currently being hosted across all\n instances in the fleet location.
" } }, "CurrentPlayerSessionCount": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The number of active player sessions that are currently being hosted across all\n instances in the fleet location.
" } }, "MaximumPlayerSessionCount": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The maximum number of players allowed across all game sessions that are currently\n being hosted across all instances in the fleet location.
" } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "The fleet location for the fleet utilization information, expressed as an AWS Region\n code, such as us-west-2.
Current resource utilization statistics in a specified fleet or location. The location\n value might refer to a fleet's remote location or its home Region.
\n\n Related actions\n
\n\n DescribeFleetUtilization | DescribeFleetLocationUtilization\n
" } }, "com.amazonaws.gamelift#FleetUtilizationList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#FleetUtilization" } }, "com.amazonaws.gamelift#FlexMatchMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "STANDALONE", "name": "STANDALONE" }, { "value": "WITH_QUEUE", "name": "WITH_QUEUE" } ] } }, "com.amazonaws.gamelift#Float": { "type": "float" }, "com.amazonaws.gamelift#FreeText": { "type": "string" }, "com.amazonaws.gamelift#GameLift": { "type": "service", "version": "2015-10-01", "operations": [ { "target": "com.amazonaws.gamelift#AcceptMatch" }, { "target": "com.amazonaws.gamelift#ClaimGameServer" }, { "target": "com.amazonaws.gamelift#CreateAlias" }, { "target": "com.amazonaws.gamelift#CreateBuild" }, { "target": "com.amazonaws.gamelift#CreateFleet" }, { "target": "com.amazonaws.gamelift#CreateFleetLocations" }, { "target": "com.amazonaws.gamelift#CreateGameServerGroup" }, { "target": "com.amazonaws.gamelift#CreateGameSession" }, { "target": "com.amazonaws.gamelift#CreateGameSessionQueue" }, { "target": "com.amazonaws.gamelift#CreateMatchmakingConfiguration" }, { "target": "com.amazonaws.gamelift#CreateMatchmakingRuleSet" }, { "target": "com.amazonaws.gamelift#CreatePlayerSession" }, { "target": "com.amazonaws.gamelift#CreatePlayerSessions" }, { "target": "com.amazonaws.gamelift#CreateScript" }, { "target": "com.amazonaws.gamelift#CreateVpcPeeringAuthorization" }, { "target": "com.amazonaws.gamelift#CreateVpcPeeringConnection" }, { "target": "com.amazonaws.gamelift#DeleteAlias" }, { "target": "com.amazonaws.gamelift#DeleteBuild" }, { "target": "com.amazonaws.gamelift#DeleteFleet" }, { "target": "com.amazonaws.gamelift#DeleteFleetLocations" }, { "target": "com.amazonaws.gamelift#DeleteGameServerGroup" }, { "target": "com.amazonaws.gamelift#DeleteGameSessionQueue" }, { "target": "com.amazonaws.gamelift#DeleteMatchmakingConfiguration" }, { "target": "com.amazonaws.gamelift#DeleteMatchmakingRuleSet" }, { "target": "com.amazonaws.gamelift#DeleteScalingPolicy" }, { "target": "com.amazonaws.gamelift#DeleteScript" }, { "target": "com.amazonaws.gamelift#DeleteVpcPeeringAuthorization" }, { "target": "com.amazonaws.gamelift#DeleteVpcPeeringConnection" }, { "target": "com.amazonaws.gamelift#DeregisterGameServer" }, { "target": "com.amazonaws.gamelift#DescribeAlias" }, { "target": "com.amazonaws.gamelift#DescribeBuild" }, { "target": "com.amazonaws.gamelift#DescribeEC2InstanceLimits" }, { "target": "com.amazonaws.gamelift#DescribeFleetAttributes" }, { "target": "com.amazonaws.gamelift#DescribeFleetCapacity" }, { "target": "com.amazonaws.gamelift#DescribeFleetEvents" }, { "target": "com.amazonaws.gamelift#DescribeFleetLocationAttributes" }, { "target": "com.amazonaws.gamelift#DescribeFleetLocationCapacity" }, { "target": "com.amazonaws.gamelift#DescribeFleetLocationUtilization" }, { "target": "com.amazonaws.gamelift#DescribeFleetPortSettings" }, { "target": "com.amazonaws.gamelift#DescribeFleetUtilization" }, { "target": "com.amazonaws.gamelift#DescribeGameServer" }, { "target": "com.amazonaws.gamelift#DescribeGameServerGroup" }, { "target": "com.amazonaws.gamelift#DescribeGameServerInstances" }, { "target": "com.amazonaws.gamelift#DescribeGameSessionDetails" }, { "target": "com.amazonaws.gamelift#DescribeGameSessionPlacement" }, { "target": "com.amazonaws.gamelift#DescribeGameSessionQueues" }, { "target": "com.amazonaws.gamelift#DescribeGameSessions" }, { "target": "com.amazonaws.gamelift#DescribeInstances" }, { "target": "com.amazonaws.gamelift#DescribeMatchmaking" }, { "target": "com.amazonaws.gamelift#DescribeMatchmakingConfigurations" }, { "target": "com.amazonaws.gamelift#DescribeMatchmakingRuleSets" }, { "target": "com.amazonaws.gamelift#DescribePlayerSessions" }, { "target": "com.amazonaws.gamelift#DescribeRuntimeConfiguration" }, { "target": "com.amazonaws.gamelift#DescribeScalingPolicies" }, { "target": "com.amazonaws.gamelift#DescribeScript" }, { "target": "com.amazonaws.gamelift#DescribeVpcPeeringAuthorizations" }, { "target": "com.amazonaws.gamelift#DescribeVpcPeeringConnections" }, { "target": "com.amazonaws.gamelift#GetGameSessionLogUrl" }, { "target": "com.amazonaws.gamelift#GetInstanceAccess" }, { "target": "com.amazonaws.gamelift#ListAliases" }, { "target": "com.amazonaws.gamelift#ListBuilds" }, { "target": "com.amazonaws.gamelift#ListFleets" }, { "target": "com.amazonaws.gamelift#ListGameServerGroups" }, { "target": "com.amazonaws.gamelift#ListGameServers" }, { "target": "com.amazonaws.gamelift#ListScripts" }, { "target": "com.amazonaws.gamelift#ListTagsForResource" }, { "target": "com.amazonaws.gamelift#PutScalingPolicy" }, { "target": "com.amazonaws.gamelift#RegisterGameServer" }, { "target": "com.amazonaws.gamelift#RequestUploadCredentials" }, { "target": "com.amazonaws.gamelift#ResolveAlias" }, { "target": "com.amazonaws.gamelift#ResumeGameServerGroup" }, { "target": "com.amazonaws.gamelift#SearchGameSessions" }, { "target": "com.amazonaws.gamelift#StartFleetActions" }, { "target": "com.amazonaws.gamelift#StartGameSessionPlacement" }, { "target": "com.amazonaws.gamelift#StartMatchBackfill" }, { "target": "com.amazonaws.gamelift#StartMatchmaking" }, { "target": "com.amazonaws.gamelift#StopFleetActions" }, { "target": "com.amazonaws.gamelift#StopGameSessionPlacement" }, { "target": "com.amazonaws.gamelift#StopMatchmaking" }, { "target": "com.amazonaws.gamelift#SuspendGameServerGroup" }, { "target": "com.amazonaws.gamelift#TagResource" }, { "target": "com.amazonaws.gamelift#UntagResource" }, { "target": "com.amazonaws.gamelift#UpdateAlias" }, { "target": "com.amazonaws.gamelift#UpdateBuild" }, { "target": "com.amazonaws.gamelift#UpdateFleetAttributes" }, { "target": "com.amazonaws.gamelift#UpdateFleetCapacity" }, { "target": "com.amazonaws.gamelift#UpdateFleetPortSettings" }, { "target": "com.amazonaws.gamelift#UpdateGameServer" }, { "target": "com.amazonaws.gamelift#UpdateGameServerGroup" }, { "target": "com.amazonaws.gamelift#UpdateGameSession" }, { "target": "com.amazonaws.gamelift#UpdateGameSessionQueue" }, { "target": "com.amazonaws.gamelift#UpdateMatchmakingConfiguration" }, { "target": "com.amazonaws.gamelift#UpdateRuntimeConfiguration" }, { "target": "com.amazonaws.gamelift#UpdateScript" }, { "target": "com.amazonaws.gamelift#ValidateMatchmakingRuleSet" } ], "traits": { "aws.api#service": { "sdkId": "GameLift", "arnNamespace": "gamelift", "cloudFormationName": "GameLift", "cloudTrailEventSource": "gamelift.amazonaws.com", "endpointPrefix": "gamelift" }, "aws.auth#sigv4": { "name": "gamelift" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "GameLift provides solutions for hosting session-based multiplayer game servers in the\n cloud, including tools for deploying, operating, and scaling game servers. Built on AWS\n global computing infrastructure, GameLift helps you deliver high-performance,\n high-reliability, low-cost game servers while dynamically scaling your resource usage to\n meet player demand.
\n\n About GameLift solutions\n
\nGet more information on these GameLift solutions in the GameLift Developer Guide.
\nGameLift managed hosting -- GameLift offers a fully managed service to set up and maintain\n computing machines for hosting, manage game session and player session life\n cycle, and handle security, storage, and performance tracking. You can use\n automatic scaling tools to balance player demand and hosting costs, configure\n your game session management to minimize player latency, and add FlexMatch for\n matchmaking.
\nManaged hosting with Realtime Servers -- With GameLift Realtime Servers, you can quickly configure and set up\n ready-to-go game servers for your game. Realtime Servers provides a game server framework\n with core GameLift infrastructure already built in. Then use the full range of\n GameLift managed hosting features, including FlexMatch, for your game.
\nGameLift FleetIQ -- Use GameLift FleetIQ as a standalone service while hosting your games using EC2 instances and\n Auto Scaling groups. GameLift FleetIQ provides optimizations for game hosting, including\n boosting the viability of low-cost Spot Instances gaming. For a complete\n solution, pair the GameLift FleetIQ and FlexMatch standalone services.
\nGameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is a\n customizable matchmaking service for multiplayer games. Use FlexMatch as\n integrated with GameLift managed hosting or incorporate FlexMatch as a standalone\n service into your own hosting solution.
\n\n About this API Reference\n
\nThis reference guide describes the low-level service API for Amazon GameLift. With each topic\n in this guide, you can find links to language-specific SDK guides and the AWS CLI\n reference. Useful links:
\nThe game property identifier.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.gamelift#GamePropertyValue", "traits": { "smithy.api#documentation": "The game property value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Set of key-value pairs that contain information about a game session. When included in\n a game session request, these properties communicate details to be used when setting up\n the new game session. For example, a game property might specify a game mode, level, or\n map. Game properties are passed to the game server process when initiating a new game\n session. For more information, see the GameLift Developer Guide.
" } }, "com.amazonaws.gamelift#GamePropertyKey": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 32 } } }, "com.amazonaws.gamelift#GamePropertyList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#GameProperty" }, "traits": { "smithy.api#length": { "min": 0, "max": 16 } } }, "com.amazonaws.gamelift#GamePropertyValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 96 } } }, "com.amazonaws.gamelift#GameServer": { "type": "structure", "members": { "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupName", "traits": { "smithy.api#documentation": "A unique identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value.
" } }, "GameServerGroupArn": { "target": "com.amazonaws.gamelift#GameServerGroupArn", "traits": { "smithy.api#documentation": "The ARN identifier for the game server group where the game server is located.
" } }, "GameServerId": { "target": "com.amazonaws.gamelift#GameServerId", "traits": { "smithy.api#documentation": "A custom string that uniquely identifies the game server. Game server IDs are\n developer-defined and are unique across all game server groups in an AWS\n account.
" } }, "InstanceId": { "target": "com.amazonaws.gamelift#GameServerInstanceId", "traits": { "smithy.api#documentation": "The unique identifier for the instance where the game server is running. This ID is\n available in the instance metadata. EC2 instance IDs \n use a 17-character format, for example: i-1234567890abcdef0.
The port and IP address that must be used to establish a client connection to the game server.
" } }, "GameServerData": { "target": "com.amazonaws.gamelift#GameServerData", "traits": { "smithy.api#documentation": "A set of custom game server properties, formatted as a single string value. This data \n is passed to a game client or service when it requests information on game servers using\n ListGameServers or ClaimGameServer.
" } }, "ClaimStatus": { "target": "com.amazonaws.gamelift#GameServerClaimStatus", "traits": { "smithy.api#documentation": "Indicates when an available game server has been reserved for gameplay but has not yet\n started hosting a game. Once it is claimed, the game server remains in\n CLAIMED status for a maximum of one minute. During this time, game\n clients connect to the game server to start the game and trigger the game server to\n update its utilization status. After one minute, the game server claim status reverts to\n null.
Indicates whether the game server is currently available for new games or is busy. Possible statuses include:
\n\n AVAILABLE - The game server is available to be claimed. A game server that has\n been claimed remains in this status until it reports game hosting activity.
\n UTILIZED - The game server is currently hosting a game session with players.
Timestamp that indicates when the game server was created with a RegisterGameServer request. The format is a number expressed in Unix\n time as milliseconds (for example \"1469498468.057\").
Timestamp that indicates the last time the game server was claimed with a ClaimGameServer request. The format is a number expressed in Unix time\n as milliseconds (for example \"1469498468.057\"). This value is used to\n calculate when a claimed game server's status should revert to null.
Timestamp that indicates the last time the game server was updated with health status\n using an UpdateGameServer request. The format is a number expressed in\n Unix time as milliseconds (for example \"1469498468.057\"). After game server\n registration, this property is only changed when a game server update specifies a health\n check value.
\n This data type is used with the GameLift FleetIQ and game server groups.\n
\nProperties describing a game server that is running on an instance in a GameServerGroup.
\nA game server is created by a successful call to RegisterGameServer and\n deleted by calling DeregisterGameServer. A game server is claimed to host a\n game session by calling ClaimGameServer.
\n Related actions\n
\n\n RegisterGameServer | \n ListGameServers | \n ClaimGameServer | \n DescribeGameServer | \n UpdateGameServer | \n DeregisterGameServer | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#GameServerClaimStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CLAIMED", "name": "CLAIMED" } ] } }, "com.amazonaws.gamelift#GameServerConnectionInfo": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.gamelift#GameServerData": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.gamelift#GameServerGroup": { "type": "structure", "members": { "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupName", "traits": { "smithy.api#documentation": "A developer-defined identifier for the game server group. The name is unique for each\n Region in each AWS account.
" } }, "GameServerGroupArn": { "target": "com.amazonaws.gamelift#GameServerGroupArn", "traits": { "smithy.api#documentation": "A generated unique ID for the game server group.
" } }, "RoleArn": { "target": "com.amazonaws.gamelift#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon GameLift to access your EC2 Auto Scaling groups.
" } }, "InstanceDefinitions": { "target": "com.amazonaws.gamelift#InstanceDefinitions", "traits": { "smithy.api#documentation": "The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically\n scaling instances in the corresponding Auto Scaling group.
" } }, "BalancingStrategy": { "target": "com.amazonaws.gamelift#BalancingStrategy", "traits": { "smithy.api#documentation": "Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the\n game server group. Method options include the following:
\n\n SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot\n Instances are unavailable or not viable for game hosting, the game server group\n provides no hosting capacity until Spot Instances can again be used. Until then,\n no new instances are started, and the existing nonviable Spot Instances are\n terminated (after current gameplay ends) and are not replaced.
\n SPOT_PREFERRED - (default value) Spot Instances are used whenever available in\n the game server group. If Spot Instances are unavailable, the game server group\n continues to provide hosting capacity by falling back to On-Demand Instances.\n Existing nonviable Spot Instances are terminated (after current gameplay ends)\n and are replaced with new On-Demand Instances.
\n ON_DEMAND_ONLY - Only On-Demand Instances are used in the game\n server group. No Spot Instances are used, even when available, while this\n balancing strategy is in force.
A flag that indicates whether instances in the game server group are protected \n from early termination. Unprotected instances that have active game servers running might \n be terminated during a scale-down event, causing players to be dropped from the game. \n Protected instances cannot be terminated while there are active game servers running except \n in the event of a forced game server group deletion (see ). An exception to this is with Spot \n Instances, which can be terminated by AWS regardless of protection status.
" } }, "AutoScalingGroupArn": { "target": "com.amazonaws.gamelift#AutoScalingGroupArn", "traits": { "smithy.api#documentation": "A generated unique ID for the EC2 Auto Scaling group that is associated with this\n game server group.
" } }, "Status": { "target": "com.amazonaws.gamelift#GameServerGroupStatus", "traits": { "smithy.api#documentation": "The current status of the game server group. Possible statuses include:
\n\n NEW - GameLift FleetIQ has validated the CreateGameServerGroup()\n request.
\n ACTIVATING - GameLift FleetIQ is setting up a game server group, which\n includes creating an Auto Scaling group in your AWS account.
\n ACTIVE - The game server group has been successfully created.
\n DELETE_SCHEDULED - A request to delete the game server group has\n been received.
\n DELETING - GameLift FleetIQ has received a valid\n DeleteGameServerGroup() request and is processing it. GameLift FleetIQ\n must first complete and release hosts before it deletes the Auto Scaling group\n and the game server group.
\n DELETED - The game server group has been successfully deleted.
\n ERROR - The asynchronous processes of activating or deleting a game server group\n has failed, resulting in an error state.
Additional information about the current game server group status. This information\n might provide additional insight on groups that are in ERROR status.
A list of activities that are currently suspended for this game server group.\n If this property is empty, all activities are occurring.
" } }, "CreationTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { "smithy.api#documentation": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
A timestamp that indicates when this game server group was last updated.
" } } }, "traits": { "smithy.api#documentation": "\n This data type is used with the GameLift FleetIQ and game server groups.\n
\nProperties that describe a game server group resource. A game server group manages\n certain properties related to a corresponding EC2 Auto Scaling group.
\nA game server group is created by a successful call to\n CreateGameServerGroup and deleted by calling\n DeleteGameServerGroup. Game server group activity can be temporarily\n suspended and resumed by calling SuspendGameServerGroup and\n ResumeGameServerGroup, respectively.
\n Related actions\n
\n\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#GameServerGroupAction": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "REPLACE_INSTANCE_TYPES", "name": "REPLACE_INSTANCE_TYPES" } ] } }, "com.amazonaws.gamelift#GameServerGroupActions": { "type": "list", "member": { "target": "com.amazonaws.gamelift#GameServerGroupAction" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.gamelift#GameServerGroupArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^arn:.*:gameservergroup\\/[a-zA-Z0-9-\\.]*" } }, "com.amazonaws.gamelift#GameServerGroupAutoScalingPolicy": { "type": "structure", "members": { "EstimatedInstanceWarmup": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#documentation": "Length of time, in seconds, it takes for a new instance to start new game server\n processes and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly\n with game servers that take a long time to start up, because it avoids prematurely\n starting new instances.
" } }, "TargetTrackingConfiguration": { "target": "com.amazonaws.gamelift#TargetTrackingConfiguration", "traits": { "smithy.api#documentation": "Settings for a target-based scaling policy applied to Auto Scaling group. These\n settings are used to create a target-based policy that tracks the GameLift FleetIQ metric\n \"PercentUtilizedGameServers\" and specifies a target value for the\n metric. As player usage changes, the policy triggers to adjust the game server group\n capacity so that the metric returns to the target value.
\n This data type is used with the GameLift FleetIQ and game server groups.\n
\nConfiguration settings for intelligent automatic scaling that uses target tracking.\n These settings are used to add an Auto Scaling policy when creating the corresponding\n Auto Scaling group with CreateGameServerGroup. After the Auto Scaling\n group is created, all updates to Auto Scaling policies, including changing this policy\n and adding or removing other policies, is done directly on the Auto Scaling group.
" } }, "com.amazonaws.gamelift#GameServerGroupDeleteOption": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SAFE_DELETE", "name": "SAFE_DELETE" }, { "value": "FORCE_DELETE", "name": "FORCE_DELETE" }, { "value": "RETAIN", "name": "RETAIN" } ] } }, "com.amazonaws.gamelift#GameServerGroupInstanceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "c4.large", "name": "c4_large" }, { "value": "c4.xlarge", "name": "c4_xlarge" }, { "value": "c4.2xlarge", "name": "c4_2xlarge" }, { "value": "c4.4xlarge", "name": "c4_4xlarge" }, { "value": "c4.8xlarge", "name": "c4_8xlarge" }, { "value": "c5.large", "name": "c5_large" }, { "value": "c5.xlarge", "name": "c5_xlarge" }, { "value": "c5.2xlarge", "name": "c5_2xlarge" }, { "value": "c5.4xlarge", "name": "c5_4xlarge" }, { "value": "c5.9xlarge", "name": "c5_9xlarge" }, { "value": "c5.12xlarge", "name": "c5_12xlarge" }, { "value": "c5.18xlarge", "name": "c5_18xlarge" }, { "value": "c5.24xlarge", "name": "c5_24xlarge" }, { "value": "c5a.large", "name": "c5a_large" }, { "value": "c5a.xlarge", "name": "c5a_xlarge" }, { "value": "c5a.2xlarge", "name": "c5a_2xlarge" }, { "value": "c5a.4xlarge", "name": "c5a_4xlarge" }, { "value": "c5a.8xlarge", "name": "c5a_8xlarge" }, { "value": "c5a.12xlarge", "name": "c5a_12xlarge" }, { "value": "c5a.16xlarge", "name": "c5a_16xlarge" }, { "value": "c5a.24xlarge", "name": "c5a_24xlarge" }, { "value": "r4.large", "name": "r4_large" }, { "value": "r4.xlarge", "name": "r4_xlarge" }, { "value": "r4.2xlarge", "name": "r4_2xlarge" }, { "value": "r4.4xlarge", "name": "r4_4xlarge" }, { "value": "r4.8xlarge", "name": "r4_8xlarge" }, { "value": "r4.16xlarge", "name": "r4_16xlarge" }, { "value": "r5.large", "name": "r5_large" }, { "value": "r5.xlarge", "name": "r5_xlarge" }, { "value": "r5.2xlarge", "name": "r5_2xlarge" }, { "value": "r5.4xlarge", "name": "r5_4xlarge" }, { "value": "r5.8xlarge", "name": "r5_8xlarge" }, { "value": "r5.12xlarge", "name": "r5_12xlarge" }, { "value": "r5.16xlarge", "name": "r5_16xlarge" }, { "value": "r5.24xlarge", "name": "r5_24xlarge" }, { "value": "r5a.large", "name": "r5a_large" }, { "value": "r5a.xlarge", "name": "r5a_xlarge" }, { "value": "r5a.2xlarge", "name": "r5a_2xlarge" }, { "value": "r5a.4xlarge", "name": "r5a_4xlarge" }, { "value": "r5a.8xlarge", "name": "r5a_8xlarge" }, { "value": "r5a.12xlarge", "name": "r5a_12xlarge" }, { "value": "r5a.16xlarge", "name": "r5a_16xlarge" }, { "value": "r5a.24xlarge", "name": "r5a_24xlarge" }, { "value": "m4.large", "name": "m4_large" }, { "value": "m4.xlarge", "name": "m4_xlarge" }, { "value": "m4.2xlarge", "name": "m4_2xlarge" }, { "value": "m4.4xlarge", "name": "m4_4xlarge" }, { "value": "m4.10xlarge", "name": "m4_10xlarge" }, { "value": "m5.large", "name": "m5_large" }, { "value": "m5.xlarge", "name": "m5_xlarge" }, { "value": "m5.2xlarge", "name": "m5_2xlarge" }, { "value": "m5.4xlarge", "name": "m5_4xlarge" }, { "value": "m5.8xlarge", "name": "m5_8xlarge" }, { "value": "m5.12xlarge", "name": "m5_12xlarge" }, { "value": "m5.16xlarge", "name": "m5_16xlarge" }, { "value": "m5.24xlarge", "name": "m5_24xlarge" }, { "value": "m5a.large", "name": "m5a_large" }, { "value": "m5a.xlarge", "name": "m5a_xlarge" }, { "value": "m5a.2xlarge", "name": "m5a_2xlarge" }, { "value": "m5a.4xlarge", "name": "m5a_4xlarge" }, { "value": "m5a.8xlarge", "name": "m5a_8xlarge" }, { "value": "m5a.12xlarge", "name": "m5a_12xlarge" }, { "value": "m5a.16xlarge", "name": "m5a_16xlarge" }, { "value": "m5a.24xlarge", "name": "m5a_24xlarge" } ] } }, "com.amazonaws.gamelift#GameServerGroupName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9-\\.]+" } }, "com.amazonaws.gamelift#GameServerGroupNameOrArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "[a-zA-Z0-9-\\.]+|^arn:.*:gameservergroup\\/[a-zA-Z0-9-\\.]+" } }, "com.amazonaws.gamelift#GameServerGroupStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "NEW", "name": "NEW" }, { "value": "ACTIVATING", "name": "ACTIVATING" }, { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "DELETE_SCHEDULED", "name": "DELETE_SCHEDULED" }, { "value": "DELETING", "name": "DELETING" }, { "value": "DELETED", "name": "DELETED" }, { "value": "ERROR", "name": "ERROR" } ] } }, "com.amazonaws.gamelift#GameServerGroups": { "type": "list", "member": { "target": "com.amazonaws.gamelift#GameServerGroup" } }, "com.amazonaws.gamelift#GameServerHealthCheck": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "HEALTHY", "name": "HEALTHY" } ] } }, "com.amazonaws.gamelift#GameServerId": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9-\\.]+" } }, "com.amazonaws.gamelift#GameServerInstance": { "type": "structure", "members": { "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupName", "traits": { "smithy.api#documentation": "A developer-defined identifier for the game server group that includes the game\n server instance. The name is unique for each Region in each AWS account.
" } }, "GameServerGroupArn": { "target": "com.amazonaws.gamelift#GameServerGroupArn", "traits": { "smithy.api#documentation": "A generated unique identifier for the game server group that includes the game\n server instance.
" } }, "InstanceId": { "target": "com.amazonaws.gamelift#GameServerInstanceId", "traits": { "smithy.api#documentation": "The unique identifier for the instance where the game server is running. This ID is\n available in the instance metadata. EC2 instance IDs \n use a 17-character format, for example: i-1234567890abcdef0.
\n Current status of the game server instance. \n
\n\n ACTIVE -- The instance is viable for hosting \n game servers.
\n\n DRAINING -- The instance is not viable for\n hosting game servers. Existing game servers are in the process of ending, and\n new game servers are not started on this instance unless no other resources are\n available. When the instance is put in DRAINING, a new instance is started up to \n replace it. Once the instance has no UTILIZED game servers, it will be terminated \n in favor of the new instance.
\n\n SPOT_TERMINATING -- The instance is in the\n process of shutting down due to a Spot instance interruption. No new game\n servers are started on this instance.
\n\n This data type is used with the GameLift FleetIQ and game server groups.\n
\n Additional properties, including status, that describe an EC2 instance in a game\n server group. Instance configurations are set with game server group properties (see\n DescribeGameServerGroup and with the EC2 launch template that was used\n when creating the game server group.
Retrieve game server instances for a game server group by calling\n DescribeGameServerInstances.
\n Related actions\n
\n\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#GameServerInstanceId": { "type": "string", "traits": { "smithy.api#length": { "min": 19, "max": 19 }, "smithy.api#pattern": "^i-[0-9a-zA-Z]{17}$" } }, "com.amazonaws.gamelift#GameServerInstanceIds": { "type": "list", "member": { "target": "com.amazonaws.gamelift#GameServerInstanceId" }, "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.gamelift#GameServerInstanceStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "DRAINING", "name": "DRAINING" }, { "value": "SPOT_TERMINATING", "name": "SPOT_TERMINATING" } ] } }, "com.amazonaws.gamelift#GameServerInstances": { "type": "list", "member": { "target": "com.amazonaws.gamelift#GameServerInstance" } }, "com.amazonaws.gamelift#GameServerProtectionPolicy": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "NO_PROTECTION", "name": "NO_PROTECTION" }, { "value": "FULL_PROTECTION", "name": "FULL_PROTECTION" } ] } }, "com.amazonaws.gamelift#GameServerUtilizationStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "AVAILABLE", "name": "AVAILABLE" }, { "value": "UTILIZED", "name": "UTILIZED" } ] } }, "com.amazonaws.gamelift#GameServers": { "type": "list", "member": { "target": "com.amazonaws.gamelift#GameServer" } }, "com.amazonaws.gamelift#GameSession": { "type": "structure", "members": { "GameSessionId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for the game session. A game session ARN has the following format: \n arn:aws:gamelift:.
A descriptive label that is associated with a game session. Session names do not need to be unique.
" } }, "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "A unique identifier for the fleet that the game session is running on.
" } }, "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { "smithy.api#documentation": "\n The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on. \n
" } }, "CreationTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { "smithy.api#documentation": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Number of players currently in the game session.
" } }, "MaximumPlayerSessionCount": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The maximum number of players that can be connected simultaneously to the game session.
" } }, "Status": { "target": "com.amazonaws.gamelift#GameSessionStatus", "traits": { "smithy.api#documentation": "Current status of the game session. A game session must have an ACTIVE\n status to have player sessions.
Provides additional information about game session status. INTERRUPTED\n indicates that the game session was hosted on a spot instance that was reclaimed,\n causing the active game session to be terminated.
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 \n GameSession object with a request to start a new game session. You can search for active game sessions based on this custom data\n with SearchGameSessions.
" } }, "IpAddress": { "target": "com.amazonaws.gamelift#IpAddress", "traits": { "smithy.api#documentation": "The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.
" } }, "DnsName": { "target": "com.amazonaws.gamelift#DnsName", "traits": { "smithy.api#documentation": "The DNS identifier assigned to the instance that is running the game session. Values have\n the following format:
\nTLS-enabled fleets:
Non-TLS-enabled fleets: ec2-. (See\n Amazon EC2 Instance IP Addressing.)
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
" } }, "Port": { "target": "com.amazonaws.gamelift#PortNumber", "traits": { "smithy.api#documentation": "The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.
" } }, "PlayerSessionCreationPolicy": { "target": "com.amazonaws.gamelift#PlayerSessionCreationPolicy", "traits": { "smithy.api#documentation": "Indicates whether or not the game session is accepting new players.
" } }, "CreatorId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for a player. This ID is used to enforce a resource protection policy (if one\n exists), that limits the number of game sessions a player can create.
" } }, "GameSessionData": { "target": "com.amazonaws.gamelift#LargeGameSessionData", "traits": { "smithy.api#documentation": "A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session.
" } }, "MatchmakerData": { "target": "com.amazonaws.gamelift#MatchmakerData", "traits": { "smithy.api#documentation": "Information about the matchmaking process that was used to create the game session.\n It is in JSON syntax, formatted as a string. In addition the matchmaking configuration\n used, it contains data on all players assigned to the match, including player attributes\n and team assignments. For more details on matchmaker data, see Match\n Data. Matchmaker data is useful when requesting match backfills, and is\n updated whenever new players are added during a successful backfill (see StartMatchBackfill).
" } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "The fleet location where the game session is running. This value might specify the\n fleet's home Region or a remote location. Location is expressed as an AWS Region code\n such as us-west-2.
Properties describing a game session.
\nA game session in ACTIVE status can host players. When a game session ends, its\n status is set to TERMINATED.
Once the session ends, the game session object is retained for 30 days. This means\n you can reuse idempotency token values after this time. Game session logs are retained\n for 14 days.
\n\n Related actions\n
\n\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#GameSessionActivationTimeoutSeconds": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 600 } } }, "com.amazonaws.gamelift#GameSessionConnectionInfo": { "type": "structure", "members": { "GameSessionArn": { "target": "com.amazonaws.gamelift#ArnStringModel", "traits": { "smithy.api#documentation": "A unique identifier for the game session. Use the game session ID.
" } }, "IpAddress": { "target": "com.amazonaws.gamelift#StringModel", "traits": { "smithy.api#documentation": "The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.
" } }, "DnsName": { "target": "com.amazonaws.gamelift#DnsName", "traits": { "smithy.api#documentation": "The DNS identifier assigned to the instance that is running the game session. Values have\n the following format:
\nTLS-enabled fleets:
Non-TLS-enabled fleets: ec2-. (See\n Amazon EC2 Instance IP Addressing.)
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
" } }, "Port": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#documentation": "The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.
" } }, "MatchedPlayerSessions": { "target": "com.amazonaws.gamelift#MatchedPlayerSessionList", "traits": { "smithy.api#documentation": "A collection of player session IDs, one for each player ID that was included in the\n original matchmaking request.
" } } }, "traits": { "smithy.api#documentation": "Connection information for a new game session that is created in response to a StartMatchmaking request. Once a match is made, the FlexMatch engine\n creates a new game session for it. This information, including the game session endpoint\n and player sessions for each player in the original matchmaking request, is added to the\n MatchmakingTicket, which can be retrieved by calling DescribeMatchmaking.
" } }, "com.amazonaws.gamelift#GameSessionData": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 } } }, "com.amazonaws.gamelift#GameSessionDetail": { "type": "structure", "members": { "GameSession": { "target": "com.amazonaws.gamelift#GameSession", "traits": { "smithy.api#documentation": "Object that describes a game session.
" } }, "ProtectionPolicy": { "target": "com.amazonaws.gamelift#ProtectionPolicy", "traits": { "smithy.api#documentation": "Current status of protection for the game session.
\n\n NoProtection -- The game session can be\n terminated during a scale-down event.
\n\n FullProtection -- If the game session is in an\n ACTIVE status, it cannot be terminated during a scale-down\n event.
A game session's properties plus the protection policy currently in\n force.
" } }, "com.amazonaws.gamelift#GameSessionDetailList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#GameSessionDetail" } }, "com.amazonaws.gamelift#GameSessionFullException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.gamelift#NonEmptyString" } }, "traits": { "smithy.api#documentation": "The game instance is currently full and cannot allow the requested player(s) to\n join. Clients can retry such requests immediately or after a waiting period.
", "smithy.api#error": "client" } }, "com.amazonaws.gamelift#GameSessionList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#GameSession" } }, "com.amazonaws.gamelift#GameSessionPlacement": { "type": "structure", "members": { "PlacementId": { "target": "com.amazonaws.gamelift#IdStringModel", "traits": { "smithy.api#documentation": "A unique identifier for a game session placement.
" } }, "GameSessionQueueName": { "target": "com.amazonaws.gamelift#GameSessionQueueName", "traits": { "smithy.api#documentation": "A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
" } }, "Status": { "target": "com.amazonaws.gamelift#GameSessionPlacementState", "traits": { "smithy.api#documentation": "Current status of the game session placement request.
\n\n PENDING -- The placement request is currently\n in the queue waiting to be processed.
\n\n FULFILLED -- A new game session and player\n sessions (if requested) have been successfully created. Values for\n GameSessionArn and\n GameSessionRegion are available.
\n\n CANCELLED -- The placement request was canceled\n with a call to StopGameSessionPlacement.
\n\n TIMED_OUT -- A new game session was not\n successfully created before the time limit expired. You can resubmit the\n placement request as needed.
\n\n FAILED -- GameLift is not able to complete the \n process of placing the game session. Common reasons are the \n game session terminated before the placement process was completed, or an unexpected\n internal error.
\nA set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).
" } }, "MaximumPlayerSessionCount": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The maximum number of players that can be connected simultaneously to the game session.
" } }, "GameSessionName": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A descriptive label that is associated with a game session. Session names do not need to be unique.
" } }, "GameSessionId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for the game session. This value is set once the new game session is placed (placement status is\n FULFILLED).
Identifier for the game session created by this placement request. This value is\n set once the new game session is placed (placement status is FULFILLED).\n This identifier is unique across all Regions. You can use this value as a\n GameSessionId value as needed.
Name of the Region where the game session created by this placement request is\n running. This value is set once the new game session is placed (placement status is\n FULFILLED).
A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions.
" } }, "StartTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { "smithy.api#documentation": "Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Time stamp indicating when this request was completed, canceled, or timed\n out.
" } }, "IpAddress": { "target": "com.amazonaws.gamelift#IpAddress", "traits": { "smithy.api#documentation": "The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is\n FULFILLED).
The DNS identifier assigned to the instance that is running the game session. Values have\n the following format:
\nTLS-enabled fleets:
Non-TLS-enabled fleets: ec2-. (See\n Amazon EC2 Instance IP Addressing.)
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
" } }, "Port": { "target": "com.amazonaws.gamelift#PortNumber", "traits": { "smithy.api#documentation": "The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is\n FULFILLED).
A collection of information on player sessions created in response to the game\n session placement request. These player sessions are created only once a new game\n session is successfully placed (placement status is FULFILLED). This\n information includes the player ID (as provided in the placement request) and the\n corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).
" } }, "MatchmakerData": { "target": "com.amazonaws.gamelift#MatchmakerData", "traits": { "smithy.api#documentation": "Information on the matchmaking process for this game. Data is in JSON syntax,\n formatted as a string. It identifies the matchmaking configuration used to create the\n match, and contains data on all players assigned to the match, including player\n attributes and team assignments. For more details on matchmaker data, see Match\n Data.
" } } }, "traits": { "smithy.api#documentation": "Object that describes a StartGameSessionPlacement request. This\n object includes the full details of the original request plus the current status and\n start/end time stamps.
\nGame session placement-related operations include:
\nA descriptive label that is associated with game session queue. Queue names must be unique within each Region.
" } }, "GameSessionQueueArn": { "target": "com.amazonaws.gamelift#GameSessionQueueArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:. In a GameLift game session queue ARN, the resource ID matches the\n Name value.
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.
A set of policies that act as a sliding cap on player latency. FleetIQ works to\n deliver low latency for most players in a game session. These policies ensure that no\n individual player can be placed into a game with unreasonably high latency. Use multiple\n policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their\n maximum allowed latency, starting with the lowest value.
" } }, "Destinations": { "target": "com.amazonaws.gamelift#GameSessionQueueDestinationList", "traits": { "smithy.api#documentation": "A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. \n Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
" } }, "FilterConfiguration": { "target": "com.amazonaws.gamelift#FilterConfiguration", "traits": { "smithy.api#documentation": "A list of locations where a queue is allowed to place new game sessions. Locations \n are specified in the form of AWS Region codes, such as us-west-2. If this parameter is \n not set, game sessions can be placed in any queue location.
Custom settings to use when prioritizing destinations and locations for game session placements. This \n configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly \n named will be automatically applied at the end of the prioritization process.
" } }, "CustomEventData": { "target": "com.amazonaws.gamelift#QueueCustomEventData", "traits": { "smithy.api#documentation": "\n Information that is added to all events that are related to this game session queue.\n
" } }, "NotificationTarget": { "target": "com.amazonaws.gamelift#QueueSnsArnStringModel", "traits": { "smithy.api#documentation": "An SNS topic ARN that is set up to receive game session placement notifications. See \n Setting up notifications for game session placement.
" } } }, "traits": { "smithy.api#documentation": "Configuration for a game session placement mechanism that processes requests for new\n game sessions. A queue can be used on its own or as part of a matchmaking\n solution.
\n\n Related actions\n
\n\n CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue\n
" } }, "com.amazonaws.gamelift#GameSessionQueueArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^arn:.*:gamesessionqueue\\/[a-zA-Z0-9-]+" } }, "com.amazonaws.gamelift#GameSessionQueueDestination": { "type": "structure", "members": { "DestinationArn": { "target": "com.amazonaws.gamelift#ArnStringModel", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which\n include a fleet ID or alias ID and a Region name, provide a unique identifier across all\n Regions.
" } } }, "traits": { "smithy.api#documentation": "A fleet or alias designated in a game session queue. Queues fulfill requests for new\n game sessions by placing a new game session on any of the queue's destinations.
\nDestinations are part of a GameSessionQueue.
" } }, "com.amazonaws.gamelift#GameSessionQueueDestinationList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#GameSessionQueueDestination" } }, "com.amazonaws.gamelift#GameSessionQueueList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#GameSessionQueue" } }, "com.amazonaws.gamelift#GameSessionQueueName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9-]+" } }, "com.amazonaws.gamelift#GameSessionQueueNameOrArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "[a-zA-Z0-9-]+|^arn:.*:gamesessionqueue\\/[a-zA-Z0-9-]+" } }, "com.amazonaws.gamelift#GameSessionQueueNameOrArnList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#GameSessionQueueNameOrArn" } }, "com.amazonaws.gamelift#GameSessionStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "ACTIVATING", "name": "ACTIVATING" }, { "value": "TERMINATED", "name": "TERMINATED" }, { "value": "TERMINATING", "name": "TERMINATING" }, { "value": "ERROR", "name": "ERROR" } ] } }, "com.amazonaws.gamelift#GameSessionStatusReason": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "INTERRUPTED", "name": "INTERRUPTED" } ] } }, "com.amazonaws.gamelift#GetGameSessionLogUrl": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#GetGameSessionLogUrlInput" }, "output": { "target": "com.amazonaws.gamelift#GetGameSessionLogUrlOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves the location of stored game session logs for a specified game session.\n When a game session is terminated, GameLift automatically stores the logs in Amazon S3 and\n retains them for 14 days. Use this URL to download the logs.
\nSee the AWS Service\n Limits page for maximum log file sizes. Log files that exceed this limit\n are not saved.
\n\n Related actions\n
\n\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#GetGameSessionLogUrlInput": { "type": "structure", "members": { "GameSessionId": { "target": "com.amazonaws.gamelift#ArnStringModel", "traits": { "smithy.api#documentation": "A unique identifier for the game session to get logs for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#GetGameSessionLogUrlOutput": { "type": "structure", "members": { "PreSignedUrl": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "Location of the requested game session logs, available for download. This URL is\n valid for 15 minutes, after which S3 will reject any download request using this URL.\n You can request a new URL any time within the 14-day period that the logs are\n retained.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#GetInstanceAccess": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#GetInstanceAccessInput" }, "output": { "target": "com.amazonaws.gamelift#GetInstanceAccessOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Requests remote access to a fleet instance. Remote access is useful for debugging,\n gathering benchmarking data, or observing activity in real time.
\nTo remotely access an instance, you need credentials that match the operating system\n of the instance. For a Windows instance, GameLift returns a user name and password as\n strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift\n returns a user name and RSA private key, also as strings, for use with an SSH client.\n The private key must be saved in the proper format to a .pem file before\n using. If you're making this request using the AWS CLI, saving the secret can be handled\n as part of the GetInstanceAccess request, as shown in one of the examples\n for this operation.
To request access to a specific instance, specify the IDs of both the instance and the\n fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. If successful, an InstanceAccess\n object is returned that contains the instance's IP address and a set of\n credentials.
\n\n Learn more\n
\n\n Remotely Access Fleet\n Instances\n
\n\n Debug Fleet\n Issues\n
\n \n\n Related actions\n
\n\n DescribeInstances | \n GetInstanceAccess | \n DescribeEC2InstanceLimits | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#GetInstanceAccessInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet that contains the instance you want access to. You can use either the fleet ID\n or ARN value. The fleet can be in any of the following statuses:\n ACTIVATING, ACTIVE, or ERROR. Fleets with an\n ERROR status may be accessible for a short time before they are\n deleted.
A unique identifier for the instance you want to get access to. You can access an instance in any\n status.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#GetInstanceAccessOutput": { "type": "structure", "members": { "InstanceAccess": { "target": "com.amazonaws.gamelift#InstanceAccess", "traits": { "smithy.api#documentation": "The connection information for a fleet instance, including IP\n address and access credentials.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#IamRoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^arn:.*:role\\/[\\w+=,.@-]+" } }, "com.amazonaws.gamelift#IdStringModel": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 48 }, "smithy.api#pattern": "[a-zA-Z0-9-]+" } }, "com.amazonaws.gamelift#IdempotentParameterMismatchException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.gamelift#NonEmptyString" } }, "traits": { "smithy.api#documentation": "A game session with this custom ID string already exists in this fleet. Resolve\n this conflict before retrying this request.
", "smithy.api#error": "client" } }, "com.amazonaws.gamelift#Instance": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "A unique identifier for the fleet that the instance is in.
" } }, "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:.
A unique identifier for the instance.
" } }, "IpAddress": { "target": "com.amazonaws.gamelift#IpAddress", "traits": { "smithy.api#documentation": "IP address that is assigned to the instance.
" } }, "DnsName": { "target": "com.amazonaws.gamelift#DnsName", "traits": { "smithy.api#documentation": "The DNS identifier assigned to the instance that is running the game session. Values have\n the following format:
\nTLS-enabled fleets:
Non-TLS-enabled fleets: ec2-. (See\n Amazon EC2 Instance IP Addressing.)
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
" } }, "OperatingSystem": { "target": "com.amazonaws.gamelift#OperatingSystem", "traits": { "smithy.api#documentation": "Operating system that is running on this instance.
" } }, "Type": { "target": "com.amazonaws.gamelift#EC2InstanceType", "traits": { "smithy.api#documentation": "EC2 instance type that defines the computing resources of this instance.\n
" } }, "Status": { "target": "com.amazonaws.gamelift#InstanceStatus", "traits": { "smithy.api#documentation": "Current status of the instance. Possible statuses include the following:
\n\n PENDING -- The instance is in the process of\n being created and launching server processes as defined in the fleet's run-time\n configuration.
\n\n ACTIVE -- The instance has been successfully\n created and at least one server process has successfully launched and reported\n back to GameLift that it is ready to host a game session. The instance is now\n considered ready to host game sessions.
\n\n TERMINATING -- The instance is in the process\n of shutting down. This may happen to reduce capacity during a scaling down event\n or to recycle resources in the event of a problem.
\nA time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
The fleet location of the instance, expressed as an AWS Region\n code, such as us-west-2.
Represents an EC2 instance of virtual computing resources that hosts one or more game\n servers. In GameLift, a fleet can contain zero or more instances.
\n\n Related actions\n
\n\n DescribeInstances\n
" } }, "com.amazonaws.gamelift#InstanceAccess": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "A unique identifier for the fleet containing the instance being accessed.
" } }, "InstanceId": { "target": "com.amazonaws.gamelift#InstanceId", "traits": { "smithy.api#documentation": "A unique identifier for the instance being accessed.
" } }, "IpAddress": { "target": "com.amazonaws.gamelift#IpAddress", "traits": { "smithy.api#documentation": "IP address that is assigned to the instance.
" } }, "OperatingSystem": { "target": "com.amazonaws.gamelift#OperatingSystem", "traits": { "smithy.api#documentation": "Operating system that is running on the instance.
" } }, "Credentials": { "target": "com.amazonaws.gamelift#InstanceCredentials", "traits": { "smithy.api#documentation": "Credentials required to access the instance.
" } } }, "traits": { "smithy.api#documentation": "Information required to remotely connect to a fleet instance. Access is requested\n by calling GetInstanceAccess.
" } }, "com.amazonaws.gamelift#InstanceCredentials": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { "smithy.api#documentation": "User login string.
" } }, "Secret": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { "smithy.api#documentation": "Secret string. For Windows instances, the secret is a password for use with Windows\n Remote Desktop. For Linux instances, it is a private key (which must be saved as a\n .pem file) for use with SSH.
Set of credentials required to remotely access a fleet instance. Access credentials\n are requested by calling GetInstanceAccess and returned in an InstanceAccess object.
", "smithy.api#sensitive": {} } }, "com.amazonaws.gamelift#InstanceDefinition": { "type": "structure", "members": { "InstanceType": { "target": "com.amazonaws.gamelift#GameServerGroupInstanceType", "traits": { "smithy.api#documentation": "An EC2 instance type designation.
", "smithy.api#required": {} } }, "WeightedCapacity": { "target": "com.amazonaws.gamelift#WeightedCapacity", "traits": { "smithy.api#documentation": "Instance weighting that indicates how much this instance type contributes to the total\n capacity of a game server group. Instance weights are used by GameLift FleetIQ to calculate the\n instance type's cost per unit hour and better identify the most cost-effective options.\n For detailed information on weighting instance capacity, see Instance\n Weighting in the Amazon EC2 Auto Scaling User Guide.\n Default value is \"1\".
" } } }, "traits": { "smithy.api#documentation": "\n This data type is used with the GameLift FleetIQ and game server groups.\n
\nAn allowed instance type for a GameServerGroup. All game server groups must have at least two\n instance types defined for it. GameLift FleetIQ periodically evaluates each defined instance type\n for viability. It then updates the Auto Scaling group with the list of viable instance\n types.
" } }, "com.amazonaws.gamelift#InstanceDefinitions": { "type": "list", "member": { "target": "com.amazonaws.gamelift#InstanceDefinition" }, "traits": { "smithy.api#length": { "min": 2, "max": 20 } } }, "com.amazonaws.gamelift#InstanceId": { "type": "string", "traits": { "smithy.api#pattern": "[a-zA-Z0-9\\.-]+" } }, "com.amazonaws.gamelift#InstanceList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#Instance" } }, "com.amazonaws.gamelift#InstanceStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "PENDING", "name": "PENDING" }, { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "TERMINATING", "name": "TERMINATING" } ] } }, "com.amazonaws.gamelift#Integer": { "type": "integer" }, "com.amazonaws.gamelift#InternalServiceException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.gamelift#NonEmptyString" } }, "traits": { "smithy.api#documentation": "The service encountered an unrecoverable internal failure while processing the\n request. Clients can retry such requests immediately or after a waiting\n period.
", "smithy.api#error": "server" } }, "com.amazonaws.gamelift#InvalidFleetStatusException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.gamelift#NonEmptyString" } }, "traits": { "smithy.api#documentation": "The requested operation would cause a conflict with the current state of a resource\n associated with the request and/or the fleet. Resolve the conflict before\n retrying.
", "smithy.api#error": "client" } }, "com.amazonaws.gamelift#InvalidGameSessionStatusException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.gamelift#NonEmptyString" } }, "traits": { "smithy.api#documentation": "The requested operation would cause a conflict with the current state of a resource\n associated with the request and/or the game instance. Resolve the conflict before\n retrying.
", "smithy.api#error": "client" } }, "com.amazonaws.gamelift#InvalidRequestException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.gamelift#NonEmptyString" } }, "traits": { "smithy.api#documentation": "One or more parameter values in the request are invalid. Correct the invalid\n parameter values before retrying.
", "smithy.api#error": "client" } }, "com.amazonaws.gamelift#IpAddress": { "type": "string" }, "com.amazonaws.gamelift#IpPermission": { "type": "structure", "members": { "FromPort": { "target": "com.amazonaws.gamelift#PortNumber", "traits": { "smithy.api#documentation": "A starting value for a range of allowed port numbers.
", "smithy.api#required": {} } }, "ToPort": { "target": "com.amazonaws.gamelift#PortNumber", "traits": { "smithy.api#documentation": "An ending value for a range of allowed port numbers. Port numbers are end-inclusive.\n This value must be higher than FromPort.
A range of allowed IP addresses. This value must be expressed in CIDR notation.\n Example: \"000.000.000.000/[subnet mask]\" or optionally the shortened\n version \"0.0.0.0/[subnet mask]\".
The network communication protocol used by the fleet.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A range of IP addresses and port settings that allow inbound traffic to connect to\n server processes on an instance in a fleet. New game sessions are assigned an IP\n address/port number combination, which must fall into the fleet's allowed ranges. Fleets\n with custom game builds must have permissions explicitly set. For Realtime Servers fleets, GameLift\n automatically opens two port ranges, one for TCP messaging and one for UDP.
\n\n Related actions\n
\n\n DescribeFleetPortSettings\n
" } }, "com.amazonaws.gamelift#IpPermissionsList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#IpPermission" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.gamelift#IpProtocol": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "TCP", "name": "TCP" }, { "value": "UDP", "name": "UDP" } ] } }, "com.amazonaws.gamelift#LargeGameSessionData": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 262144 } } }, "com.amazonaws.gamelift#LatencyMap": { "type": "map", "key": { "target": "com.amazonaws.gamelift#NonEmptyString" }, "value": { "target": "com.amazonaws.gamelift#PositiveInteger" } }, "com.amazonaws.gamelift#LaunchTemplateId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]+" } }, "com.amazonaws.gamelift#LaunchTemplateName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9\\(\\)\\.\\-/_]+" } }, "com.amazonaws.gamelift#LaunchTemplateSpecification": { "type": "structure", "members": { "LaunchTemplateId": { "target": "com.amazonaws.gamelift#LaunchTemplateId", "traits": { "smithy.api#documentation": "A unique identifier for an existing EC2 launch template.
" } }, "LaunchTemplateName": { "target": "com.amazonaws.gamelift#LaunchTemplateName", "traits": { "smithy.api#documentation": "A readable identifier for an existing EC2 launch template.
" } }, "Version": { "target": "com.amazonaws.gamelift#LaunchTemplateVersion", "traits": { "smithy.api#documentation": "The version of the EC2 launch template to use. If no version is specified, the\n default version will be used. With Amazon EC2, you can specify a default version for a\n launch template. If none is set, the default is the first version created.
" } } }, "traits": { "smithy.api#documentation": "\n This data type is used with the GameLift FleetIQ and game server groups.\n
\nAn EC2 launch template that contains configuration settings and game server code to\n be deployed to all instances in a game server group. The launch template is specified\n when creating a new game server group with CreateGameServerGroup.
" } }, "com.amazonaws.gamelift#LaunchTemplateVersion": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]+" } }, "com.amazonaws.gamelift#LimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.gamelift#NonEmptyString" } }, "traits": { "smithy.api#documentation": "The requested operation would cause the resource to exceed the allowed service\n limit. Resolve the issue before retrying.
", "smithy.api#error": "client" } }, "com.amazonaws.gamelift#ListAliases": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#ListAliasesInput" }, "output": { "target": "com.amazonaws.gamelift#ListAliasesOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves all aliases for this AWS account. You can filter the result set by\n alias name and/or routing strategy type. Use the pagination parameters to retrieve\n results in sequential pages.
\nReturned aliases are not listed in any particular order.
\n\n Related actions\n
\n\n CreateAlias | \n ListAliases | \n DescribeAlias | \n UpdateAlias | \n DeleteAlias | \n ResolveAlias | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#ListAliasesInput": { "type": "structure", "members": { "RoutingStrategyType": { "target": "com.amazonaws.gamelift#RoutingStrategyType", "traits": { "smithy.api#documentation": "The routing type to filter results on. Use this parameter to retrieve only aliases\n with a certain routing type. To retrieve all aliases, leave this parameter empty.
\nPossible routing types include the following:
\n\n SIMPLE -- The alias resolves to one specific\n fleet. Use this type when routing to active fleets.
\n\n TERMINAL -- The alias does not resolve to a\n fleet but instead can be used to display a message to the user. A terminal alias\n throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.
\nA descriptive label that is associated with an alias. Alias names do not need to be unique.
" } }, "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#ListAliasesOutput": { "type": "structure", "members": { "Aliases": { "target": "com.amazonaws.gamelift#AliasList", "traits": { "smithy.api#documentation": "A collection of alias resources that match the request parameters.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#ListBuilds": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#ListBuildsInput" }, "output": { "target": "com.amazonaws.gamelift#ListBuildsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves build resources for all builds associated with the AWS account in use. You\n can limit results to builds that are in a specific status by using the\n Status parameter. Use the pagination parameters to retrieve results in\n a set of sequential pages.
Build resources are not listed in any particular order.
\n\n Learn more\n
\n\n \n Upload a Custom Server Build\n
\n\n Related actions\n
\n\n CreateBuild | \n ListBuilds | \n DescribeBuild | \n UpdateBuild | \n DeleteBuild | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#ListBuildsInput": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.gamelift#BuildStatus", "traits": { "smithy.api#documentation": "Build status to filter results by. To retrieve all builds, leave this parameter\n empty.
\nPossible build statuses include the following:
\n\n INITIALIZED -- A new build has been defined,\n but no files have been uploaded. You cannot create fleets for builds that are in\n this status. When a build is successfully created, the build status is set to\n this value.
\n\n READY -- The game build has been successfully\n uploaded. You can now create new fleets for this build.
\n\n FAILED -- The game build upload failed. You\n cannot create new fleets for this build.
\nThe maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#ListBuildsOutput": { "type": "structure", "members": { "Builds": { "target": "com.amazonaws.gamelift#BuildList", "traits": { "smithy.api#documentation": "A collection of build resources that match the request.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#ListFleets": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#ListFleetsInput" }, "output": { "target": "com.amazonaws.gamelift#ListFleetsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves a collection of fleet resources in an AWS Region. You can call this operation\n to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor specify a Region in your\n request. You can filter the result set to find only those fleets that are deployed with\n a specific build or script. For fleets that have multiple locations, this operation\n retrieves fleets based on their home Region only.
\nThis operation can be used in the following ways:
\nTo get a list of all fleets in a Region, don't provide a build or script\n identifier.
\nTo get a list of all fleets where a specific custom game build is deployed,\n provide the build ID.
\nTo get a list of all Realtime Servers fleets with a specific configuration script,\n provide the script ID.
\nUse the pagination parameters to retrieve results as a set of sequential pages.
\nIf successful, a list of fleet IDs that match the request parameters is returned. A\n NextToken value is also returned if there are more result pages to retrieve.
\nFleet resources are not listed in a particular order.
\n\n Learn more\n
\n\n Setting up GameLift fleets\n
\n\n Related actions\n
\n\n CreateFleet | \n UpdateFleetCapacity | \n PutScalingPolicy | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetLocationAttributes | \n UpdateFleetAttributes | \n StopFleetActions | \n DeleteFleet | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#ListFleetsInput": { "type": "structure", "members": { "BuildId": { "target": "com.amazonaws.gamelift#BuildIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a\n specified build. Use either the build ID or ARN value.
" } }, "ScriptId": { "target": "com.amazonaws.gamelift#ScriptIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a\n specified script. Use either the script ID or ARN value.
" } }, "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#ListFleetsOutput": { "type": "structure", "members": { "FleetIds": { "target": "com.amazonaws.gamelift#FleetIdList", "traits": { "smithy.api#documentation": "A set of fleet IDs that match the list request. \n You can retrieve additional information about all \n returned fleets by passing this result set to a DescribeFleetAttributes, DescribeFleetCapacity, or\n DescribeFleetUtilization call.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#ListGameServerGroups": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#ListGameServerGroupsInput" }, "output": { "target": "com.amazonaws.gamelift#ListGameServerGroupsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "\n This operation is used with the GameLift FleetIQ solution and game server groups.\n
\nRetrieves information on all game servers groups that exist in the current AWS\n account for the selected Region. Use the pagination parameters to retrieve results in a\n set of sequential segments.
\n\n Learn more\n
\n \n\n Related actions\n
\n\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#ListGameServerGroupsInput": { "type": "structure", "members": { "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } } } }, "com.amazonaws.gamelift#ListGameServerGroupsOutput": { "type": "structure", "members": { "GameServerGroups": { "target": "com.amazonaws.gamelift#GameServerGroups", "traits": { "smithy.api#documentation": "A collection of game server group objects that match the request.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } } }, "com.amazonaws.gamelift#ListGameServers": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#ListGameServersInput" }, "output": { "target": "com.amazonaws.gamelift#ListGameServersOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "\n This operation is used with the GameLift FleetIQ solution and game server groups.\n
\nRetrieves information on all game servers that are currently active in a specified\n game server group. You can opt to sort the list by game server age. Use the\n pagination parameters to retrieve results in a set of sequential segments.
\n\n Learn more\n
\n \n\n Related actions\n
\n\n RegisterGameServer | \n ListGameServers | \n ClaimGameServer | \n DescribeGameServer | \n UpdateGameServer | \n DeregisterGameServer | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#ListGameServersInput": { "type": "structure", "members": { "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { "smithy.api#documentation": "An identifier for the game server group to retrieve a list of game servers from. \n Use either the GameServerGroup name or ARN value.
", "smithy.api#required": {} } }, "SortOrder": { "target": "com.amazonaws.gamelift#SortOrder", "traits": { "smithy.api#documentation": "Indicates how to sort the returned data based on game server registration timestamp.\n Use ASCENDING to retrieve oldest game servers first, or use\n DESCENDING to retrieve newest game servers first. If this parameter is\n left empty, game servers are returned in no particular order.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } } } }, "com.amazonaws.gamelift#ListGameServersOutput": { "type": "structure", "members": { "GameServers": { "target": "com.amazonaws.gamelift#GameServers", "traits": { "smithy.api#documentation": "A collection of game server objects that match the request.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } } }, "com.amazonaws.gamelift#ListScripts": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#ListScriptsInput" }, "output": { "target": "com.amazonaws.gamelift#ListScriptsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves script records for all Realtime scripts that are associated with the AWS account in use.
\n\n Learn more\n
\n\n Amazon GameLift Realtime Servers\n
\n\n Related actions\n
\n\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#ListScriptsInput": { "type": "structure", "members": { "Limit": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#documentation": "The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } } } }, "com.amazonaws.gamelift#ListScriptsOutput": { "type": "structure", "members": { "Scripts": { "target": "com.amazonaws.gamelift#ScriptList", "traits": { "smithy.api#documentation": "A set of properties describing the requested script.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } } }, "com.amazonaws.gamelift#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.gamelift#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#TaggingFailedException" } ], "traits": { "smithy.api#documentation": "\n Retrieves all tags that are assigned to a GameLift resource. \n Resource tags are used to organize AWS resources for a range of purposes. \n This operation handles the permissions necessary to manage tags for the following \n GameLift resource types:
\nBuild
\nScript
\nFleet
\nAlias
\nGameSessionQueue
\nMatchmakingConfiguration
\nMatchmakingRuleSet
\nTo list tags for a resource, specify the unique ARN value for the resource.
\n\n Learn more\n
\n\n Tagging AWS Resources in the\n AWS General Reference\n
\n\n \n AWS Tagging Strategies\n
\n\n Related actions\n
\n\n TagResource | \n UntagResource | \n ListTagsForResource | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.gamelift#AmazonResourceName", "traits": { "smithy.api#documentation": "\n The Amazon Resource Name \n (ARN)\n that is assigned to and uniquely identifies the GameLift resource that you want to retrieve\n tags for. GameLift resource ARNs are included in the data object for the resource, which \n can be retrieved by calling a List or Describe operation for the resource type.
", "smithy.api#required": {} } } } }, "com.amazonaws.gamelift#ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.gamelift#TagList", "traits": { "smithy.api#documentation": "\n The collection of tags that have been assigned to the specified resource.\n
" } } } }, "com.amazonaws.gamelift#LocationAttributes": { "type": "structure", "members": { "LocationState": { "target": "com.amazonaws.gamelift#LocationState", "traits": { "smithy.api#documentation": "A fleet location and its current life-cycle state.
" } }, "StoppedActions": { "target": "com.amazonaws.gamelift#FleetActionList", "traits": { "smithy.api#documentation": "A list of fleet actions that have been suspended in the fleet location.
" } }, "UpdateStatus": { "target": "com.amazonaws.gamelift#LocationUpdateStatus", "traits": { "smithy.api#documentation": "The status of fleet activity updates to the location. The status\n PENDING_UPDATE indicates that StopFleetActions or StartFleetActions\n has been requested but the update has not yet been completed for the location.
Represents a location in a multi-location fleet.
\n\n Related actions\n
\n\n DescribeFleetLocationAttributes \n
" } }, "com.amazonaws.gamelift#LocationAttributesList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#LocationAttributes" } }, "com.amazonaws.gamelift#LocationConfiguration": { "type": "structure", "members": { "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "An AWS Region code, such as us-west-2.
A remote location where a multi-location fleet can deploy EC2 instances for game\n hosting.
\n\n Related actions\n
\n\n CreateFleet\n
" } }, "com.amazonaws.gamelift#LocationConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#LocationConfiguration" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.gamelift#LocationList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#LocationStringModel" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.gamelift#LocationState": { "type": "structure", "members": { "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "The fleet location, expressed as an AWS Region code such as us-west-2.
The life-cycle status of a fleet location.
" } } }, "traits": { "smithy.api#documentation": "A fleet location and its life-cycle state. A location state object might\n be used to describe a fleet's remote location or home Region.\n Life-cycle state tracks the progress of launching the first instance in a new \n location and preparing it for game hosting, and then removing all instances and\n deleting the location from the fleet.
\n\n Related actions\n
\n\n CreateFleet | \n CreateFleetLocations |\n DeleteFleetLocations\n
" } }, "com.amazonaws.gamelift#LocationStateList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#LocationState" } }, "com.amazonaws.gamelift#LocationStringModel": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-z]+(-([a-z]+|\\d))*" } }, "com.amazonaws.gamelift#LocationUpdateStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "PENDING_UPDATE", "name": "PENDING_UPDATE" } ] } }, "com.amazonaws.gamelift#MatchedPlayerSession": { "type": "structure", "members": { "PlayerId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for a player
" } }, "PlayerSessionId": { "target": "com.amazonaws.gamelift#PlayerSessionId", "traits": { "smithy.api#documentation": "A unique identifier for a player session
" } } }, "traits": { "smithy.api#documentation": "Represents a new player session that is created as a result of a successful FlexMatch\n match. A successful match automatically creates new player sessions for every player ID\n in the original matchmaking request.
\nWhen players connect to the match's game session, they must include both player ID\n and player session ID in order to claim their assigned player slot.
" } }, "com.amazonaws.gamelift#MatchedPlayerSessionList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#MatchedPlayerSession" } }, "com.amazonaws.gamelift#MatchmakerData": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 390000 } } }, "com.amazonaws.gamelift#MatchmakingAcceptanceTimeoutInteger": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 600 } } }, "com.amazonaws.gamelift#MatchmakingConfiguration": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { "smithy.api#documentation": "A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a\n matchmaking request or ticket.
" } }, "ConfigurationArn": { "target": "com.amazonaws.gamelift#MatchmakingConfigurationArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift matchmaking configuration resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:. In a GameLift configuration ARN, the resource ID matches the\n Name value.
A descriptive label that is associated with matchmaking configuration.
" } }, "GameSessionQueueArns": { "target": "com.amazonaws.gamelift#QueueArnsList", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:. Queues can be located in any Region. Queues are used to start new\n GameLift-hosted game sessions for matches that are created with this matchmaking\n configuration. This property is not set when FlexMatchMode is set to\n STANDALONE.
The maximum duration, in seconds, that a matchmaking ticket can remain in process\n before timing out. Requests that fail due to timing out can be resubmitted as\n needed.
" } }, "AcceptanceTimeoutSeconds": { "target": "com.amazonaws.gamelift#MatchmakingAcceptanceTimeoutInteger", "traits": { "smithy.api#documentation": "The length of time (in seconds) to wait for players to accept a proposed match, if\n acceptance is required. If any player rejects the match or fails to accept before the\n timeout, the ticket continues to look for an acceptable match.
" } }, "AcceptanceRequired": { "target": "com.amazonaws.gamelift#BooleanModel", "traits": { "smithy.api#documentation": "A flag that indicates whether a match that was created with this configuration must be\n accepted by the matched players. To require acceptance, set to TRUE. When this option is\n enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate\n when a completed potential match is waiting for player acceptance.
A unique identifier for the matchmaking rule set to use with this configuration. A matchmaking configuration can only use\n rule sets that are defined in the same Region.
" } }, "RuleSetArn": { "target": "com.amazonaws.gamelift#MatchmakingRuleSetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.
" } }, "NotificationTarget": { "target": "com.amazonaws.gamelift#SnsArnStringModel", "traits": { "smithy.api#documentation": "An SNS topic ARN that is set up to receive matchmaking notifications.
" } }, "AdditionalPlayerCount": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies \n a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used when FlexMatchMode is set to\n STANDALONE.
Information to attach to all events related to the matchmaking configuration.
" } }, "CreationTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { "smithy.api#documentation": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
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 \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession\n object that is created for a successful match. This parameter is not used when\n FlexMatchMode is set to STANDALONE.
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n 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\n that is created for a successful match. This parameter is not used when\n FlexMatchMode is set to STANDALONE.
The method used to backfill game sessions created with this matchmaking configuration.\n MANUAL indicates that the game makes backfill requests or does not use the match\n backfill feature. AUTOMATIC indicates that GameLift creates StartMatchBackfill requests whenever a game session has one or more open\n slots. Learn more about manual and automatic backfill in Backfill existing games\n with FlexMatch. Automatic backfill is not available when\n FlexMatchMode is set to STANDALONE.
Indicates whether this matchmaking configuration is being used with GameLift hosting or\n as a standalone matchmaking solution.
\n\n STANDALONE - FlexMatch forms matches and returns\n match information, including players and team assignments, in a \n \n MatchmakingSucceeded event.
\n\n WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift queue to\n start a game session for the match.
\nGuidelines for use with FlexMatch to match players into games. All matchmaking\n requests must specify a matchmaking configuration.
" } }, "com.amazonaws.gamelift#MatchmakingConfigurationArn": { "type": "string", "traits": { "smithy.api#documentation": "Data type used for Matchmaking Configuration ARN.", "smithy.api#pattern": "^arn:.*:matchmakingconfiguration\\/[a-zA-Z0-9-\\.]*" } }, "com.amazonaws.gamelift#MatchmakingConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#MatchmakingConfiguration" } }, "com.amazonaws.gamelift#MatchmakingConfigurationName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "[a-zA-Z0-9-\\.]*|^arn:.*:matchmakingconfiguration\\/[a-zA-Z0-9-\\.]*" } }, "com.amazonaws.gamelift#MatchmakingConfigurationNameList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#MatchmakingConfigurationName" } }, "com.amazonaws.gamelift#MatchmakingConfigurationStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CANCELLED", "name": "CANCELLED" }, { "value": "COMPLETED", "name": "COMPLETED" }, { "value": "FAILED", "name": "FAILED" }, { "value": "PLACING", "name": "PLACING" }, { "value": "QUEUED", "name": "QUEUED" }, { "value": "REQUIRES_ACCEPTANCE", "name": "REQUIRES_ACCEPTANCE" }, { "value": "SEARCHING", "name": "SEARCHING" }, { "value": "TIMED_OUT", "name": "TIMED_OUT" } ] } }, "com.amazonaws.gamelift#MatchmakingIdList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel" } }, "com.amazonaws.gamelift#MatchmakingIdStringModel": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9-\\.]*" } }, "com.amazonaws.gamelift#MatchmakingRequestTimeoutInteger": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 43200 } } }, "com.amazonaws.gamelift#MatchmakingRuleSet": { "type": "structure", "members": { "RuleSetName": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { "smithy.api#documentation": "A unique identifier for the matchmaking rule set
" } }, "RuleSetArn": { "target": "com.amazonaws.gamelift#MatchmakingRuleSetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:. In a GameLift rule set ARN, the resource ID matches the\n RuleSetName value.
A collection of matchmaking rules, formatted as a JSON string. Comments are not\n allowed in JSON, but most elements support a description field.
", "smithy.api#required": {} } }, "CreationTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { "smithy.api#documentation": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Set of rule statements, used with FlexMatch, that determine how to build your player\n matches. Each rule set describes a type of group to be created and defines the\n parameters for acceptable player matches. Rule sets are used in MatchmakingConfiguration objects.
\nA rule set may define the following elements for a match. For detailed information\n and examples showing how to construct a rule set, see Build a FlexMatch rule\n set.
\nTeams -- Required. A rule set must define one or multiple teams for the\n match and set minimum and maximum team sizes. For example, a rule set might\n describe a 4x4 match that requires all eight slots to be filled.
\nPlayer attributes -- Optional. These attributes specify a set of player\n characteristics to evaluate when looking for a match. Matchmaking requests that\n use a rule set with player attributes must provide the corresponding attribute\n values. For example, an attribute might specify a player's skill or\n level.
\nRules -- Optional. Rules define how to evaluate potential players for a\n match based on player attributes. A rule might specify minimum requirements for\n individual players, teams, or entire matches. For example, a rule might require\n each player to meet a certain skill level, each team to have at least one player\n in a certain role, or the match to have a minimum average skill level. or may\n describe an entire group--such as all teams must be evenly matched or have at\n least one player in a certain role.
\nExpansions -- Optional. Expansions allow you to relax the rules after a\n period of time when no acceptable matches are found. This feature lets you\n balance getting players into games in a reasonable amount of time instead of\n making them wait indefinitely for the best possible match. For example, you\n might use an expansion to increase the maximum skill variance between players\n after 30 seconds.
\nA unique identifier for a matchmaking ticket.
" } }, "ConfigurationName": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { "smithy.api#documentation": "Name of the MatchmakingConfiguration that is used with this\n ticket. Matchmaking configurations determine how players are grouped into a match and\n how a new game session is created for the match.
" } }, "ConfigurationArn": { "target": "com.amazonaws.gamelift#MatchmakingConfigurationArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the GameLift matchmaking configuration resource that is used with this ticket.
" } }, "Status": { "target": "com.amazonaws.gamelift#MatchmakingConfigurationStatus", "traits": { "smithy.api#documentation": "Current status of the matchmaking request.
\n\n QUEUED -- The matchmaking request has been\n received and is currently waiting to be processed.
\n\n SEARCHING -- The matchmaking request is\n currently being processed.
\n\n REQUIRES_ACCEPTANCE -- A match has been\n proposed and the players must accept the match (see AcceptMatch). This status is used only with requests that use a matchmaking configuration\n with a player acceptance requirement.
\n\n PLACING -- The FlexMatch engine has matched\n players and is in the process of placing a new game session for the\n match.
\n\n COMPLETED -- Players have been matched and a\n game session is ready to host the players. A ticket in this state contains the\n necessary connection information for players.
\n\n FAILED -- The matchmaking request was not\n completed.
\n\n CANCELLED -- The matchmaking request was\n canceled. This may be the result of a call to StopMatchmaking\n or a proposed match that one or more players failed to accept.
\n\n TIMED_OUT -- The matchmaking request was not\n successful within the duration specified in the matchmaking configuration.\n
\nMatchmaking requests that fail to successfully complete (statuses FAILED,\n CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket\n IDs.
\nCode to explain the current status. For example, a status reason may indicate when\n a ticket has returned to SEARCHING status after a proposed match fails to\n receive player acceptances.
Additional information about the current status.
" } }, "StartTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { "smithy.api#documentation": "Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Time stamp indicating when this matchmaking request stopped being processed due to\n success, failure, or cancellation. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
A set of Player objects, each representing a player to find matches\n for. Players are identified by a unique player ID and may include latency data for use\n during matchmaking. If the ticket is in status COMPLETED, the\n Player objects include the team the players were assigned to in the\n resulting match.
Identifier and connection information of the game session created for the match. This\n information is added to the ticket only after the matchmaking request has been\n successfully completed. This parameter is not set when FlexMatch is being used without\n GameLift hosting.
" } }, "EstimatedWaitTime": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "Average amount of time (in seconds) that players are currently waiting for a match.\n If there is not enough recent data, this property may be empty.
" } } }, "traits": { "smithy.api#documentation": "Ticket generated to track the progress of a matchmaking request. Each ticket is\n uniquely identified by a ticket ID, supplied by the requester, when creating a\n matchmaking request with StartMatchmaking. Tickets can be retrieved by\n calling DescribeMatchmaking with the ticket ID.
" } }, "com.amazonaws.gamelift#MatchmakingTicketList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#MatchmakingTicket" } }, "com.amazonaws.gamelift#MaxConcurrentGameSessionActivations": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 2147483647 } } }, "com.amazonaws.gamelift#MetricGroup": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.gamelift#MetricGroupList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#MetricGroup" }, "traits": { "smithy.api#length": { "min": 0, "max": 1 } } }, "com.amazonaws.gamelift#MetricName": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ActivatingGameSessions", "name": "ActivatingGameSessions" }, { "value": "ActiveGameSessions", "name": "ActiveGameSessions" }, { "value": "ActiveInstances", "name": "ActiveInstances" }, { "value": "AvailableGameSessions", "name": "AvailableGameSessions" }, { "value": "AvailablePlayerSessions", "name": "AvailablePlayerSessions" }, { "value": "CurrentPlayerSessions", "name": "CurrentPlayerSessions" }, { "value": "IdleInstances", "name": "IdleInstances" }, { "value": "PercentAvailableGameSessions", "name": "PercentAvailableGameSessions" }, { "value": "PercentIdleInstances", "name": "PercentIdleInstances" }, { "value": "QueueDepth", "name": "QueueDepth" }, { "value": "WaitTime", "name": "WaitTime" } ] } }, "com.amazonaws.gamelift#NonBlankAndLengthConstraintString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.gamelift#NonBlankString": { "type": "string", "traits": { "smithy.api#pattern": "[^\\s]+" } }, "com.amazonaws.gamelift#NonEmptyString": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.gamelift#NonNegativeDouble": { "type": "double", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0 } } }, "com.amazonaws.gamelift#NonZeroAndMaxString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.gamelift#NotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.gamelift#NonEmptyString" } }, "traits": { "smithy.api#documentation": "A service resource associated with the request could not be found. Clients should\n not retry such requests.
", "smithy.api#error": "client" } }, "com.amazonaws.gamelift#OperatingSystem": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "WINDOWS_2012", "name": "WINDOWS_2012" }, { "value": "AMAZON_LINUX", "name": "AMAZON_LINUX" }, { "value": "AMAZON_LINUX_2", "name": "AMAZON_LINUX_2" } ] } }, "com.amazonaws.gamelift#OutOfCapacityException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.gamelift#NonEmptyString" } }, "traits": { "smithy.api#documentation": "The specified game server group has no available game servers to fulfill a\n ClaimGameServer request. Clients can retry such requests immediately\n or after a waiting period.\n \n
A unique identifier for a player that is associated with this player session.
" } }, "PlayerSessionId": { "target": "com.amazonaws.gamelift#PlayerSessionId", "traits": { "smithy.api#documentation": "A unique identifier for a player session.
" } } }, "traits": { "smithy.api#documentation": "Information about a player session that was created as part of a StartGameSessionPlacement request. This object contains only the player\n ID and player session ID. To retrieve full details on a player session, call DescribePlayerSessions with the player session ID.
\n\n Related actions\n
\n\n CreatePlayerSession | \n CreatePlayerSessions | \n DescribePlayerSessions | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#PlacedPlayerSessionList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#PlacedPlayerSession" } }, "com.amazonaws.gamelift#Player": { "type": "structure", "members": { "PlayerId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for a player
" } }, "PlayerAttributes": { "target": "com.amazonaws.gamelift#PlayerAttributeMap", "traits": { "smithy.api#documentation": "A collection of key:value pairs containing player information for use in matchmaking.\n Player attribute keys must match the playerAttributes used in a\n matchmaking rule set. Example: \"PlayerAttributes\": {\"skill\": {\"N\": \"23\"},\n \"gameMode\": {\"S\": \"deathmatch\"}}.
Name of the team that the player is assigned to in a match. Team names are defined\n in a matchmaking rule set.
" } }, "LatencyInMs": { "target": "com.amazonaws.gamelift#LatencyMap", "traits": { "smithy.api#documentation": "A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions. If this property is present, FlexMatch considers placing the match only\n in Regions for which latency is reported.
\nIf a matchmaker has a rule that evaluates player latency, players must report\n latency in order to be matched. If no latency is reported in this scenario, FlexMatch\n assumes that no Regions are available to the player and the ticket is not matchable.\n
" } } }, "traits": { "smithy.api#documentation": "Represents a player in matchmaking. When starting a matchmaking request, a player\n has a player ID, attributes, and may have latency data. Team information is added after\n a match has been successfully completed.
" } }, "com.amazonaws.gamelift#PlayerAttributeMap": { "type": "map", "key": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString" }, "value": { "target": "com.amazonaws.gamelift#AttributeValue" } }, "com.amazonaws.gamelift#PlayerData": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.gamelift#PlayerDataMap": { "type": "map", "key": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString" }, "value": { "target": "com.amazonaws.gamelift#PlayerData" } }, "com.amazonaws.gamelift#PlayerIdList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString" }, "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.gamelift#PlayerLatency": { "type": "structure", "members": { "PlayerId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for a player associated with the latency data.
" } }, "RegionIdentifier": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "Name of the Region that is associated with the latency value.
" } }, "LatencyInMilliseconds": { "target": "com.amazonaws.gamelift#Float", "traits": { "smithy.api#documentation": "Amount of time that represents the time lag experienced by the player when\n connected to the specified Region.
" } } }, "traits": { "smithy.api#documentation": "Regional latency information for a player, used when requesting a new game session\n with StartGameSessionPlacement. This value indicates the amount of\n time lag that exists when the player is connected to a fleet in the specified Region.\n The relative difference between a player's latency values for multiple Regions are used\n to determine which fleets are best suited to place a new game session for the player.\n
" } }, "com.amazonaws.gamelift#PlayerLatencyList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#PlayerLatency" } }, "com.amazonaws.gamelift#PlayerLatencyPolicy": { "type": "structure", "members": { "MaximumIndividualPlayerLatencyMilliseconds": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The maximum latency value that is allowed for any player, in milliseconds. All\n policies must have a value set for this property.
" } }, "PolicyDurationSeconds": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The length of time, in seconds, that the policy is enforced while placing a new\n game session. A null value for this property means that the policy is enforced until the\n queue times out.
" } } }, "traits": { "smithy.api#documentation": "Sets a latency cap for individual players when placing a game session. With a latency\n policy in force, a game session cannot be placed in a fleet location where a player\n reports latency higher than the cap. Latency policies are used only with placement\n request that provide player latency information. Player latency policies can be stacked\n to gradually relax latency requirements over time.
\nLatency policies are part of a GameSessionQueue.
" } }, "com.amazonaws.gamelift#PlayerLatencyPolicyList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#PlayerLatencyPolicy" } }, "com.amazonaws.gamelift#PlayerList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#Player" } }, "com.amazonaws.gamelift#PlayerSession": { "type": "structure", "members": { "PlayerSessionId": { "target": "com.amazonaws.gamelift#PlayerSessionId", "traits": { "smithy.api#documentation": "A unique identifier for a player session.
" } }, "PlayerId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for a player that is associated with this player session.
" } }, "GameSessionId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for the game session that the player session is connected to.
" } }, "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "A unique identifier for the fleet that the player's game session is running on.
" } }, "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { "smithy.api#documentation": "\n The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on. \n
" } }, "CreationTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { "smithy.api#documentation": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Current status of the player session.
\nPossible player session statuses include the following:
\n\n RESERVED -- The player session request has been\n received, but the player has not yet connected to the server process and/or been\n validated.
\n\n ACTIVE -- The player has been validated by the\n server process and is currently connected.
\n\n COMPLETED -- The player connection has been\n dropped.
\n\n TIMEDOUT -- A player session request was\n received, but the player did not connect and/or was not validated within the\n timeout limit (60 seconds).
\nThe IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.
" } }, "DnsName": { "target": "com.amazonaws.gamelift#DnsName", "traits": { "smithy.api#documentation": "The DNS identifier assigned to the instance that is running the game session. Values have\n the following format:
\nTLS-enabled fleets:
Non-TLS-enabled fleets: ec2-. (See\n Amazon EC2 Instance IP Addressing.)
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
" } }, "Port": { "target": "com.amazonaws.gamelift#PortNumber", "traits": { "smithy.api#documentation": "Port number for the game session. To connect to a Amazon GameLift server process, an app\n needs both the IP address and port number.
" } }, "PlayerData": { "target": "com.amazonaws.gamelift#PlayerData", "traits": { "smithy.api#documentation": "Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.
" } } }, "traits": { "smithy.api#documentation": "Represents a player session. Player sessions are created either for a specific game\n session, or as part of a game session placement or matchmaking request. A player session\n can represents a reserved player slot in a game session (when status is\n RESERVED) or actual player activity in a game session (when status is\n ACTIVE). A player session object, including player data, is\n automatically passed to a game session when the player connects to the game session and\n is validated. After the game session ends, player sessions information is retained for\n 30 days and then removed.
\n Related actions\n
\n\n CreatePlayerSession |\n CreatePlayerSessions |\n DescribePlayerSessions |\n StartGameSessionPlacement | \n DescribeGameSessionPlacement |\n All APIs by task\n
" } }, "com.amazonaws.gamelift#PlayerSessionCreationPolicy": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACCEPT_ALL", "name": "ACCEPT_ALL" }, { "value": "DENY_ALL", "name": "DENY_ALL" } ] } }, "com.amazonaws.gamelift#PlayerSessionId": { "type": "string", "traits": { "smithy.api#pattern": "^psess-\\S+" } }, "com.amazonaws.gamelift#PlayerSessionList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#PlayerSession" } }, "com.amazonaws.gamelift#PlayerSessionStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "RESERVED", "name": "RESERVED" }, { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "COMPLETED", "name": "COMPLETED" }, { "value": "TIMEDOUT", "name": "TIMEDOUT" } ] } }, "com.amazonaws.gamelift#PolicyType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "RuleBased", "name": "RuleBased" }, { "value": "TargetBased", "name": "TargetBased" } ] } }, "com.amazonaws.gamelift#PortNumber": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 60000 } } }, "com.amazonaws.gamelift#PositiveInteger": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.gamelift#PositiveLong": { "type": "long", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.gamelift#PriorityConfiguration": { "type": "structure", "members": { "PriorityOrder": { "target": "com.amazonaws.gamelift#PriorityTypeList", "traits": { "smithy.api#documentation": "The recommended sequence to use when prioritizing where to place new game sessions.\n Each type can only be listed once.
\n\n LATENCY -- FleetIQ prioritizes locations where the average player\n latency (provided in each game session request) is lowest.
\n COST -- FleetIQ prioritizes destinations with the lowest current\n hosting costs. Cost is evaluated based on the location, instance type, and fleet\n type (Spot or On-Demand) for each destination in the queue.
\n DESTINATION -- FleetIQ prioritizes based on the order that\n destinations are listed in the queue configuration.
\n LOCATION -- FleetIQ prioritizes based on the provided order of\n locations, as defined in LocationOrder.
The prioritization order to use for fleet locations, when the\n PriorityOrder property includes LOCATION. Locations are\n identified by AWS Region codes such as us-west-2. Each location can only be\n listed once.
Custom prioritization settings for use by a game session queue when placing new game\n sessions with available game servers. When defined, this configuration replaces the\n default FleetIQ prioritization process, which is as follows:
\nIf player latency data is included in a game session request, destinations and\n locations are prioritized first based on lowest average latency (1), then on\n lowest hosting cost (2), then on destination list order (3), and finally on\n location (alphabetical) (4). This approach ensures that the queue's top priority\n is to place game sessions where average player latency is lowest, and--if\n latency is the same--where the hosting cost is less, etc.
\nIf player latency data is not included, destinations and locations are\n prioritized first on destination list order (1), and then on location\n (alphabetical) (2). This approach ensures that the queue's top priority is to\n place game sessions on the first destination fleet listed. If that fleet has\n multiple locations, the game session is placed on the first location (when\n listed alphabetically).
\nChanging the priority order will affect how game sessions are placed.
\nPriority configurations are part of a GameSessionQueue.
" } }, "com.amazonaws.gamelift#PriorityType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "LATENCY", "name": "LATENCY" }, { "value": "COST", "name": "COST" }, { "value": "DESTINATION", "name": "DESTINATION" }, { "value": "LOCATION", "name": "LOCATION" } ] } }, "com.amazonaws.gamelift#PriorityTypeList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#PriorityType" }, "traits": { "smithy.api#length": { "min": 1, "max": 4 } } }, "com.amazonaws.gamelift#ProtectionPolicy": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "NoProtection", "name": "NoProtection" }, { "value": "FullProtection", "name": "FullProtection" } ] } }, "com.amazonaws.gamelift#PutScalingPolicy": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#PutScalingPolicyInput" }, "output": { "target": "com.amazonaws.gamelift#PutScalingPolicyOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Creates or updates a scaling policy for a fleet. Scaling policies are used to\n automatically scale a fleet's hosting capacity to meet player demand. An active scaling\n policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's\n capacity when a certain threshold is reached. There are two types of scaling policies:\n target-based and rule-based. Use a target-based policy to quickly and efficiently manage\n fleet scaling; this option is the most commonly used. Use rule-based policies when you\n need to exert fine-grained control over auto-scaling.
\nFleets can have multiple scaling policies of each type in force at the same time;\n you can have one target-based policy, one or multiple rule-based scaling policies, or\n both. We recommend caution, however, because multiple auto-scaling policies can have\n unintended consequences.
\nYou can temporarily suspend all scaling policies for a fleet by calling StopFleetActions with the fleet action AUTO_SCALING. To resume scaling\n policies, call StartFleetActions with the same fleet action. To stop\n just one scaling policy--or to permanently remove it, you must delete the policy with\n DeleteScalingPolicy.
\nLearn more about how to work with auto-scaling in Set Up Fleet Automatic\n Scaling.
\n\n Target-based policy\n
\nA target-based policy tracks a single metric: PercentAvailableGameSessions. This\n metric tells us how much of a fleet's hosting capacity is ready to host game sessions\n but is not currently in use. This is the fleet's buffer; it measures the additional\n player demand that the fleet could handle at current capacity. With a target-based\n policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action\n is needed to maintain that target.
\nFor example, you might choose to maintain a 10% buffer for a fleet that has the\n capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take\n action whenever the fleet's available capacity falls below or rises above 10 game\n sessions. Amazon GameLift will start new instances or stop unused instances in order to return\n to the 10% buffer.
\nTo create or update a target-based policy, specify a fleet ID and name, and set the\n policy type to \"TargetBased\". Specify the metric to track (PercentAvailableGameSessions)\n and reference a TargetConfiguration object with your desired buffer\n value. Exclude all other parameters. On a successful request, the policy name is\n returned. The scaling policy is automatically in force as soon as it's successfully\n created. If the fleet's auto-scaling actions are temporarily suspended, the new policy\n will be in force once the fleet actions are restarted.
\n\n Rule-based policy\n
\nA rule-based policy tracks specified fleet metric, sets a threshold value, and\n specifies the type of action to initiate when triggered. With a rule-based policy, you\n can select from several available fleet metrics. Each policy specifies whether to scale\n up or scale down (and by how much), so you need one policy for each type of action.
\nFor example, a policy may make the following statement: \"If the percentage of idle\n instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity\n by 10%.\"
\nA policy's rule statement has the following structure:
\nIf [MetricName] is [ComparisonOperator]\n [Threshold] for [EvaluationPeriods] minutes, then\n [ScalingAdjustmentType] to/by\n [ScalingAdjustment].
To implement the example, the rule statement would look like this:
\nIf [PercentIdleInstances] is [GreaterThanThreshold]\n [20] for [15] minutes, then\n [PercentChangeInCapacity] to/by [10].
To create or update a scaling policy, specify a unique combination of name and\n fleet ID, and set the policy type to \"RuleBased\". Specify the parameter values for a\n policy rule statement. On a successful request, the policy name is returned. Scaling\n policies are automatically in force as soon as they're successfully created. If the\n fleet's auto-scaling actions are temporarily suspended, the new policy will be in force\n once the fleet actions are restarted.
\n\n Related actions\n
\n\n DescribeFleetCapacity | \n UpdateFleetCapacity | \n DescribeEC2InstanceLimits | \n PutScalingPolicy | \n DescribeScalingPolicies | \n DeleteScalingPolicy | \n StopFleetActions | \n StartFleetActions | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#PutScalingPolicyInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.
", "smithy.api#required": {} } }, "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to apply this policy to. You can use either the fleet ID or ARN value. The fleet\n cannot be in any of the following statuses: ERROR or DELETING.
", "smithy.api#required": {} } }, "ScalingAdjustment": { "target": "com.amazonaws.gamelift#Integer", "traits": { "smithy.api#documentation": "Amount of adjustment to make, based on the scaling adjustment type.
" } }, "ScalingAdjustmentType": { "target": "com.amazonaws.gamelift#ScalingAdjustmentType", "traits": { "smithy.api#documentation": "The type of adjustment to make to a fleet's instance count (see FleetCapacity):
\n\n ChangeInCapacity -- add (or subtract) the\n scaling adjustment value from the current instance count. Positive values scale\n up while negative values scale down.
\n\n ExactCapacity -- set the instance count to the\n scaling adjustment value.
\n\n PercentChangeInCapacity -- increase or reduce\n the current instance count by the scaling adjustment, read as a percentage.\n Positive values scale up while negative values scale down; for example, a value\n of \"-10\" scales the fleet down by 10%.
\nMetric value used to trigger a scaling event.
" } }, "ComparisonOperator": { "target": "com.amazonaws.gamelift#ComparisonOperatorType", "traits": { "smithy.api#documentation": "Comparison operator to use when measuring the metric against the threshold\n value.
" } }, "EvaluationPeriods": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#documentation": "Length of time (in minutes) the metric must be at or beyond the threshold before a\n scaling event is triggered.
" } }, "MetricName": { "target": "com.amazonaws.gamelift#MetricName", "traits": { "smithy.api#documentation": "Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For\n detailed descriptions of fleet metrics, see Monitor Amazon GameLift\n with Amazon CloudWatch.
\n\n ActivatingGameSessions -- Game sessions in\n the process of being created.
\n\n ActiveGameSessions -- Game sessions that\n are currently running.
\n\n ActiveInstances -- Fleet instances that\n are currently running at least one game session.
\n\n AvailableGameSessions -- Additional game\n sessions that fleet could host simultaneously, given current capacity.
\n\n AvailablePlayerSessions -- Empty player\n slots in currently active game sessions. This includes game sessions that are\n not currently accepting players. Reserved player slots are not\n included.
\n\n CurrentPlayerSessions -- Player slots in\n active game sessions that are being used by a player or are reserved for a\n player.
\n\n IdleInstances -- Active instances that are\n currently hosting zero game sessions.
\n\n PercentAvailableGameSessions -- Unused\n percentage of the total number of game sessions that a fleet could host\n simultaneously, given current capacity. Use this metric for a target-based\n scaling policy.
\n\n PercentIdleInstances -- Percentage of the\n total number of active instances that are hosting zero game sessions.
\n\n QueueDepth -- Pending game session\n placement requests, in any queue, where the current fleet is the top-priority\n destination.
\n\n WaitTime -- Current wait time for pending\n game session placement requests, in any queue, where the current fleet is the\n top-priority destination.
\nThe type of scaling policy to create. For a target-based policy, set the parameter\n MetricName to 'PercentAvailableGameSessions' and specify a\n TargetConfiguration. For a rule-based policy set the following\n parameters: MetricName, ComparisonOperator,\n Threshold, EvaluationPeriods,\n ScalingAdjustmentType, and\n ScalingAdjustment.
" } }, "TargetConfiguration": { "target": "com.amazonaws.gamelift#TargetConfiguration", "traits": { "smithy.api#documentation": "An object that contains settings for a target-based scaling policy.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#PutScalingPolicyOutput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#QueueArnsList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#ArnStringModel" } }, "com.amazonaws.gamelift#QueueCustomEventData": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "[\\s\\S]*" } }, "com.amazonaws.gamelift#QueueSnsArnStringModel": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 300 }, "smithy.api#pattern": "[a-zA-Z0-9:_-]*(\\.fifo)?" } }, "com.amazonaws.gamelift#RegisterGameServer": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#RegisterGameServerInput" }, "output": { "target": "com.amazonaws.gamelift#RegisterGameServerOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#ConflictException" }, { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#LimitExceededException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "\n This operation is used with the GameLift FleetIQ solution and game server groups.\n
\nCreates a new game server resource and notifies GameLift FleetIQ that the game server is ready to\n host gameplay and players. This operation is called by a game server process that is\n running on an instance in a game server group. Registering game servers enables GameLift FleetIQ to\n track available game servers and enables game clients and services to claim a game\n server for a new game session.
\nTo register a game server, identify the game server group and instance where the game\n server is running, and provide a unique identifier for the game server. You can also\n include connection and game server data. When a game client or service requests a game\n server by calling ClaimGameServer, this information is returned in the\n response.
\nOnce a game server is successfully registered, it is put in status\n AVAILABLE. A request to register a game server may fail if the instance\n it is running on is in the process of shutting down as part of instance balancing or\n scale-down activity.
\n Learn more\n
\n \n\n Related actions\n
\n\n RegisterGameServer | \n ListGameServers | \n ClaimGameServer | \n DescribeGameServer | \n UpdateGameServer | \n DeregisterGameServer | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#RegisterGameServerInput": { "type": "structure", "members": { "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value.
", "smithy.api#required": {} } }, "GameServerId": { "target": "com.amazonaws.gamelift#GameServerId", "traits": { "smithy.api#documentation": "A custom string that uniquely identifies the game server to register. \n Game server IDs are developer-defined and must be unique across all game server groups in your AWS account.
", "smithy.api#required": {} } }, "InstanceId": { "target": "com.amazonaws.gamelift#GameServerInstanceId", "traits": { "smithy.api#documentation": "The unique identifier for the instance where the game server is running. This ID is\n available in the instance metadata. EC2 instance IDs \n use a 17-character format, for example: i-1234567890abcdef0.
Information that is needed to make inbound client connections to the game server. This\n might include the IP address and port, DNS name, and other information.
" } }, "GameServerData": { "target": "com.amazonaws.gamelift#GameServerData", "traits": { "smithy.api#documentation": "A set of custom game server properties, formatted as a single string value. This data \n is passed to a game client or service when it requests information on game servers using\n ListGameServers or ClaimGameServer.
" } } } }, "com.amazonaws.gamelift#RegisterGameServerOutput": { "type": "structure", "members": { "GameServer": { "target": "com.amazonaws.gamelift#GameServer", "traits": { "smithy.api#documentation": "Object that describes the newly registered game server.
" } } } }, "com.amazonaws.gamelift#RequestUploadCredentials": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#RequestUploadCredentialsInput" }, "output": { "target": "com.amazonaws.gamelift#RequestUploadCredentialsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves a fresh set of credentials for use when uploading a new set of game build\n files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see\n CreateBuild.
\nTo request new credentials, specify the build ID as returned with an initial\n CreateBuild request. If successful, a new set of credentials are\n returned, along with the S3 storage location associated with the build ID.
\n Learn more\n
\n\n \n Create a Build with Files in S3\n
\n\n Related actions\n
\n\n CreateBuild | \n ListBuilds | \n DescribeBuild | \n UpdateBuild | \n DeleteBuild | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#RequestUploadCredentialsInput": { "type": "structure", "members": { "BuildId": { "target": "com.amazonaws.gamelift#BuildIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the build to get credentials for. You can use either the build ID or ARN value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#RequestUploadCredentialsOutput": { "type": "structure", "members": { "UploadCredentials": { "target": "com.amazonaws.gamelift#AwsCredentials", "traits": { "smithy.api#documentation": "AWS credentials required when uploading a game build to the storage location.\n These credentials have a limited lifespan and are valid only for the build they were\n issued for.
" } }, "StorageLocation": { "target": "com.amazonaws.gamelift#S3Location", "traits": { "smithy.api#documentation": "Amazon S3 path and key, identifying where the game build files are\n stored.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#ResolveAlias": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#ResolveAliasInput" }, "output": { "target": "com.amazonaws.gamelift#ResolveAliasOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#TerminalRoutingStrategyException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves the fleet ID that an alias is currently pointing to.
\n\n Related actions\n
\n\n CreateAlias | \n ListAliases | \n DescribeAlias | \n UpdateAlias | \n DeleteAlias | \n ResolveAlias | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#ResolveAliasInput": { "type": "structure", "members": { "AliasId": { "target": "com.amazonaws.gamelift#AliasIdOrArn", "traits": { "smithy.api#documentation": "The unique identifier of the alias that you want to retrieve a fleet ID for. You can\n use either the alias ID or ARN value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#ResolveAliasOutput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "The fleet identifier that the alias is pointing to.
" } }, "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { "smithy.api#documentation": "\n The Amazon Resource Name (ARN) associated with the GameLift fleet resource that this alias points to. \n
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#ResourceCreationLimitPolicy": { "type": "structure", "members": { "NewGameSessionsPerCreator": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The maximum number of game sessions that an individual can create during the policy\n period.
" } }, "PolicyPeriodInMinutes": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The time span used in evaluating the resource creation limit policy.
" } } }, "traits": { "smithy.api#documentation": "A policy that puts limits on the number of game sessions that a player can create\n within a specified span of time. With this policy, you can control players' ability to\n consume available resources.
\nThe policy is evaluated when a player tries to create a new game session. On receiving\n a CreateGameSession request, GameLift checks that the player (identified by\n CreatorId) has created fewer than game session limit in the specified\n time period.
The resource creation limit policy is included in FleetAttributes.
" } }, "com.amazonaws.gamelift#ResumeGameServerGroup": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#ResumeGameServerGroupInput" }, "output": { "target": "com.amazonaws.gamelift#ResumeGameServerGroupOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "\n This operation is used with the GameLift FleetIQ solution and game server groups.\n
\nReinstates activity on a game server group after it has been suspended. A game server\n group might be suspended by theSuspendGameServerGroup operation, or it\n might be suspended involuntarily due to a configuration problem. In the second case, you\n can manually resume activity on the group once the configuration problem has been\n resolved. Refer to the game server group status and status reason for more information\n on why group activity is suspended.
\nTo resume activity, specify a game server group ARN and the type of activity to be\n resumed. If successful, a GameServerGroup object is returned showing\n that the resumed activity is no longer listed in SuspendedActions.
\n Learn more\n
\n \n\n Related actions\n
\n\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#ResumeGameServerGroupInput": { "type": "structure", "members": { "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
", "smithy.api#required": {} } }, "ResumeActions": { "target": "com.amazonaws.gamelift#GameServerGroupActions", "traits": { "smithy.api#documentation": "The activity to resume for this game server group.
", "smithy.api#required": {} } } } }, "com.amazonaws.gamelift#ResumeGameServerGroupOutput": { "type": "structure", "members": { "GameServerGroup": { "target": "com.amazonaws.gamelift#GameServerGroup", "traits": { "smithy.api#documentation": "An object that describes the game server group resource, with the\n SuspendedActions property updated to reflect the resumed\n activity.
The type of routing strategy for the alias.
\nPossible routing types include the following:
\n\n SIMPLE - The alias resolves to one specific\n fleet. Use this type when routing to active fleets.
\n\n TERMINAL - The alias does not resolve to a\n fleet but instead can be used to display a message to the user. A terminal alias\n throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.
\nA unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.
" } }, "Message": { "target": "com.amazonaws.gamelift#FreeText", "traits": { "smithy.api#documentation": "The message text to be used with a terminal routing strategy.
" } } }, "traits": { "smithy.api#documentation": "The routing configuration for a fleet alias.
\n\n Related actions\n
\n\n CreateAlias | \n ListAliases | \n DescribeAlias | \n UpdateAlias | \n DeleteAlias | \n ResolveAlias | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#RoutingStrategyType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SIMPLE", "name": "SIMPLE" }, { "value": "TERMINAL", "name": "TERMINAL" } ] } }, "com.amazonaws.gamelift#RuleSetBody": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 65535 } } }, "com.amazonaws.gamelift#RuleSetLimit": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 10 } } }, "com.amazonaws.gamelift#RuntimeConfiguration": { "type": "structure", "members": { "ServerProcesses": { "target": "com.amazonaws.gamelift#ServerProcessList", "traits": { "smithy.api#documentation": "A collection of server process configurations that identify what server processes to\n run on each instance in a fleet.
" } }, "MaxConcurrentGameSessionActivations": { "target": "com.amazonaws.gamelift#MaxConcurrentGameSessionActivations", "traits": { "smithy.api#documentation": "The number of game sessions in status ACTIVATING to allow on an instance.\n This setting limits the instance resources that can be used for new game activations at\n any one time.
The maximum amount of time (in seconds) allowed to launch a new game session and have\n it report ready to host players. During this time, the game session is in status\n ACTIVATING. If the game session does not become active before the\n timeout, it is ended and the game session status is changed to\n TERMINATED.
A collection of server process configurations that describe the set of processes to\n run on each instance in a fleet. Server processes run either an executable in a custom\n game build or a Realtime Servers script. GameLift launches the configured processes, manages their\n life cycle, and replaces them as needed. Each instance checks regularly for an updated\n runtime configuration.
\nA GameLift instance is limited to 50 processes running concurrently. To calculate the\n total number of processes in a runtime configuration, add the values of the\n ConcurrentExecutions parameter for each ServerProcess. Learn more about Running Multiple\n Processes on a Fleet.
\n Related actions\n
\n\n DescribeRuntimeConfiguration | UpdateRuntimeConfiguration\n
" } }, "com.amazonaws.gamelift#S3Location": { "type": "structure", "members": { "Bucket": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { "smithy.api#documentation": "An Amazon S3 bucket identifier. This is the name of the S3 bucket.
\nGameLift currently does not support uploading from Amazon S3 buckets with names that contain a dot (.).
\nThe name of the zip file that contains the build files or script files.
" } }, "RoleArn": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon GameLift to access the S3 bucket.
" } }, "ObjectVersion": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { "smithy.api#documentation": "The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses\n this information when retrieving files from an S3 bucket that you own. Use this\n parameter to specify a specific version of the file. If not set, the latest version of\n the file is retrieved.
" } } }, "traits": { "smithy.api#documentation": "The location in Amazon S3 where build or script files are stored for access by Amazon GameLift. This\n location is specified in CreateBuild, CreateScript,\n and UpdateScript requests.
" } }, "com.amazonaws.gamelift#ScalingAdjustmentType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ChangeInCapacity", "name": "ChangeInCapacity" }, { "value": "ExactCapacity", "name": "ExactCapacity" }, { "value": "PercentChangeInCapacity", "name": "PercentChangeInCapacity" } ] } }, "com.amazonaws.gamelift#ScalingPolicy": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "A unique identifier for the fleet that is associated with this scaling policy.
" } }, "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:.
A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
" } }, "Status": { "target": "com.amazonaws.gamelift#ScalingStatusType", "traits": { "smithy.api#documentation": "Current status of the scaling policy. The scaling policy can be in force only when\n in an ACTIVE status. Scaling policies can be suspended for individual\n fleets (see StopFleetActions; if suspended for a fleet, the policy\n status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.
\n ACTIVE -- The scaling policy can be used for\n auto-scaling a fleet.
\n\n UPDATE_REQUESTED -- A request to update the\n scaling policy has been received.
\n\n UPDATING -- A change is being made to the\n scaling policy.
\n\n DELETE_REQUESTED -- A request to delete the\n scaling policy has been received.
\n\n DELETING -- The scaling policy is being\n deleted.
\n\n DELETED -- The scaling policy has been\n deleted.
\n\n ERROR -- An error occurred in creating the\n policy. It should be removed and recreated.
\nAmount of adjustment to make, based on the scaling adjustment type.
" } }, "ScalingAdjustmentType": { "target": "com.amazonaws.gamelift#ScalingAdjustmentType", "traits": { "smithy.api#documentation": "The type of adjustment to make to a fleet's instance count (see FleetCapacity):
\n\n ChangeInCapacity -- add (or subtract) the\n scaling adjustment value from the current instance count. Positive values scale\n up while negative values scale down.
\n\n ExactCapacity -- set the instance count to the\n scaling adjustment value.
\n\n PercentChangeInCapacity -- increase or reduce\n the current instance count by the scaling adjustment, read as a percentage.\n Positive values scale up while negative values scale down.
\nComparison operator to use when measuring a metric against the threshold\n value.
" } }, "Threshold": { "target": "com.amazonaws.gamelift#Double", "traits": { "smithy.api#documentation": "Metric value used to trigger a scaling event.
" } }, "EvaluationPeriods": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#documentation": "Length of time (in minutes) the metric must be at or beyond the threshold before a\n scaling event is triggered.
" } }, "MetricName": { "target": "com.amazonaws.gamelift#MetricName", "traits": { "smithy.api#documentation": "Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For\n detailed descriptions of fleet metrics, see Monitor Amazon GameLift\n with Amazon CloudWatch.
\n\n ActivatingGameSessions -- Game sessions in\n the process of being created.
\n\n ActiveGameSessions -- Game sessions that\n are currently running.
\n\n ActiveInstances -- Fleet instances that\n are currently running at least one game session.
\n\n AvailableGameSessions -- Additional game\n sessions that fleet could host simultaneously, given current capacity.
\n\n AvailablePlayerSessions -- Empty player\n slots in currently active game sessions. This includes game sessions that are\n not currently accepting players. Reserved player slots are not\n included.
\n\n CurrentPlayerSessions -- Player slots in\n active game sessions that are being used by a player or are reserved for a\n player.
\n\n IdleInstances -- Active instances that are\n currently hosting zero game sessions.
\n\n PercentAvailableGameSessions -- Unused\n percentage of the total number of game sessions that a fleet could host\n simultaneously, given current capacity. Use this metric for a target-based\n scaling policy.
\n\n PercentIdleInstances -- Percentage of the\n total number of active instances that are hosting zero game sessions.
\n\n QueueDepth -- Pending game session\n placement requests, in any queue, where the current fleet is the top-priority\n destination.
\n\n WaitTime -- Current wait time for pending\n game session placement requests, in any queue, where the current fleet is the\n top-priority destination.
\nThe type of scaling policy to create. For a target-based policy, set the parameter\n MetricName to 'PercentAvailableGameSessions' and specify a\n TargetConfiguration. For a rule-based policy set the following\n parameters: MetricName, ComparisonOperator,\n Threshold, EvaluationPeriods,\n ScalingAdjustmentType, and\n ScalingAdjustment.
" } }, "TargetConfiguration": { "target": "com.amazonaws.gamelift#TargetConfiguration", "traits": { "smithy.api#documentation": "An object that contains settings for a target-based scaling policy.
" } }, "UpdateStatus": { "target": "com.amazonaws.gamelift#LocationUpdateStatus", "traits": { "smithy.api#documentation": "The current status of the fleet's scaling policies in a requested fleet location. The\n status PENDING_UPDATE indicates that an update was requested for the fleet \n but has not yet been completed for the location.
\n \n
" } } }, "traits": { "smithy.api#documentation": "Rule that controls how a fleet is scaled. Scaling policies are uniquely identified\n by the combination of name and fleet ID.
\n\n Related actions\n
\n\n DescribeFleetCapacity | \n UpdateFleetCapacity | \n DescribeEC2InstanceLimits | \n PutScalingPolicy | \n DescribeScalingPolicies | \n DeleteScalingPolicy | \n StopFleetActions | \n StartFleetActions | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#ScalingPolicyList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#ScalingPolicy" } }, "com.amazonaws.gamelift#ScalingStatusType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "UPDATE_REQUESTED", "name": "UPDATE_REQUESTED" }, { "value": "UPDATING", "name": "UPDATING" }, { "value": "DELETE_REQUESTED", "name": "DELETE_REQUESTED" }, { "value": "DELETING", "name": "DELETING" }, { "value": "DELETED", "name": "DELETED" }, { "value": "ERROR", "name": "ERROR" } ] } }, "com.amazonaws.gamelift#Script": { "type": "structure", "members": { "ScriptId": { "target": "com.amazonaws.gamelift#ScriptId", "traits": { "smithy.api#documentation": "A unique identifier for the Realtime script
" } }, "ScriptArn": { "target": "com.amazonaws.gamelift#ScriptArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the\n ScriptId value.
" } }, "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A descriptive label that is associated with a script. Script names do not need to be unique.
" } }, "Version": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "Version information that is associated with a build or script. Version strings do not need to be unique.
" } }, "SizeOnDisk": { "target": "com.amazonaws.gamelift#PositiveLong", "traits": { "smithy.api#documentation": "The file size of the uploaded Realtime script, expressed in bytes. When files are\n uploaded from an S3 location, this value remains at \"0\".
" } }, "CreationTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { "smithy.api#documentation": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Properties describing a Realtime script.
\n\n Related actions\n
\n\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#ScriptArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:.*:script\\/script-\\S+" } }, "com.amazonaws.gamelift#ScriptId": { "type": "string", "traits": { "smithy.api#pattern": "^script-\\S+" } }, "com.amazonaws.gamelift#ScriptIdOrArn": { "type": "string", "traits": { "smithy.api#pattern": "^script-\\S+|^arn:.*:script\\/script-\\S+" } }, "com.amazonaws.gamelift#ScriptList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#Script" } }, "com.amazonaws.gamelift#SearchGameSessions": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#SearchGameSessionsInput" }, "output": { "target": "com.amazonaws.gamelift#SearchGameSessionsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#TerminalRoutingStrategyException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Retrieves all active game sessions that match a set of search criteria and sorts them\n into a specified order.
\nWhen searching for game sessions, you specify exactly where you want to search and\n provide a search filter expression, a sort expression, or both. A search request can\n search only one fleet, but it can search all of a fleet's locations.
\nThis operation can be used in the following ways:
\nTo search all game sessions that are currently running on all locations in a\n fleet, provide a fleet or alias ID. This approach returns game sessions in the\n fleet's home Region and all remote locations that fit the search\n criteria.
\nTo search all game sessions that are currently running on a specific fleet\n location, provide a fleet or alias ID and a location name. For location, you can\n specify a fleet's home Region or any remote location.
\nUse the pagination parameters to retrieve results as a set of sequential pages.
\nIf successful, a GameSession object is returned for each game session\n that matches the request. Search finds game sessions that are in ACTIVE\n status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions.
You can search or sort by the following game session attributes:
\n\n gameSessionId -- A unique identifier for the game session. You can use\n either a GameSessionId or GameSessionArn value.\n
\n gameSessionName -- Name assigned to a game\n 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\n to a game session.
\n\n gameSessionProperties -- Custom data\n defined in a game session's GameProperty parameter.\n GameProperty values are stored as key:value pairs; the filter\n expression must indicate the key and a string to search the data values for. For\n example, to search for game sessions with custom data containing the key:value\n pair \"gameMode:brawl\", specify the following:\n gameSessionProperties.gameMode = \"brawl\". All custom data\n values are searched as strings.
\n maximumSessions -- Maximum number of\n player sessions allowed for a game session. This value is set when requesting a\n new game session with CreateGameSession or updating with UpdateGameSession.
\n\n creationTimeMillis -- Value indicating\n when a game session was created. It is expressed in Unix time as\n milliseconds.
\n\n playerSessionCount -- Number of players\n currently connected to a game session. This value changes rapidly as players\n join the session or drop out.
\n\n hasAvailablePlayerSessions -- Boolean\n value indicating whether a game session has reached its maximum number of\n players. It is highly recommended that all search requests include this filter\n attribute to optimize search performance and return only sessions that players\n can join.
\nReturned values for playerSessionCount and\n hasAvailablePlayerSessions change quickly as players join sessions\n and others drop out. Results should be considered a snapshot in time. Be sure to\n refresh search results often, and handle sessions that fill up before a player can\n join.
\n Related actions\n
\n\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" } } }, "com.amazonaws.gamelift#SearchGameSessionsInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to search for active game sessions. You can use either the fleet ID or ARN\n value. Each request must reference either a fleet ID or alias ID, but not both.
" } }, "AliasId": { "target": "com.amazonaws.gamelift#AliasIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the alias associated with the fleet to search for active game sessions. You can use either\n the alias ID or ARN value. Each request must reference either a fleet ID or alias ID,\n but not both.
" } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "A fleet location to search for game sessions. You can specify a fleet's home Region or\n a remote location. Use the AWS Region code format, such as us-west-2.
" } }, "FilterExpression": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "
String containing the search criteria for the session search. If no filter\n expression is included, the request returns results for all game sessions in the fleet\n that are in ACTIVE status.
A filter expression can contain one or multiple conditions. Each condition consists\n of the following:
\n\n Operand -- Name of a game session\n attribute. Valid values are gameSessionName,\n gameSessionId, gameSessionProperties,\n maximumSessions, creationTimeMillis,\n playerSessionCount,\n hasAvailablePlayerSessions.
\n Comparator -- Valid comparators are:\n =, <>, <, >,\n <=, >=.
\n Value -- Value to be searched for. Values\n may be numbers, boolean values (true/false) or strings depending on the operand.\n String values are case sensitive and must be enclosed in single quotes. Special\n characters must be escaped. Boolean and string values can only be used with the\n comparators = and <>. For example, the following\n filter expression searches on gameSessionName:\n \"FilterExpression\": \"gameSessionName = 'Matt\\\\'s Awesome Game\n 1'\".
To chain multiple conditions in a single expression, use the logical keywords\n AND, OR, and NOT and parentheses as needed.\n For example: x AND y AND NOT z, NOT (x OR y).
Session search evaluates conditions from left to right using the following\n precedence rules:
\n\n =, <>, <, >,\n <=, >=\n
Parentheses
\nNOT
\nAND
\nOR
\nFor example, this filter expression retrieves game sessions hosting at least ten\n players that have an open player slot: \"maximumSessions>=10 AND\n hasAvailablePlayerSessions=true\".
Instructions on how to sort the search results. If no sort expression is included,\n the request returns results in random order. A sort expression consists of the following\n elements:
\n\n Operand -- Name of a game session attribute.\n Valid values are gameSessionName, gameSessionId,\n gameSessionProperties, maximumSessions,\n creationTimeMillis, playerSessionCount,\n hasAvailablePlayerSessions.
\n Order -- Valid sort orders are ASC\n (ascending) and DESC (descending).
For example, this sort expression returns the oldest active sessions first:\n \"SortExpression\": \"creationTimeMillis ASC\". Results with a null value\n for the sort operand are returned at the end of the list.
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\n or is set higher than 20.
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.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#SearchGameSessionsOutput": { "type": "structure", "members": { "GameSessions": { "target": "com.amazonaws.gamelift#GameSessionList", "traits": { "smithy.api#documentation": "A collection of objects containing game session properties for each session that\n matches the request.
" } }, "NextToken": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#ServerProcess": { "type": "structure", "members": { "LaunchPath": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "The location of a game build executable or the Realtime script file that contains the\n Init() function. Game builds and Realtime scripts are installed on\n instances at the root:
Windows (custom game builds only): C:\\game. Example:\n \"C:\\game\\MyGame\\server.exe\"
Linux: /local/game. Examples: \"/local/game/MyGame/server.exe\" or\n \"/local/game/MyRealtimeScript.js\"
An optional list of parameters to pass to the server executable or Realtime script on\n launch.
" } }, "ConcurrentExecutions": { "target": "com.amazonaws.gamelift#PositiveInteger", "traits": { "smithy.api#documentation": "The number of server processes using this configuration that run concurrently on each\n instance.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A set of instructions for launching server processes on each instance in a fleet.\n Server processes run either an executable in a custom game build or a Realtime Servers script.\n Server process configurations are part of a fleet's RuntimeConfiguration.
" } }, "com.amazonaws.gamelift#ServerProcessList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#ServerProcess" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.gamelift#SnsArnStringModel": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 300 }, "smithy.api#pattern": "[a-zA-Z0-9:_/-]*(.fifo)?" } }, "com.amazonaws.gamelift#SortOrder": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ASCENDING", "name": "ASCENDING" }, { "value": "DESCENDING", "name": "DESCENDING" } ] } }, "com.amazonaws.gamelift#StartFleetActions": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#StartFleetActionsInput" }, "output": { "target": "com.amazonaws.gamelift#StartFleetActionsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. For multi-location fleets, fleet actions are managed\n separately for each location. Currently, this operation is used to restart a fleet's\n auto-scaling activity.
\nThis operation can be used in the following ways:
\nTo restart actions on instances in the fleet's home Region, provide a fleet ID\n and the type of actions to resume.
\nTo restart actions on instances in one of the fleet's remote locations,\n provide a fleet ID, a location name, and the type of actions to resume.
\nIf successful, GameLift once again initiates scaling events as triggered by the fleet's\n scaling policies. If actions on the fleet location were never stopped, this operation\n will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes or DescribeFleetLocationAttributes.
\n\n Learn more\n
\n\n Setting up GameLift fleets\n
\n\n Related actions\n
\n\n CreateFleet | \n UpdateFleetCapacity | \n PutScalingPolicy | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetLocationAttributes | \n UpdateFleetAttributes | \n StopFleetActions | \n DeleteFleet | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#StartFleetActionsInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to restart actions on. You can use either the fleet ID or ARN value.
", "smithy.api#required": {} } }, "Actions": { "target": "com.amazonaws.gamelift#FleetActionList", "traits": { "smithy.api#documentation": "List of actions to restart on the fleet.
", "smithy.api#required": {} } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "The fleet location to restart fleet actions for. Specify a location in the form of\n an AWS Region code, such as us-west-2.
Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#StartFleetActionsOutput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to restart actions on.
" } }, "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:.
Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#StartGameSessionPlacement": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#StartGameSessionPlacementInput" }, "output": { "target": "com.amazonaws.gamelift#StartGameSessionPlacementOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Places a request for a new game session in a queue (see CreateGameSessionQueue). When processing a placement request, Amazon GameLift\n searches for available resources on the queue's destinations, scanning each until it\n finds resources or the placement request times out.
\nA game session placement request can also request player sessions. When a new game\n session is successfully created, Amazon GameLift creates a player session for each player\n included in the request.
\nWhen placing a game session, by default Amazon GameLift tries each fleet in the order they\n are listed in the queue configuration. Ideally, a queue's destinations are listed in\n preference order.
\nAlternatively, when requesting a game session with players, you can also provide\n latency data for each player in relevant Regions. Latency data indicates the performance\n lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency\n data to reorder the list of destinations to place the game session in a Region with\n minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each\n Region's average lag for all players and reorders to get the best game play across all\n players.
\nTo place a new game session request, specify the following:
\nThe queue name and a set of game session properties and settings
\nA unique ID (such as a UUID) for the placement. You use this ID to track\n the status of the placement request
\n(Optional) A set of player data and a unique player ID for each player that\n you are joining to the new game session (player data is optional, but if you\n include it, you must also provide a unique ID for each player)
\nLatency data for all players (if you want to optimize game play for the\n players)
\nIf successful, a new game session placement is created.
\nTo track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the\n status is FULFILLED, a new game session has been created and a game session\n ARN and Region are referenced. If the placement request times out, you can resubmit the\n request or retry it with a different queue.
\n Related actions\n
\n\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#StartGameSessionPlacementInput": { "type": "structure", "members": { "PlacementId": { "target": "com.amazonaws.gamelift#IdStringModel", "traits": { "smithy.api#documentation": "A unique identifier to assign to the new game session placement. This value is\n developer-defined. The value must be unique across all Regions and cannot be reused\n unless you are resubmitting a canceled or timed-out placement request.
", "smithy.api#required": {} } }, "GameSessionQueueName": { "target": "com.amazonaws.gamelift#GameSessionQueueNameOrArn", "traits": { "smithy.api#documentation": "Name of the queue to use to place the new game session. You can use either the queue name\n or ARN value.
", "smithy.api#required": {} } }, "GameProperties": { "target": "com.amazonaws.gamelift#GamePropertyList", "traits": { "smithy.api#documentation": "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 \n GameSession object with a request to start a new game session (see Start a Game Session).
" } }, "MaximumPlayerSessionCount": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The maximum number of players that can be connected simultaneously to the game session.
", "smithy.api#required": {} } }, "GameSessionName": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A descriptive label that is associated with a game session. Session names do not need to be unique.
" } }, "PlayerLatencies": { "target": "com.amazonaws.gamelift#PlayerLatencyList", "traits": { "smithy.api#documentation": "A set of values, expressed in milliseconds, that indicates 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\n it can offer the best possible gameplay experience for the players.
" } }, "DesiredPlayerSessions": { "target": "com.amazonaws.gamelift#DesiredPlayerSessionList", "traits": { "smithy.api#documentation": "Set of information on each player to create a player session for.
" } }, "GameSessionData": { "target": "com.amazonaws.gamelift#LargeGameSessionData", "traits": { "smithy.api#documentation": "A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n GameSession object with a request to start a new game session (see Start a Game Session).
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#StartGameSessionPlacementOutput": { "type": "structure", "members": { "GameSessionPlacement": { "target": "com.amazonaws.gamelift#GameSessionPlacement", "traits": { "smithy.api#documentation": "Object that describes the newly created game session placement. This object\n includes all the information provided in the request, as well as start/end time stamps\n and placement status.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#StartMatchBackfill": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#StartMatchBackfillInput" }, "output": { "target": "com.amazonaws.gamelift#StartMatchBackfillOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { "smithy.api#documentation": "Finds new players to fill open slots in currently running game sessions. \n The backfill match process is essentially identical to the process of forming new\n matches. Backfill\n requests use the same matchmaker that was used to make the original match, and they provide\n matchmaking data for all players currently in the game session. FlexMatch uses this information \n to select new players so that backfilled match continues to meet the original match requirements.
\nWhen using FlexMatch with GameLift managed hosting, you can request a backfill match from\n a client service by calling this operation with a GameSession\n identifier. You also have the option of making backfill requests directly from your game\n server. In response to a request, FlexMatch creates player sessions for the new players,\n updates the GameSession resource, and sends updated matchmaking data to the\n game server. You can request a backfill match at any point after a game session is\n started. Each game session can have only one active backfill request at a time; a\n subsequent request automatically replaces the earlier request.
When using FlexMatch as a standalone component, request a backfill match by calling this operation\n without a game session identifier. As with newly formed matches, matchmaking results are returned\n in a matchmaking event so that your game can update the game session that is being backfilled.
\nTo request a backfill match, specify a unique ticket ID, the original matchmaking\n configuration, and matchmaking data for all current players in the game session being\n backfilled. Optionally, specify the GameSession ARN. If successful, a match\n backfill ticket is created and returned with status set to QUEUED. Track the status of\n backfill tickets using the same method for tracking tickets for new matches.
\n Learn more\n
\n\n \n Backfill existing games with FlexMatch\n
\n\n \n Matchmaking events (reference)
\n\n \n How GameLift FlexMatch works\n
\n\n Related actions\n
\n\n StartMatchmaking | \n DescribeMatchmaking | \n StopMatchmaking | \n AcceptMatch | \n StartMatchBackfill | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#StartMatchBackfillInput": { "type": "structure", "members": { "TicketId": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { "smithy.api#documentation": "A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of\n a UUID. Use this identifier to track the match backfill ticket status and retrieve match\n results.
" } }, "ConfigurationName": { "target": "com.amazonaws.gamelift#MatchmakingConfigurationName", "traits": { "smithy.api#documentation": "Name of the matchmaker to use for this request. You can use either the configuration\n name or ARN value. The ARN of the matchmaker that was used with the original game\n session is listed in the GameSession object,\n MatchmakerData property.
A unique identifier for the game session. Use the game session ID. When using FlexMatch as a standalone matchmaking\n solution, this parameter is not needed.
" } }, "Players": { "target": "com.amazonaws.gamelift#PlayerList", "traits": { "smithy.api#documentation": "Match information on all players that are currently assigned to the game session.\n This information is used by the matchmaker to find new players and add them to the\n existing game.
\nPlayerID, PlayerAttributes, Team -- This information is maintained in the\n GameSession object, MatchmakerData property,\n for all players who are currently assigned to the game session. The matchmaker\n data is in JSON syntax, formatted as a string. For more details, see \n Match Data.
LatencyInMs -- If the matchmaker uses player latency, include a latency\n value, in milliseconds, for the Region that the game session is currently in. Do\n not include latency values for any other Region.
\nRepresents the input for a request operation.
" } }, "com.amazonaws.gamelift#StartMatchBackfillOutput": { "type": "structure", "members": { "MatchmakingTicket": { "target": "com.amazonaws.gamelift#MatchmakingTicket", "traits": { "smithy.api#documentation": "Ticket representing the backfill matchmaking request. This object includes the\n information in the request, ticket status, and match results as generated during the\n matchmaking process.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#StartMatchmaking": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#StartMatchmakingInput" }, "output": { "target": "com.amazonaws.gamelift#StartMatchmakingOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { "smithy.api#documentation": "Uses FlexMatch to create a game match for a group of players based on custom matchmaking\n rules. With games that use GameLift managed hosting, this operation also triggers GameLift\n to find hosting resources and start a new game session for the new match. Each\n matchmaking request includes information on one or more players and specifies the\n FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to\n build a match that includes all players in the request, placing them in the same team\n and finding additional players as needed to fill the match.
\nTo start matchmaking, provide a unique ticket ID, specify a matchmaking configuration,\n and include the players to be matched. You must also include any player attributes that\n are required by the matchmaking configuration's rule set. If successful, a matchmaking\n ticket is returned with status set to QUEUED.
Track matchmaking events to respond as needed and acquire game session connection\n information for successfully completed matches. Ticket status updates are tracked using\n event notification through Amazon Simple Notification Service (SNS), which is defined in the matchmaking\n configuration.
\n\n Learn more\n
\n\n \n Add FlexMatch to a game client\n
\n\n \n Set Up FlexMatch event notification\n
\n\n \n How GameLift FlexMatch works\n
\n\n Related actions\n
\n\n StartMatchmaking | \n DescribeMatchmaking | \n StopMatchmaking | \n AcceptMatch | \n StartMatchBackfill | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#StartMatchmakingInput": { "type": "structure", "members": { "TicketId": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { "smithy.api#documentation": "A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of\n a UUID. Use this identifier to track the matchmaking ticket status and retrieve match\n results.
" } }, "ConfigurationName": { "target": "com.amazonaws.gamelift#MatchmakingConfigurationName", "traits": { "smithy.api#documentation": "Name of the matchmaking configuration to use for this request. Matchmaking\n configurations must exist in the same Region as this request. You can use either the\n configuration name or ARN value.
", "smithy.api#required": {} } }, "Players": { "target": "com.amazonaws.gamelift#PlayerList", "traits": { "smithy.api#documentation": "Information on each player to be matched. This information must include a player\n ID, and may contain player attributes and latency data to be used in the matchmaking\n process. After a successful match, Player objects contain the name of the\n team the player is assigned to.
Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#StartMatchmakingOutput": { "type": "structure", "members": { "MatchmakingTicket": { "target": "com.amazonaws.gamelift#MatchmakingTicket", "traits": { "smithy.api#documentation": "Ticket representing the matchmaking request. This object include the information\n included in the request, ticket status, and match results as generated during the\n matchmaking process.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#StopFleetActions": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#StopFleetActionsInput" }, "output": { "target": "com.amazonaws.gamelift#StopFleetActionsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Suspends certain types of activity in a fleet location. Currently, this operation is\n used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed\n separately for each location.
\nStopping fleet actions has several potential purposes. It allows you to temporarily\n stop auto-scaling activity but retain your scaling policies for use in the future. For\n multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it\n for certain locations.
\nThis operation can be used in the following ways:
\nTo stop actions on instances in the fleet's home Region, provide a fleet ID\n and the type of actions to suspend.
\nTo stop actions on instances in one of the fleet's remote locations, provide a\n fleet ID, a location name, and the type of actions to suspend.
\nIf successful, GameLift no longer initiates scaling events except in response to manual\n changes using UpdateFleetCapacity. You can view a fleet's stopped\n actions using DescribeFleetAttributes or DescribeFleetLocationAttributes. Suspended activity can be restarted\n using StartFleetActions.
\n\n Learn more\n
\n\n Setting up GameLift Fleets\n
\n\n Related actions\n
\n\n CreateFleet | \n UpdateFleetCapacity | \n PutScalingPolicy | \n DescribeEC2InstanceLimits | \n DescribeFleetAttributes | \n DescribeFleetLocationAttributes | \n UpdateFleetAttributes | \n StopFleetActions | \n DeleteFleet | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#StopFleetActionsInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to stop actions on. You can use either the fleet ID or ARN value.
", "smithy.api#required": {} } }, "Actions": { "target": "com.amazonaws.gamelift#FleetActionList", "traits": { "smithy.api#documentation": "List of actions to suspend on the fleet.
", "smithy.api#required": {} } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "The fleet location to stop fleet actions for. Specify a location in the form of an AWS Region code, such as\n us-west-2.
Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#StopFleetActionsOutput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to stop actions on.
" } }, "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:.
Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#StopGameSessionPlacement": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#StopGameSessionPlacementInput" }, "output": { "target": "com.amazonaws.gamelift#StopGameSessionPlacementOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Cancels a game session placement that is in PENDING status. To stop a\n placement, provide the placement ID values. If successful, the placement is moved to\n CANCELLED status.
\n Related actions\n
\n\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#StopGameSessionPlacementInput": { "type": "structure", "members": { "PlacementId": { "target": "com.amazonaws.gamelift#IdStringModel", "traits": { "smithy.api#documentation": "A unique identifier for a game session placement to cancel.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#StopGameSessionPlacementOutput": { "type": "structure", "members": { "GameSessionPlacement": { "target": "com.amazonaws.gamelift#GameSessionPlacement", "traits": { "smithy.api#documentation": "Object that describes the canceled game session placement, with\n CANCELLED status and an end time stamp.
Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#StopMatchmaking": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#StopMatchmakingInput" }, "output": { "target": "com.amazonaws.gamelift#StopMatchmakingOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { "smithy.api#documentation": "Cancels a matchmaking ticket or match backfill ticket that is currently being\n processed. To stop the matchmaking operation, specify the ticket ID. If successful, work\n on the ticket is stopped, and the ticket status is changed to\n CANCELLED.
This call is also used to turn off automatic backfill for an individual game session.\n This is for game sessions that are created with a matchmaking configuration that has\n automatic backfill enabled. The ticket ID is included in the MatchmakerData\n 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\n (not an empty HTTP body).
\n\n Learn more\n
\n\n \n Add FlexMatch to a game client\n
\n\n Related actions\n
\n\n StartMatchmaking | \n DescribeMatchmaking | \n StopMatchmaking | \n AcceptMatch | \n StartMatchBackfill | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#StopMatchmakingInput": { "type": "structure", "members": { "TicketId": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { "smithy.api#documentation": "A unique identifier for a matchmaking ticket.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#StopMatchmakingOutput": { "type": "structure", "members": {} }, "com.amazonaws.gamelift#StringDoubleMap": { "type": "map", "key": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString" }, "value": { "target": "com.amazonaws.gamelift#DoubleObject" } }, "com.amazonaws.gamelift#StringList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString" } }, "com.amazonaws.gamelift#StringModel": { "type": "string" }, "com.amazonaws.gamelift#SuspendGameServerGroup": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#SuspendGameServerGroupInput" }, "output": { "target": "com.amazonaws.gamelift#SuspendGameServerGroupOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "\n This operation is used with the GameLift FleetIQ solution and game server groups.\n
\nTemporarily stops activity on a game server group without terminating instances or the\n game server group. You can restart activity by calling ResumeGameServerGroup. You can suspend the following activity:
\n\n Instance type replacement - This activity\n evaluates the current game hosting viability of all Spot instance types that are\n defined for the game server group. It updates the Auto Scaling group to remove\n nonviable Spot Instance types, which have a higher chance of game server\n interruptions. It then balances capacity across the remaining viable Spot\n Instance types. When this activity is suspended, the Auto Scaling group\n continues with its current balance, regardless of viability. Instance\n protection, utilization metrics, and capacity scaling activities continue to be\n active.
\nTo suspend activity, specify a game server group ARN and the type of activity to be\n suspended. If successful, a GameServerGroup object is returned showing\n that the activity is listed in SuspendedActions.
\n Learn more\n
\n \n\n Related actions\n
\n\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#SuspendGameServerGroupInput": { "type": "structure", "members": { "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
", "smithy.api#required": {} } }, "SuspendActions": { "target": "com.amazonaws.gamelift#GameServerGroupActions", "traits": { "smithy.api#documentation": "The activity to suspend for this game server group.
", "smithy.api#required": {} } } } }, "com.amazonaws.gamelift#SuspendGameServerGroupOutput": { "type": "structure", "members": { "GameServerGroup": { "target": "com.amazonaws.gamelift#GameServerGroup", "traits": { "smithy.api#documentation": "An object that describes the game server group resource, with the\n SuspendedActions property updated to reflect the suspended\n activity.
\n The key for a developer-defined key:value pair for tagging an AWS resource.\n
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.gamelift#TagValue", "traits": { "smithy.api#documentation": "\n The value for a developer-defined key:value pair for tagging an AWS resource.\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "\n A label that can be assigned to a GameLift resource.\n
\n\n Learn more\n
\n\n Tagging AWS Resources in the\n AWS General Reference\n
\n\n \n AWS Tagging Strategies\n
\n\n Related actions\n
\n\n TagResource | \n UntagResource | \n ListTagsForResource | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.gamelift#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#TagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.gamelift#TagList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.gamelift#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#TagResourceRequest" }, "output": { "target": "com.amazonaws.gamelift#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#TaggingFailedException" } ], "traits": { "smithy.api#documentation": "Assigns a tag to a GameLift resource. AWS resource tags provide an additional\n management tool set. You can use tags to organize resources, create IAM permissions\n policies to manage access to groups of resources, customize AWS cost breakdowns, etc.\n This operation handles the permissions necessary to manage tags for the following GameLift\n resource types:
\nBuild
\nScript
\nFleet
\nAlias
\nGameSessionQueue
\nMatchmakingConfiguration
\nMatchmakingRuleSet
\nTo add a tag to a resource, specify the unique ARN value for the resource and provide\n a tag list containing one or more tags. The operation succeeds even if the list includes\n tags that are already assigned to the specified resource.
\n\n Learn more\n
\n\n Tagging AWS Resources in the\n AWS General Reference\n
\n\n \n AWS Tagging Strategies\n
\n\n Related actions\n
\n\n TagResource | \n UntagResource | \n ListTagsForResource | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#TagResourceRequest": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.gamelift#AmazonResourceName", "traits": { "smithy.api#documentation": "\n The Amazon Resource Name \n (ARN)\n that is assigned to and uniquely identifies the GameLift resource that you want to assign\n tags to. GameLift resource ARNs are included in the data object for the resource, which \n can be retrieved by calling a List or Describe operation for the resource type.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.gamelift#TagList", "traits": { "smithy.api#documentation": "A list of one or more tags to assign to the specified GameLift resource. \n Tags are developer-defined and structured as key-value pairs. \n The maximum tag limit may be lower than stated. See Tagging AWS Resources \n for actual tagging limits.
", "smithy.api#required": {} } } } }, "com.amazonaws.gamelift#TagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.gamelift#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.gamelift#TaggingFailedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.gamelift#NonEmptyString" } }, "traits": { "smithy.api#documentation": "\n The requested tagging operation did not succeed. This may be due to invalid tag format\n or the maximum tag limit may have been exceeded. Resolve the issue before retrying.\n
", "smithy.api#error": "client" } }, "com.amazonaws.gamelift#TargetConfiguration": { "type": "structure", "members": { "TargetValue": { "target": "com.amazonaws.gamelift#Double", "traits": { "smithy.api#documentation": "Desired value to use with a target-based scaling policy. The value must be relevant\n for whatever metric the scaling policy is using. For example, in a policy using the\n metric PercentAvailableGameSessions, the target value should be the preferred size of\n the fleet's buffer (the percent of capacity that should be idle and ready for new game\n sessions).
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Settings for a target-based scaling policy (see ScalingPolicy. A\n target-based policy tracks a particular fleet metric specifies a target value for the\n metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so\n that the metric returns to the target value. The target configuration specifies settings\n as needed for the target based policy, including the target value.
\n\n Related actions\n
\n\n DescribeFleetCapacity | \n UpdateFleetCapacity | \n DescribeEC2InstanceLimits | \n PutScalingPolicy | \n DescribeScalingPolicies | \n DeleteScalingPolicy | \n StopFleetActions | \n StartFleetActions | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#TargetTrackingConfiguration": { "type": "structure", "members": { "TargetValue": { "target": "com.amazonaws.gamelift#NonNegativeDouble", "traits": { "smithy.api#documentation": "Desired value to use with a game server group target-based scaling policy.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "\n This data type is used with the GameLift FleetIQ and game server groups.\n
\nSettings for a target-based scaling policy as part of a GameServerGroupAutoScalingPolicy. \n These settings are used to\n create a target-based policy that tracks the GameLift FleetIQ metric\n \"PercentUtilizedGameServers\" and specifies a target value for the\n metric. As player usage changes, the policy triggers to adjust the game server group\n capacity so that the metric returns to the target value.
The service is unable to resolve the routing for a particular alias because it has\n a terminal RoutingStrategy associated with it. The message returned in\n this exception is the message defined in the routing strategy itself. Such requests\n should only be retried if the routing strategy for the specified alias is modified.\n
", "smithy.api#error": "client" } }, "com.amazonaws.gamelift#Timestamp": { "type": "timestamp" }, "com.amazonaws.gamelift#UnauthorizedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.gamelift#NonEmptyString" } }, "traits": { "smithy.api#documentation": "The client failed authentication. Clients should not retry such requests.
", "smithy.api#error": "client" } }, "com.amazonaws.gamelift#UnsupportedRegionException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.gamelift#NonEmptyString" } }, "traits": { "smithy.api#documentation": "The requested operation is not supported in the Region specified.
", "smithy.api#error": "client" } }, "com.amazonaws.gamelift#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#UntagResourceRequest" }, "output": { "target": "com.amazonaws.gamelift#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#TaggingFailedException" } ], "traits": { "smithy.api#documentation": "Removes a tag that is assigned to a GameLift resource. \n Resource tags are used to organize AWS resources for a range of purposes. \n This operation handles the permissions necessary to manage tags for the following \n GameLift resource types:
\nBuild
\nScript
\nFleet
\nAlias
\nGameSessionQueue
\nMatchmakingConfiguration
\nMatchmakingRuleSet
\nTo remove a tag from a resource, specify the unique ARN value for the resource and provide\n a string list containing one or more tags to be removed. \n This operation succeeds even if the list includes tags that are not currently assigned to the\n specified resource.
\n\n Learn more\n
\n\n Tagging AWS Resources in the\n AWS General Reference\n
\n\n \n AWS Tagging Strategies\n
\n\n Related actions\n
\n\n TagResource | \n UntagResource | \n ListTagsForResource | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#UntagResourceRequest": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.gamelift#AmazonResourceName", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to and\n uniquely identifies the GameLift resource that you want to remove tags from. GameLift\n resource ARNs are included in the data object for the resource, which can be retrieved\n by calling a List or Describe operation for the resource type.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.gamelift#TagKeyList", "traits": { "smithy.api#documentation": "A list of one or more tag keys to remove from the specified GameLift resource. An\n AWS resource can have only one tag with a specific tag key, so specifying the tag key\n identifies which tag to remove.
", "smithy.api#required": {} } } } }, "com.amazonaws.gamelift#UntagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.gamelift#UpdateAlias": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#UpdateAliasInput" }, "output": { "target": "com.amazonaws.gamelift#UpdateAliasOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Updates properties for an alias. To update properties, specify the alias ID to be\n updated and provide the information to be changed. To reassign an alias to another\n fleet, provide an updated routing strategy. If successful, the updated alias record is\n returned.
\n\n Related actions\n
\n\n CreateAlias | \n ListAliases | \n DescribeAlias | \n UpdateAlias | \n DeleteAlias | \n ResolveAlias | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#UpdateAliasInput": { "type": "structure", "members": { "AliasId": { "target": "com.amazonaws.gamelift#AliasIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the alias that you want to update. You can use either the\n alias ID or ARN value.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.gamelift#NonBlankAndLengthConstraintString", "traits": { "smithy.api#documentation": "A descriptive label that is associated with an alias. Alias names do not need to be unique.
" } }, "Description": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A human-readable description of the alias.
" } }, "RoutingStrategy": { "target": "com.amazonaws.gamelift#RoutingStrategy", "traits": { "smithy.api#documentation": "The routing configuration, including routing type and fleet target, for the\n alias.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#UpdateAliasOutput": { "type": "structure", "members": { "Alias": { "target": "com.amazonaws.gamelift#Alias", "traits": { "smithy.api#documentation": "The updated alias resource.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#UpdateBuild": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#UpdateBuildInput" }, "output": { "target": "com.amazonaws.gamelift#UpdateBuildOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Updates metadata in a build resource, including the build name and version. To update\n the metadata, specify the build ID to update and provide the new values. If successful,\n a build object containing the updated metadata is returned.
\n\n Learn more\n
\n\n \n Upload a Custom Server Build\n
\n\n Related actions\n
\n\n CreateBuild | \n ListBuilds | \n DescribeBuild | \n UpdateBuild | \n DeleteBuild | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#UpdateBuildInput": { "type": "structure", "members": { "BuildId": { "target": "com.amazonaws.gamelift#BuildIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the build to update. You can use either the build ID or ARN value.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A descriptive label that is associated with a build. Build names do not need to be unique.
" } }, "Version": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "Version information that is associated with a build or script. Version strings do not need to be unique.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#UpdateBuildOutput": { "type": "structure", "members": { "Build": { "target": "com.amazonaws.gamelift#Build", "traits": { "smithy.api#documentation": "The updated build resource.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#UpdateFleetAttributes": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#UpdateFleetAttributesInput" }, "output": { "target": "com.amazonaws.gamelift#UpdateFleetAttributesOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#ConflictException" }, { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidFleetStatusException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#LimitExceededException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Updates a fleet's mutable attributes, including game session protection and resource\n creation limits.
\nTo update fleet attributes, specify the fleet ID and the property values that you want\n to change.
\nIf successful, an updated FleetAttributes object is returned.
\n Learn more\n
\n\n Setting up GameLift fleets\n
\n\n Related actions\n
\n\n CreateFleetLocations | \n UpdateFleetAttributes | \n UpdateFleetCapacity | \n UpdateFleetPortSettings | \n UpdateRuntimeConfiguration | \n StopFleetActions | \n StartFleetActions | \n PutScalingPolicy | \n DeleteFleet | \n DeleteFleetLocations | \n DeleteScalingPolicy | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#UpdateFleetAttributesInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN\n value.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
" } }, "Description": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A human-readable description of a fleet.
" } }, "NewGameSessionProtectionPolicy": { "target": "com.amazonaws.gamelift#ProtectionPolicy", "traits": { "smithy.api#documentation": "The game session protection policy to apply to all new instances created in this\n fleet. Instances that already exist are not affected. You can set protection for\n individual instances using UpdateGameSession.
\n\n NoProtection -- The game session can be\n terminated during a scale-down event.
\n\n FullProtection -- If the game session is in an\n ACTIVE status, it cannot be terminated during a scale-down\n event.
Policy settings that limit the number of game sessions an individual player can create\n over a span of time.
" } }, "MetricGroups": { "target": "com.amazonaws.gamelift#MetricGroupList", "traits": { "smithy.api#documentation": "The name of a metric group to add this fleet to. Use a metric group in Amazon\n CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric\n group name, or create a new metric group by providing a new name. A fleet can only be in\n one metric group at a time.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#UpdateFleetAttributesOutput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "A unique identifier for the fleet that was updated.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#UpdateFleetCapacity": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#UpdateFleetCapacityInput" }, "output": { "target": "com.amazonaws.gamelift#UpdateFleetCapacityOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#ConflictException" }, { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidFleetStatusException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#LimitExceededException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Updates capacity settings for a fleet. For fleets with multiple locations, use this\n operation to manage capacity settings in each location individually. Fleet capacity\n determines the number of game sessions and players that can be hosted based on the fleet\n configuration. Use this operation to set the following fleet capacity properties:
\nMinimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set\n the fleet's capacity to a value outside of this range, whether the capacity is\n changed manually or through automatic scaling.
\nDesired capacity: Manually set the number of EC2 instances to be maintained\n in a fleet location. Before changing a fleet's desired capacity, you may want to\n call DescribeEC2InstanceLimits to get the maximum capacity of\n the fleet's EC2 instance type. Alternatively, consider using automatic scaling\n to adjust capacity based on player demand.
\nThis operation can be used in the following ways:
\nTo update capacity for a fleet's home Region, or if the fleet has no remote\n locations, omit the Location parameter. The fleet must be in\n ACTIVE status.
To update capacity for a fleet's remote location, include the\n Location parameter set to the location to be updated. The\n location must be in ACTIVE status.
If successful, capacity settings are updated immediately. In response a change in\n desired capacity, GameLift initiates steps to start new instances or terminate existing\n instances in the requested fleet location. This continues until the location's active\n instance count matches the new desired instance count. You can track a fleet's current\n capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. If the requested desired instance count\n is higher than the instance type's limit, the LimitExceeded exception\n occurs.
\n Learn more\n
\n \n\n Related actions\n
\n\n CreateFleetLocations | \n UpdateFleetAttributes | \n UpdateFleetCapacity | \n UpdateFleetPortSettings | \n UpdateRuntimeConfiguration | \n StopFleetActions | \n StartFleetActions | \n PutScalingPolicy | \n DeleteFleet | \n DeleteFleetLocations | \n DeleteScalingPolicy | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#UpdateFleetCapacityInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to update capacity settings for. You can use either the fleet ID or ARN\n value.
", "smithy.api#required": {} } }, "DesiredInstances": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The number of EC2 instances you want to maintain in the specified fleet location.\n This value must fall between the minimum and maximum size limits.
" } }, "MinSize": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The minimum number of instances that are allowed in the specified fleet location. If\n this parameter is not set, the default is 0.
" } }, "MaxSize": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The maximum number of instances that are allowed in the specified fleet location. If\n this parameter is not set, the default is 1.
" } }, "Location": { "target": "com.amazonaws.gamelift#LocationStringModel", "traits": { "smithy.api#documentation": "The name of a remote location to update fleet capacity settings for, in the form of an\n AWS Region code such as us-west-2.
Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#UpdateFleetCapacityOutput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "A unique identifier for the fleet that was updated.
" } }, "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:.
The remote location being updated, expressed as an AWS Region code, \n such as us-west-2.
Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#UpdateFleetPortSettings": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#UpdateFleetPortSettingsInput" }, "output": { "target": "com.amazonaws.gamelift#UpdateFleetPortSettingsOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#ConflictException" }, { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidFleetStatusException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#LimitExceededException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Updates permissions that allow inbound traffic to connect to game sessions that are\n being hosted on instances in the fleet.
\nTo update settings, specify the fleet ID to be updated and specify the changes to be\n made. List the permissions you want to add in\n InboundPermissionAuthorizations, and permissions you want to remove in\n InboundPermissionRevocations. Permissions to be removed must match\n existing fleet permissions.
If successful, the fleet ID for the updated fleet is returned. For fleets with remote\n locations, port setting updates can take time to propagate across all locations. You can\n check the status of updates in each location by calling\n DescribeFleetPortSettings with a location name.
\n Learn more\n
\n\n Setting up GameLift fleets\n
\n\n Related actions\n
\n\n CreateFleetLocations | \n UpdateFleetAttributes | \n UpdateFleetCapacity | \n UpdateFleetPortSettings | \n UpdateRuntimeConfiguration | \n StopFleetActions | \n StartFleetActions | \n PutScalingPolicy | \n DeleteFleet | \n DeleteFleetLocations | \n DeleteScalingPolicy | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#UpdateFleetPortSettingsInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to update port settings for. You can use either the fleet ID or ARN\n value.
", "smithy.api#required": {} } }, "InboundPermissionAuthorizations": { "target": "com.amazonaws.gamelift#IpPermissionsList", "traits": { "smithy.api#documentation": "A collection of port settings to be added to the fleet resource.
" } }, "InboundPermissionRevocations": { "target": "com.amazonaws.gamelift#IpPermissionsList", "traits": { "smithy.api#documentation": "A collection of port settings to be removed from the fleet resource.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#UpdateFleetPortSettingsOutput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "A unique identifier for the fleet that was updated.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#UpdateGameServer": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#UpdateGameServerInput" }, "output": { "target": "com.amazonaws.gamelift#UpdateGameServerOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "\n This operation is used with the GameLift FleetIQ solution and game server groups.\n
\nUpdates information about a registered game server to help GameLift FleetIQ to track game server\n availability. This operation is called by a game server process that is running on an\n instance in a game server group.
\nUse this operation to update the following types of game server information. You can\n make all three types of updates in the same request:
\nTo update the game server's utilization status, identify the game server and game server group\n and specify the current utilization status. Use this status to identify when\n game servers are currently hosting games and when they are available to be\n claimed.
\nTo report health status, identify the game server and game server group and set health check\n to HEALTHY. If a game server does not report health status for a\n certain length of time, the game server is no longer considered healthy. As a\n result, it will be eventually deregistered from the game server group to avoid\n affecting utilization metrics. The best practice is to report health every 60\n seconds.
To change game server metadata, provide updated game server data.
\nOnce a game server is successfully updated, the relevant statuses and timestamps are updated.
\n\n Learn more\n
\n \n\n Related actions\n
\n\n RegisterGameServer | \n ListGameServers | \n ClaimGameServer | \n DescribeGameServer | \n UpdateGameServer | \n DeregisterGameServer | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#UpdateGameServerGroup": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#UpdateGameServerGroupInput" }, "output": { "target": "com.amazonaws.gamelift#UpdateGameServerGroupOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "\n This operation is used with the GameLift FleetIQ solution and game server groups.\n
\nUpdates GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group\n properties are updated on the Auto Scaling group directly, including the launch\n template, Auto Scaling policies, and maximum/minimum/desired instance counts.
\nTo update the game server group, specify the game server group ID and provide the\n updated values. Before applying the updates, the new values are validated to ensure that\n GameLift FleetIQ can continue to perform instance balancing activity. If successful, a GameServerGroup object is returned.
\n\n Learn more\n
\n \n \n\n Related actions\n
\n\n CreateGameServerGroup | \n ListGameServerGroups | \n DescribeGameServerGroup | \n UpdateGameServerGroup | \n DeleteGameServerGroup | \n ResumeGameServerGroup | \n SuspendGameServerGroup | \n DescribeGameServerInstances | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#UpdateGameServerGroupInput": { "type": "structure", "members": { "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.gamelift#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon GameLift to access your EC2 Auto Scaling groups.
" } }, "InstanceDefinitions": { "target": "com.amazonaws.gamelift#InstanceDefinitions", "traits": { "smithy.api#documentation": "An updated list of EC2 instance types to use in the Auto Scaling group. The instance\n definitions must specify at least two different instance types that are supported by\n GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for\n the game server group. For more information on instance types, see EC2 Instance\n Types in the Amazon EC2 User Guide. You can optionally\n specify capacity weighting for each instance type. If no weight value is specified for\n an instance type, it is set to the default value \"1\". For more information about\n capacity weighting, see Instance Weighting for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" } }, "GameServerProtectionPolicy": { "target": "com.amazonaws.gamelift#GameServerProtectionPolicy", "traits": { "smithy.api#documentation": "A flag that indicates whether instances in the game server group are protected \n from early termination. Unprotected instances that have active game servers running might \n be terminated during a scale-down event, causing players to be dropped from the game. \n Protected instances cannot be terminated while there are active game servers running except \n in the event of a forced game server group deletion (see ). An exception to this is with Spot \n Instances, which can be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.
Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the\n game server group. Method options include the following:
\n\n SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot\n Instances are unavailable or not viable for game hosting, the game server group\n provides no hosting capacity until Spot Instances can again be used. Until then,\n no new instances are started, and the existing nonviable Spot Instances are\n terminated (after current gameplay ends) and are not replaced.
\n SPOT_PREFERRED - (default value) Spot Instances are used whenever available in\n the game server group. If Spot Instances are unavailable, the game server group\n continues to provide hosting capacity by falling back to On-Demand Instances.\n Existing nonviable Spot Instances are terminated (after current gameplay ends)\n and are replaced with new On-Demand Instances.
\n ON_DEMAND_ONLY - Only On-Demand Instances are used in the game\n server group. No Spot Instances are used, even when available, while this\n balancing strategy is in force.
An object that describes the game server group resource with updated properties.
" } } } }, "com.amazonaws.gamelift#UpdateGameServerInput": { "type": "structure", "members": { "GameServerGroupName": { "target": "com.amazonaws.gamelift#GameServerGroupNameOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the game server group where the game server is running. \n Use either the GameServerGroup name or ARN value.
", "smithy.api#required": {} } }, "GameServerId": { "target": "com.amazonaws.gamelift#GameServerId", "traits": { "smithy.api#documentation": "A custom string that uniquely identifies the game server to update.
", "smithy.api#required": {} } }, "GameServerData": { "target": "com.amazonaws.gamelift#GameServerData", "traits": { "smithy.api#documentation": "A set of custom game server properties, formatted as a single string value. This data \n is passed to a game client or service when it requests information on game servers using\n ListGameServers or ClaimGameServer.
" } }, "UtilizationStatus": { "target": "com.amazonaws.gamelift#GameServerUtilizationStatus", "traits": { "smithy.api#documentation": "Indicates whether the game server is available or is currently hosting\n gameplay.
" } }, "HealthCheck": { "target": "com.amazonaws.gamelift#GameServerHealthCheck", "traits": { "smithy.api#documentation": "Indicates health status of the game server. A request that includes this parameter\n updates the game server's LastHealthCheckTime timestamp.
" } } } }, "com.amazonaws.gamelift#UpdateGameServerOutput": { "type": "structure", "members": { "GameServer": { "target": "com.amazonaws.gamelift#GameServer", "traits": { "smithy.api#documentation": "Object that describes the newly updated game server.
" } } } }, "com.amazonaws.gamelift#UpdateGameSession": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#UpdateGameSessionInput" }, "output": { "target": "com.amazonaws.gamelift#UpdateGameSessionOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#ConflictException" }, { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidGameSessionStatusException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Updates the mutable properties of a game session.
\nTo update a game session, specify the game session ID and the values you want to\n change.
\nIf successful, the updated GameSession object is returned.
\n Related actions\n
\n\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#UpdateGameSessionInput": { "type": "structure", "members": { "GameSessionId": { "target": "com.amazonaws.gamelift#ArnStringModel", "traits": { "smithy.api#documentation": "A unique identifier for the game session to update.
", "smithy.api#required": {} } }, "MaximumPlayerSessionCount": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The maximum number of players that can be connected simultaneously to the game session.
" } }, "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A descriptive label that is associated with a game session. Session names do not need to be unique.
" } }, "PlayerSessionCreationPolicy": { "target": "com.amazonaws.gamelift#PlayerSessionCreationPolicy", "traits": { "smithy.api#documentation": "A policy that determines whether the game session is accepting new players.
" } }, "ProtectionPolicy": { "target": "com.amazonaws.gamelift#ProtectionPolicy", "traits": { "smithy.api#documentation": "Game session protection policy to apply to this game session only.
\n\n NoProtection -- The game session can be\n terminated during a scale-down event.
\n\n FullProtection -- If the game session is in an\n ACTIVE status, it cannot be terminated during a scale-down\n event.
Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#UpdateGameSessionOutput": { "type": "structure", "members": { "GameSession": { "target": "com.amazonaws.gamelift#GameSession", "traits": { "smithy.api#documentation": "The updated game session properties.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#UpdateGameSessionQueue": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#UpdateGameSessionQueueInput" }, "output": { "target": "com.amazonaws.gamelift#UpdateGameSessionQueueOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Updates the configuration of a game session queue, which determines how the queue\n processes new game session requests. To update settings, specify the queue name to be\n updated and provide the new settings. When updating destinations, provide a complete\n list of destinations.
\n\n Learn more\n
\n\n \n Using Multi-Region Queues\n
\n\n Related actions\n
\n\n CreateGameSessionQueue | \n DescribeGameSessionQueues | \n UpdateGameSessionQueue | \n DeleteGameSessionQueue | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#UpdateGameSessionQueueInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.gamelift#GameSessionQueueNameOrArn", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {} } }, "TimeoutInSeconds": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "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.
A set of policies that act as a sliding cap on player latency. FleetIQ works to\n deliver low latency for most players in a game session. These policies ensure that no\n individual player can be placed into a game with unreasonably high latency. Use multiple\n policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their\n maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of\n policies.
" } }, "Destinations": { "target": "com.amazonaws.gamelift#GameSessionQueueDestinationList", "traits": { "smithy.api#documentation": "A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. \n Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. When updating this list, provide a complete list of destinations.
" } }, "FilterConfiguration": { "target": "com.amazonaws.gamelift#FilterConfiguration", "traits": { "smithy.api#documentation": "A list of locations where a queue is allowed to place new game sessions. Locations \n are specified in the form of AWS Region codes, such as us-west-2. If this parameter is \n not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.
Custom settings to use when prioritizing destinations and locations for game session placements. This \n configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly \n named will be automatically applied at the end of the prioritization process. To remove an existing priority configuration, pass in an empty set.
" } }, "CustomEventData": { "target": "com.amazonaws.gamelift#QueueCustomEventData", "traits": { "smithy.api#documentation": "\n Information to be added to all events that are related to this game session queue.\n
" } }, "NotificationTarget": { "target": "com.amazonaws.gamelift#QueueSnsArnStringModel", "traits": { "smithy.api#documentation": "An SNS topic ARN that is set up to receive game session placement notifications. See \n Setting up notifications for game session placement.
" } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#UpdateGameSessionQueueOutput": { "type": "structure", "members": { "GameSessionQueue": { "target": "com.amazonaws.gamelift#GameSessionQueue", "traits": { "smithy.api#documentation": "An object that describes the newly updated game session queue.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#UpdateMatchmakingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#UpdateMatchmakingConfigurationInput" }, "output": { "target": "com.amazonaws.gamelift#UpdateMatchmakingConfigurationOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { "smithy.api#documentation": "Updates settings for a FlexMatch matchmaking configuration. These changes affect all matches and game sessions\n that are created after the update. To update settings,\n specify the configuration name to be updated and provide the new settings.
\n\n Learn more\n
\n\n \n Design a FlexMatch matchmaker\n
\n\n Related actions\n
\n\n CreateMatchmakingConfiguration | \n DescribeMatchmakingConfigurations | \n UpdateMatchmakingConfiguration | \n DeleteMatchmakingConfiguration | \n CreateMatchmakingRuleSet | \n DescribeMatchmakingRuleSets | \n ValidateMatchmakingRuleSet | \n DeleteMatchmakingRuleSet | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#UpdateMatchmakingConfigurationInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.gamelift#MatchmakingConfigurationName", "traits": { "smithy.api#documentation": "A unique identifier for the matchmaking configuration to update. You can use either the configuration name or ARN value.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A descriptive label that is associated with matchmaking configuration.
" } }, "GameSessionQueueArns": { "target": "com.amazonaws.gamelift#QueueArnsList", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:. Queues can be located in any Region. Queues are used to start new\n GameLift-hosted game sessions for matches that are created with this matchmaking\n configuration. If FlexMatchMode is set to STANDALONE, do not\n set this parameter.
The maximum duration, in seconds, that a matchmaking ticket can remain in process\n before timing out. Requests that fail due to timing out can be resubmitted as\n needed.
" } }, "AcceptanceTimeoutSeconds": { "target": "com.amazonaws.gamelift#MatchmakingAcceptanceTimeoutInteger", "traits": { "smithy.api#documentation": "The length of time (in seconds) to wait for players to accept a proposed match, if\n acceptance is required.
" } }, "AcceptanceRequired": { "target": "com.amazonaws.gamelift#BooleanModel", "traits": { "smithy.api#documentation": "A flag that indicates whether a match that was created with this configuration must be\n accepted by the matched players. To require acceptance, set to TRUE. With this option\n enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate\n when a completed potential match is waiting for player acceptance.
A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN\n value. A matchmaking configuration can only use rule sets that are defined in the same\n Region.
" } }, "NotificationTarget": { "target": "com.amazonaws.gamelift#SnsArnStringModel", "traits": { "smithy.api#documentation": "An SNS topic ARN that is set up to receive matchmaking notifications. See \n Setting up notifications for matchmaking for more information.
" } }, "AdditionalPlayerCount": { "target": "com.amazonaws.gamelift#WholeNumber", "traits": { "smithy.api#documentation": "The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies \n a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if FlexMatchMode is set to\n STANDALONE.
Information to add to all events related to the matchmaking configuration.
" } }, "GameProperties": { "target": "com.amazonaws.gamelift#GamePropertyList", "traits": { "smithy.api#documentation": "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 \n GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession\n object that is created for a successful match. This parameter is not used if\n FlexMatchMode is set to STANDALONE.
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the \n 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\n that is created for a successful match. This parameter is not used if\n FlexMatchMode is set to STANDALONE.
The method that is used to backfill game sessions created with this matchmaking\n configuration. Specify MANUAL when your game manages backfill requests manually or does\n not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request whenever a game session has one or more open\n slots. Learn more about manual and automatic backfill in Backfill Existing Games\n with FlexMatch. Automatic backfill is not available when\n FlexMatchMode is set to STANDALONE.
Indicates whether this matchmaking configuration is being used with GameLift hosting or\n as a standalone matchmaking solution.
\n\n STANDALONE - FlexMatch forms matches and returns\n match information, including players and team assignments, in a \n \n MatchmakingSucceeded event.
\n\n WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift queue to\n start a game session for the match.
\nRepresents the input for a request operation.
" } }, "com.amazonaws.gamelift#UpdateMatchmakingConfigurationOutput": { "type": "structure", "members": { "Configuration": { "target": "com.amazonaws.gamelift#MatchmakingConfiguration", "traits": { "smithy.api#documentation": "The updated matchmaking configuration.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#UpdateRuntimeConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#UpdateRuntimeConfigurationInput" }, "output": { "target": "com.amazonaws.gamelift#UpdateRuntimeConfigurationOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidFleetStatusException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Updates the current runtime configuration for the specified fleet, which tells GameLift\n how to launch server processes on all instances in the fleet. You can update a fleet's\n runtime configuration at any time after the fleet is created; it does not need to be in\n ACTIVE status.
To update runtime configuration, specify the fleet ID and provide a\n RuntimeConfiguration with an updated set of server process\n configurations.
If successful, the fleet's runtime configuration settings are updated. Each instance\n in the fleet regularly checks for and retrieves updated runtime configurations.\n Instances immediately begin complying with the new configuration by launching new server\n processes or not replacing existing processes when they shut down. Updating a fleet's\n runtime configuration never affects existing server processes.
\n\n Learn more\n
\n\n Setting up GameLift fleets\n
\n\n Related actions\n
\n\n CreateFleetLocations | \n UpdateFleetAttributes | \n UpdateFleetCapacity | \n UpdateFleetPortSettings | \n UpdateRuntimeConfiguration | \n StopFleetActions | \n StartFleetActions | \n PutScalingPolicy | \n DeleteFleet | \n DeleteFleetLocations | \n DeleteScalingPolicy | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#UpdateRuntimeConfigurationInput": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the fleet to update runtime configuration for. You can use either the fleet ID or ARN\n value.
", "smithy.api#required": {} } }, "RuntimeConfiguration": { "target": "com.amazonaws.gamelift#RuntimeConfiguration", "traits": { "smithy.api#documentation": "Instructions for launching server processes on each instance in the fleet. Server\n processes run either a custom game build executable or a Realtime Servers script. The runtime\n configuration lists the types of server processes to run on an instance, how to launch\n them, and the number of processes to run concurrently.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#UpdateRuntimeConfigurationOutput": { "type": "structure", "members": { "RuntimeConfiguration": { "target": "com.amazonaws.gamelift#RuntimeConfiguration", "traits": { "smithy.api#documentation": "The runtime configuration currently in use by all instances in the fleet. If the\n update was successful, all property changes are shown.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#UpdateScript": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#UpdateScriptInput" }, "output": { "target": "com.amazonaws.gamelift#UpdateScriptOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#NotFoundException" }, { "target": "com.amazonaws.gamelift#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Updates Realtime script metadata and content.
\nTo update script metadata, specify the script ID and provide updated name and/or\n version values.
\nTo update script content, provide an updated zip file by pointing to either a local\n file or an Amazon S3 bucket location. You can use either method regardless of how the\n original script was uploaded. Use the Version parameter to track\n updates to the script.
\nIf the call is successful, the updated metadata is stored in the script record and a\n revised script is uploaded to the Amazon GameLift service. Once the script is updated and\n acquired by a fleet instance, the new version is used for all new game sessions.
\n\n Learn more\n
\n\n Amazon GameLift Realtime Servers\n
\n\n Related actions\n
\n\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#UpdateScriptInput": { "type": "structure", "members": { "ScriptId": { "target": "com.amazonaws.gamelift#ScriptIdOrArn", "traits": { "smithy.api#documentation": "A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A descriptive label that is associated with a script. Script names do not need to be unique.
" } }, "Version": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "Version information that is associated with a build or script. Version strings do not need to be unique.
" } }, "StorageLocation": { "target": "com.amazonaws.gamelift#S3Location", "traits": { "smithy.api#documentation": "The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is\n stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the\n \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3\n bucket must be in the same Region where you want to create a new script. By default,\n Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning\n turned on, you can use the ObjectVersion parameter to specify an earlier\n version.
A data object containing your Realtime scripts and dependencies as a zip file. The zip\n file can have one or multiple files. Maximum size of a zip file is 5 MB.
\nWhen using the AWS CLI tool to create a script, this parameter is set to the zip file\n name. It must be prepended with the string \"fileb://\" to indicate that the file data is\n a binary object. For example: --zip-file\n fileb://myRealtimeScript.zip.
The newly created script record with a unique script ID. The new script's storage\n location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket\n under your account, the storage location reflects the information that was provided in\n the CreateScript request; (2) If the script file was uploaded from\n a local zip file, the storage location reflects an S3 location controls by the Amazon GameLift\n service.
" } } } }, "com.amazonaws.gamelift#ValidateMatchmakingRuleSet": { "type": "operation", "input": { "target": "com.amazonaws.gamelift#ValidateMatchmakingRuleSetInput" }, "output": { "target": "com.amazonaws.gamelift#ValidateMatchmakingRuleSetOutput" }, "errors": [ { "target": "com.amazonaws.gamelift#InternalServiceException" }, { "target": "com.amazonaws.gamelift#InvalidRequestException" }, { "target": "com.amazonaws.gamelift#UnsupportedRegionException" } ], "traits": { "smithy.api#documentation": "Validates the syntax of a matchmaking rule or rule set. This operation checks that\n the rule set is using syntactically correct JSON and that it conforms to allowed\n property expressions. To validate syntax, provide a rule set JSON string.
\n\n Learn more\n
\n\n Build a rule\n set\n
\n\n Related actions\n
\n\n CreateMatchmakingConfiguration | \n DescribeMatchmakingConfigurations | \n UpdateMatchmakingConfiguration | \n DeleteMatchmakingConfiguration | \n CreateMatchmakingRuleSet | \n DescribeMatchmakingRuleSets | \n ValidateMatchmakingRuleSet | \n DeleteMatchmakingRuleSet | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#ValidateMatchmakingRuleSetInput": { "type": "structure", "members": { "RuleSetBody": { "target": "com.amazonaws.gamelift#RuleSetBody", "traits": { "smithy.api#documentation": "A collection of matchmaking rules to validate, formatted as a JSON string.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the input for a request operation.
" } }, "com.amazonaws.gamelift#ValidateMatchmakingRuleSetOutput": { "type": "structure", "members": { "Valid": { "target": "com.amazonaws.gamelift#BooleanModel", "traits": { "smithy.api#documentation": "A response indicating whether the rule set is valid.
" } } }, "traits": { "smithy.api#documentation": "Represents the returned data in response to a request operation.
" } }, "com.amazonaws.gamelift#VpcPeeringAuthorization": { "type": "structure", "members": { "GameLiftAwsAccountId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for the AWS account that you use to manage your GameLift fleet. \n You can find your Account ID in the AWS Management Console under account settings.
" } }, "PeerVpcAwsAccountId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "" } }, "PeerVpcId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The\n VPC must be in the same Region as your fleet. To look up a VPC ID, use the \n VPC Dashboard in the AWS Management Console. \n Learn more about VPC peering in VPC Peering with GameLift Fleets.
" } }, "CreationTime": { "target": "com.amazonaws.gamelift#Timestamp", "traits": { "smithy.api#documentation": "Time stamp indicating when this authorization was issued. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Time stamp indicating when this authorization expires (24 hours after issuance).\n Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").
Represents an authorization for a VPC peering connection between the VPC for an\n Amazon GameLift fleet and another VPC on an account you have access to. This authorization\n must exist and be valid for the peering connection to be established. Authorizations are\n valid for 24 hours after they are issued.
\n\n Related actions\n
\n\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#VpcPeeringAuthorizationList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#VpcPeeringAuthorization" } }, "com.amazonaws.gamelift#VpcPeeringConnection": { "type": "structure", "members": { "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { "smithy.api#documentation": "A unique identifier for the fleet. This ID determines the ID of the Amazon GameLift VPC for your fleet.
" } }, "FleetArn": { "target": "com.amazonaws.gamelift#FleetArn", "traits": { "smithy.api#documentation": "\n The Amazon Resource Name (ARN) associated with the GameLift fleet resource for this connection.\n
" } }, "IpV4CidrBlock": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "CIDR block of IPv4 addresses assigned to the VPC peering connection for the\n GameLift VPC. The peered VPC also has an IPv4 CIDR block associated with it; these\n blocks cannot overlap or the peering connection cannot be created.
" } }, "VpcPeeringConnectionId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier that is automatically assigned to the connection record. This ID\n is referenced in VPC peering connection events, and is used when deleting a connection\n with DeleteVpcPeeringConnection.
" } }, "Status": { "target": "com.amazonaws.gamelift#VpcPeeringConnectionStatus", "traits": { "smithy.api#documentation": "The status information about the connection. Status indicates if a\n connection is pending, successful, or failed.
" } }, "PeerVpcId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The\n VPC must be in the same Region as your fleet. To look up a VPC ID, use the \n VPC Dashboard in the AWS Management Console. \n Learn more about VPC peering in VPC Peering with GameLift Fleets.
" } }, "GameLiftVpcId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "A unique identifier for the VPC that contains the Amazon GameLift fleet for this\n connection. This VPC is managed by Amazon GameLift and does not appear in your AWS account.\n
" } } }, "traits": { "smithy.api#documentation": "Represents a peering connection between a VPC on one of your AWS accounts and the\n VPC for your Amazon GameLift fleets. This record may be for an active peering connection or a\n pending connection that has not yet been established.
\n\n Related actions\n
\n\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n
" } }, "com.amazonaws.gamelift#VpcPeeringConnectionList": { "type": "list", "member": { "target": "com.amazonaws.gamelift#VpcPeeringConnection" } }, "com.amazonaws.gamelift#VpcPeeringConnectionStatus": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "Code indicating the status of a VPC peering connection.
" } }, "Message": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { "smithy.api#documentation": "Additional messaging associated with the connection status.
" } } }, "traits": { "smithy.api#documentation": "Represents status information for a VPC peering connection. Status is associated\n with a VpcPeeringConnection object. Status codes and messages are\n provided from EC2 (see VpcPeeringConnectionStateReason). Connection status information is also\n communicated as a fleet Event.
" } }, "com.amazonaws.gamelift#VpcSubnet": { "type": "string", "traits": { "smithy.api#length": { "min": 15, "max": 24 }, "smithy.api#pattern": "^subnet-[0-9a-z]+$" } }, "com.amazonaws.gamelift#VpcSubnets": { "type": "list", "member": { "target": "com.amazonaws.gamelift#VpcSubnet" }, "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.gamelift#WeightedCapacity": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 3 }, "smithy.api#pattern": "^[\\u0031-\\u0039][\\u0030-\\u0039]{0,2}$" } }, "com.amazonaws.gamelift#WholeNumber": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0 } } }, "com.amazonaws.gamelift#ZipBlob": { "type": "blob", "traits": { "smithy.api#length": { "min": 0, "max": 5000000 } } } } }