@datafire/amazonaws_gamelift
v5.0.0
Published
DataFire integration for Amazon GameLift
Downloads
13
Readme
@datafire/amazonaws_gamelift
Client library for Amazon GameLift
Installation and Usage
npm install --save @datafire/amazonaws_gamelift
let amazonaws_gamelift = require('@datafire/amazonaws_gamelift').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_gamelift.AcceptMatch({
"TicketId": "",
"PlayerIds": [],
"AcceptanceType": ""
}).then(data => {
console.log(data);
});
Description
Amazon GameLift Service Amazon GameLift is a managed service for developers who need a scalable, dedicated server solution for their multiplayer games. Use Amazon GameLift for these tasks: (1) set up computing resources and deploy your game servers, (2) run game sessions and get players into games, (3) automatically scale your resources to meet player demand and manage costs, and (4) track in-depth metrics on game server performance and player usage. The Amazon GameLift service API includes two important function sets: Manage game sessions and player access -- Retrieve information on available game sessions; create new game sessions; send player requests to join a game session. Configure and manage game server resources -- Manage builds, fleets, queues, and aliases; set autoscaling policies; retrieve logs and metrics. This reference guide describes the low-level service API for Amazon GameLift. You can use the API functionality with these tools: The Amazon Web Services software development kit (AWS SDK) is available in multiple languages including C++ and C#. Use the SDK to access the API programmatically from an application, such as a game client. The AWS command-line interface (CLI) tool is primarily useful for handling administrative actions, such as setting up and managing Amazon GameLift settings and resources. You can use the AWS CLI to manage all of your AWS services. The AWS Management Console for Amazon GameLift provides a web interface to manage your Amazon GameLift settings and resources. The console includes a dashboard for tracking key resources, including builds and fleets, and displays usage and performance metrics for your games as customizable graphs. Amazon GameLift Local is a tool for testing your game's integration with Amazon GameLift before deploying it on the service. This tools supports a subset of key API actions, which can be called from either the AWS CLI or programmatically. See Testing an Integration. Learn more Developer Guide -- Read about Amazon GameLift features and how to use them. Tutorials -- Get started fast with walkthroughs and sample projects. GameDev Blog -- Stay up to date with new features and techniques. GameDev Forums -- Connect with the GameDev community. Release notes and document history -- Stay current with updates to the Amazon GameLift service, SDKs, and documentation. API SUMMARY This list offers a functional overview of the Amazon GameLift service API. Managing Games and Players Use these actions to start new game sessions, find existing game sessions, track game session status and other information, and enable player access to game sessions. Discover existing game sessions SearchGameSessions -- Retrieve all available game sessions or search for game sessions that match a set of criteria. Start new game sessions Start new games with Queues to find the best available hosting resources across multiple regions, minimize player latency, and balance game session activity for efficiency and cost effectiveness. StartGameSessionPlacement -- Request a new game session placement and add one or more players to it. DescribeGameSessionPlacement -- Get details on a placement request, including status. StopGameSessionPlacement -- Cancel a placement request. CreateGameSession -- Start a new game session on a specific fleet. Available in Amazon GameLift Local. Match players to game sessions with FlexMatch matchmaking StartMatchmaking -- Request matchmaking for one players or a group who want to play together. StartMatchBackfill - Request additional player matches to fill empty slots in an existing game session. DescribeMatchmaking -- Get details on a matchmaking request, including status. AcceptMatch -- Register that a player accepts a proposed match, for matches that require player acceptance. StopMatchmaking -- Cancel a matchmaking request. Manage game session data DescribeGameSessions -- Retrieve metadata for one or more game sessions, including length of time active and current player count. Available in Amazon GameLift Local. DescribeGameSessionDetails -- Retrieve metadata and the game session protection setting for one or more game sessions. UpdateGameSession -- Change game session settings, such as maximum player count and join policy. GetGameSessionLogUrl -- Get the location of saved logs for a game session. Manage player sessions CreatePlayerSession -- Send a request for a player to join a game session. Available in Amazon GameLift Local. CreatePlayerSessions -- Send a request for multiple players to join a game session. Available in Amazon GameLift Local. DescribePlayerSessions -- Get details on player activity, including status, playing time, and player data. Available in Amazon GameLift Local. Setting Up and Managing Game Servers When setting up Amazon GameLift resources for your game, you first create a game build and upload it to Amazon GameLift. You can then use these actions to configure and manage a fleet of resources to run your game servers, scale capacity to meet player demand, access performance and utilization metrics, and more. Manage game builds CreateBuild -- Create a new build using files stored in an Amazon S3 bucket. To create a build and upload files from a local path, use the AWS CLI command upload-build. ListBuilds -- Get a list of all builds uploaded to a Amazon GameLift region. DescribeBuild -- Retrieve information associated with a build. UpdateBuild -- Change build metadata, including build name and version. DeleteBuild -- Remove a build from Amazon GameLift. Manage fleets CreateFleet -- Configure and activate a new fleet to run a build's game servers. ListFleets -- Get a list of all fleet IDs in a Amazon GameLift region (all statuses). DeleteFleet -- Terminate a fleet that is no longer running game servers or hosting players. View / update fleet configurations. DescribeFleetAttributes / UpdateFleetAttributes -- View or change a fleet's metadata and settings for game session protection and resource creation limits. DescribeFleetPortSettings / UpdateFleetPortSettings -- View or change the inbound permissions (IP address and port setting ranges) allowed for a fleet. DescribeRuntimeConfiguration / UpdateRuntimeConfiguration -- View or change what server processes (and how many) to run on each instance in a fleet. Control fleet capacity DescribeEC2InstanceLimits -- Retrieve maximum number of instances allowed for the current AWS account and the current usage level. DescribeFleetCapacity / UpdateFleetCapacity -- Retrieve the capacity settings and the current number of instances in a fleet; adjust fleet capacity settings to scale up or down. Autoscale -- Manage autoscaling rules and apply them to a fleet. PutScalingPolicy -- Create a new autoscaling policy, or update an existing one. DescribeScalingPolicies -- Retrieve an existing autoscaling policy. DeleteScalingPolicy -- Delete an autoscaling policy and stop it from affecting a fleet's capacity. Manage VPC peering connections for fleets CreateVpcPeeringAuthorization -- Authorize a peering connection to one of your VPCs. DescribeVpcPeeringAuthorizations -- Retrieve valid peering connection authorizations. DeleteVpcPeeringAuthorization -- Delete a peering connection authorization. CreateVpcPeeringConnection -- Establish a peering connection between the VPC for a Amazon GameLift fleet and one of your VPCs. DescribeVpcPeeringConnections -- Retrieve information on active or pending VPC peering connections with a Amazon GameLift fleet. DeleteVpcPeeringConnection -- Delete a VPC peering connection with a Amazon GameLift fleet. Access fleet activity statistics DescribeFleetUtilization -- Get current data on the number of server processes, game sessions, and players currently active on a fleet. DescribeFleetEvents -- Get a fleet's logged events for a specified time span. DescribeGameSessions -- Retrieve metadata associated with one or more game sessions, including length of time active and current player count. Remotely access an instance DescribeInstances -- Get information on each instance in a fleet, including instance ID, IP address, and status. GetInstanceAccess -- Request access credentials needed to remotely connect to a specified instance in a fleet. Manage fleet aliases CreateAlias -- Define a new alias and optionally assign it to a fleet. ListAliases -- Get all fleet aliases defined in a Amazon GameLift region. DescribeAlias -- Retrieve information on an existing alias. UpdateAlias -- Change settings for a alias, such as redirecting it from one fleet to another. DeleteAlias -- Remove an alias from the region. ResolveAlias -- Get the fleet ID that a specified alias points to. Manage game session queues CreateGameSessionQueue -- Create a queue for processing requests for new game sessions. DescribeGameSessionQueues -- Retrieve game session queues defined in a Amazon GameLift region. UpdateGameSessionQueue -- Change the configuration of a game session queue. DeleteGameSessionQueue -- Remove a game session queue from the region. Manage FlexMatch resources CreateMatchmakingConfiguration -- Create a matchmaking configuration with instructions for building a player group and placing in a new game session. DescribeMatchmakingConfigurations -- Retrieve matchmaking configurations defined a Amazon GameLift region. UpdateMatchmakingConfiguration -- Change settings for matchmaking configuration. queue. DeleteMatchmakingConfiguration -- Remove a matchmaking configuration from the region. CreateMatchmakingRuleSet -- Create a set of rules to use when searching for player matches. DescribeMatchmakingRuleSets -- Retrieve matchmaking rule sets defined in a Amazon GameLift region. ValidateMatchmakingRuleSet -- Verify syntax for a set of matchmaking rules.
Actions
AcceptMatch
amazonaws_gamelift.AcceptMatch({
"TicketId": "",
"PlayerIds": [],
"AcceptanceType": ""
}, context)
Input
- input
object
- AcceptanceType required AcceptanceType
- PlayerIds required StringList
- TicketId required MatchmakingIdStringModel
Output
- output AcceptMatchOutput
CreateAlias
amazonaws_gamelift.CreateAlias({
"Name": "",
"RoutingStrategy": {}
}, context)
Input
- input
object
- Description NonZeroAndMaxString
- Name required NonBlankAndLengthConstraintString
- RoutingStrategy required RoutingStrategy
Output
- output CreateAliasOutput
CreateBuild
amazonaws_gamelift.CreateBuild({}, context)
Input
- input
object
- Name NonZeroAndMaxString
- OperatingSystem OperatingSystem
- StorageLocation S3Location
- Version NonZeroAndMaxString
Output
- output CreateBuildOutput
CreateFleet
amazonaws_gamelift.CreateFleet({
"Name": "",
"BuildId": "",
"EC2InstanceType": ""
}, context)
Input
- input
object
- BuildId required BuildId
- Description NonZeroAndMaxString
- EC2InboundPermissions IpPermissionsList
- EC2InstanceType required EC2InstanceType
- FleetType FleetType
- LogPaths StringList
- MetricGroups MetricGroupList
- Name required NonZeroAndMaxString
- NewGameSessionProtectionPolicy ProtectionPolicy
- PeerVpcAwsAccountId NonZeroAndMaxString
- PeerVpcId NonZeroAndMaxString
- ResourceCreationLimitPolicy ResourceCreationLimitPolicy
- RuntimeConfiguration RuntimeConfiguration
- ServerLaunchParameters NonZeroAndMaxString
- ServerLaunchPath NonZeroAndMaxString
Output
- output CreateFleetOutput
CreateGameSession
amazonaws_gamelift.CreateGameSession({
"MaximumPlayerSessionCount": 0
}, context)
Input
- input
object
- AliasId AliasId
- CreatorId NonZeroAndMaxString
- FleetId FleetId
- GameProperties GamePropertyList
- GameSessionData GameSessionData
- GameSessionId IdStringModel
- IdempotencyToken IdStringModel
- MaximumPlayerSessionCount required WholeNumber
- Name NonZeroAndMaxString
Output
- output CreateGameSessionOutput
CreateGameSessionQueue
amazonaws_gamelift.CreateGameSessionQueue({
"Name": ""
}, context)
Input
- input
object
- Destinations GameSessionQueueDestinationList
- Name required GameSessionQueueName
- PlayerLatencyPolicies PlayerLatencyPolicyList
- TimeoutInSeconds WholeNumber
Output
- output CreateGameSessionQueueOutput
CreateMatchmakingConfiguration
amazonaws_gamelift.CreateMatchmakingConfiguration({
"Name": "",
"GameSessionQueueArns": [],
"RequestTimeoutSeconds": 0,
"AcceptanceRequired": true,
"RuleSetName": ""
}, context)
Input
- input
object
- AcceptanceRequired required BooleanModel
- AcceptanceTimeoutSeconds MatchmakingAcceptanceTimeoutInteger
- AdditionalPlayerCount WholeNumber
- CustomEventData CustomEventData
- Description NonZeroAndMaxString
- GameProperties GamePropertyList
- GameSessionData GameSessionData
- GameSessionQueueArns required QueueArnsList
- Name required MatchmakingIdStringModel
- NotificationTarget SnsArnStringModel
- RequestTimeoutSeconds required MatchmakingRequestTimeoutInteger
- RuleSetName required MatchmakingIdStringModel
Output
CreateMatchmakingRuleSet
amazonaws_gamelift.CreateMatchmakingRuleSet({
"Name": "",
"RuleSetBody": ""
}, context)
Input
- input
object
- Name required MatchmakingIdStringModel
- RuleSetBody required RuleSetBody
Output
CreatePlayerSession
amazonaws_gamelift.CreatePlayerSession({
"GameSessionId": "",
"PlayerId": ""
}, context)
Input
- input
object
- GameSessionId required ArnStringModel
- PlayerData PlayerData
- PlayerId required NonZeroAndMaxString
Output
- output CreatePlayerSessionOutput
CreatePlayerSessions
amazonaws_gamelift.CreatePlayerSessions({
"GameSessionId": "",
"PlayerIds": []
}, context)
Input
- input
object
- GameSessionId required ArnStringModel
- PlayerDataMap PlayerDataMap
- PlayerIds required PlayerIdList
Output
- output CreatePlayerSessionsOutput
CreateVpcPeeringAuthorization
amazonaws_gamelift.CreateVpcPeeringAuthorization({
"GameLiftAwsAccountId": "",
"PeerVpcId": ""
}, context)
Input
- input
object
- GameLiftAwsAccountId required NonZeroAndMaxString
- PeerVpcId required NonZeroAndMaxString
Output
CreateVpcPeeringConnection
amazonaws_gamelift.CreateVpcPeeringConnection({
"FleetId": "",
"PeerVpcAwsAccountId": "",
"PeerVpcId": ""
}, context)
Input
- input
object
- FleetId required FleetId
- PeerVpcAwsAccountId required NonZeroAndMaxString
- PeerVpcId required NonZeroAndMaxString
Output
DeleteAlias
amazonaws_gamelift.DeleteAlias({
"AliasId": ""
}, context)
Input
- input
object
- AliasId required AliasId
Output
Output schema unknown
DeleteBuild
amazonaws_gamelift.DeleteBuild({
"BuildId": ""
}, context)
Input
- input
object
- BuildId required BuildId
Output
Output schema unknown
DeleteFleet
amazonaws_gamelift.DeleteFleet({
"FleetId": ""
}, context)
Input
- input
object
- FleetId required FleetId
Output
Output schema unknown
DeleteGameSessionQueue
amazonaws_gamelift.DeleteGameSessionQueue({
"Name": ""
}, context)
Input
- input
object
- Name required GameSessionQueueName
Output
- output DeleteGameSessionQueueOutput
DeleteMatchmakingConfiguration
amazonaws_gamelift.DeleteMatchmakingConfiguration({
"Name": ""
}, context)
Input
- input
object
- Name required MatchmakingIdStringModel
Output
DeleteScalingPolicy
amazonaws_gamelift.DeleteScalingPolicy({
"Name": "",
"FleetId": ""
}, context)
Input
- input
object
- FleetId required FleetId
- Name required NonZeroAndMaxString
Output
Output schema unknown
DeleteVpcPeeringAuthorization
amazonaws_gamelift.DeleteVpcPeeringAuthorization({
"GameLiftAwsAccountId": "",
"PeerVpcId": ""
}, context)
Input
- input
object
- GameLiftAwsAccountId required NonZeroAndMaxString
- PeerVpcId required NonZeroAndMaxString
Output
DeleteVpcPeeringConnection
amazonaws_gamelift.DeleteVpcPeeringConnection({
"FleetId": "",
"VpcPeeringConnectionId": ""
}, context)
Input
- input
object
- FleetId required FleetId
- VpcPeeringConnectionId required NonZeroAndMaxString
Output
DescribeAlias
amazonaws_gamelift.DescribeAlias({
"AliasId": ""
}, context)
Input
- input
object
- AliasId required AliasId
Output
- output DescribeAliasOutput
DescribeBuild
amazonaws_gamelift.DescribeBuild({
"BuildId": ""
}, context)
Input
- input
object
- BuildId required BuildId
Output
- output DescribeBuildOutput
DescribeEC2InstanceLimits
amazonaws_gamelift.DescribeEC2InstanceLimits({}, context)
Input
- input
object
- EC2InstanceType EC2InstanceType
Output
DescribeFleetAttributes
amazonaws_gamelift.DescribeFleetAttributes({}, context)
Input
- input
object
- FleetIds FleetIdList
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
Output
DescribeFleetCapacity
amazonaws_gamelift.DescribeFleetCapacity({}, context)
Input
- input
object
- FleetIds FleetIdList
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
Output
- output DescribeFleetCapacityOutput
DescribeFleetEvents
amazonaws_gamelift.DescribeFleetEvents({
"FleetId": ""
}, context)
Input
- input
object
- EndTime Timestamp
- FleetId required FleetId
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- StartTime Timestamp
Output
- output DescribeFleetEventsOutput
DescribeFleetPortSettings
amazonaws_gamelift.DescribeFleetPortSettings({
"FleetId": ""
}, context)
Input
- input
object
- FleetId required FleetId
Output
DescribeFleetUtilization
amazonaws_gamelift.DescribeFleetUtilization({}, context)
Input
- input
object
- FleetIds FleetIdList
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
Output
DescribeGameSessionDetails
amazonaws_gamelift.DescribeGameSessionDetails({}, context)
Input
- input
object
- AliasId AliasId
- FleetId FleetId
- GameSessionId ArnStringModel
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- StatusFilter NonZeroAndMaxString
Output
DescribeGameSessionPlacement
amazonaws_gamelift.DescribeGameSessionPlacement({
"PlacementId": ""
}, context)
Input
- input
object
- PlacementId required IdStringModel
Output
DescribeGameSessionQueues
amazonaws_gamelift.DescribeGameSessionQueues({}, context)
Input
- input
object
- Limit PositiveInteger
- Names GameSessionQueueNameList
- NextToken NonZeroAndMaxString
Output
DescribeGameSessions
amazonaws_gamelift.DescribeGameSessions({}, context)
Input
- input
object
- AliasId AliasId
- FleetId FleetId
- GameSessionId ArnStringModel
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- StatusFilter NonZeroAndMaxString
Output
- output DescribeGameSessionsOutput
DescribeInstances
amazonaws_gamelift.DescribeInstances({
"FleetId": ""
}, context)
Input
- input
object
- FleetId required FleetId
- InstanceId InstanceId
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
Output
- output DescribeInstancesOutput
DescribeMatchmaking
amazonaws_gamelift.DescribeMatchmaking({
"TicketIds": []
}, context)
Input
- input
object
- TicketIds required MatchmakingIdList
Output
- output DescribeMatchmakingOutput
DescribeMatchmakingConfigurations
amazonaws_gamelift.DescribeMatchmakingConfigurations({}, context)
Input
- input
object
- Limit PositiveInteger
- Names MatchmakingIdList
- NextToken NonZeroAndMaxString
- RuleSetName MatchmakingIdStringModel
Output
DescribeMatchmakingRuleSets
amazonaws_gamelift.DescribeMatchmakingRuleSets({}, context)
Input
- input
object
- Limit RuleSetLimit
- Names MatchmakingRuleSetNameList
- NextToken NonZeroAndMaxString
Output
DescribePlayerSessions
amazonaws_gamelift.DescribePlayerSessions({}, context)
Input
- input
object
- GameSessionId ArnStringModel
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- PlayerId NonZeroAndMaxString
- PlayerSessionId PlayerSessionId
- PlayerSessionStatusFilter NonZeroAndMaxString
Output
- output DescribePlayerSessionsOutput
DescribeRuntimeConfiguration
amazonaws_gamelift.DescribeRuntimeConfiguration({
"FleetId": ""
}, context)
Input
- input
object
- FleetId required FleetId
Output
DescribeScalingPolicies
amazonaws_gamelift.DescribeScalingPolicies({
"FleetId": ""
}, context)
Input
- input
object
- FleetId required FleetId
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- StatusFilter ScalingStatusType
Output
DescribeVpcPeeringAuthorizations
amazonaws_gamelift.DescribeVpcPeeringAuthorizations({}, context)
Input
- input
object
Output
DescribeVpcPeeringConnections
amazonaws_gamelift.DescribeVpcPeeringConnections({}, context)
Input
- input
object
- FleetId FleetId
Output
GetGameSessionLogUrl
amazonaws_gamelift.GetGameSessionLogUrl({
"GameSessionId": ""
}, context)
Input
- input
object
- GameSessionId required ArnStringModel
Output
- output GetGameSessionLogUrlOutput
GetInstanceAccess
amazonaws_gamelift.GetInstanceAccess({
"FleetId": "",
"InstanceId": ""
}, context)
Input
- input
object
- FleetId required FleetId
- InstanceId required InstanceId
Output
- output GetInstanceAccessOutput
ListAliases
amazonaws_gamelift.ListAliases({}, context)
Input
- input
object
- Limit PositiveInteger
- Name NonEmptyString
- NextToken NonEmptyString
- RoutingStrategyType RoutingStrategyType
Output
- output ListAliasesOutput
ListBuilds
amazonaws_gamelift.ListBuilds({}, context)
Input
- input
object
- Limit PositiveInteger
- NextToken NonEmptyString
- Status BuildStatus
Output
- output ListBuildsOutput
ListFleets
amazonaws_gamelift.ListFleets({}, context)
Input
- input
object
- BuildId BuildId
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
Output
- output ListFleetsOutput
PutScalingPolicy
amazonaws_gamelift.PutScalingPolicy({
"Name": "",
"FleetId": "",
"ScalingAdjustment": 0,
"ScalingAdjustmentType": "",
"Threshold": 0,
"ComparisonOperator": "",
"EvaluationPeriods": 0,
"MetricName": ""
}, context)
Input
- input
object
- ComparisonOperator required ComparisonOperatorType
- EvaluationPeriods required PositiveInteger
- FleetId required FleetId
- MetricName required MetricName
- Name required NonZeroAndMaxString
- ScalingAdjustment required Integer
- ScalingAdjustmentType required ScalingAdjustmentType
- Threshold required Double
Output
- output PutScalingPolicyOutput
RequestUploadCredentials
amazonaws_gamelift.RequestUploadCredentials({
"BuildId": ""
}, context)
Input
- input
object
- BuildId required BuildId
Output
ResolveAlias
amazonaws_gamelift.ResolveAlias({
"AliasId": ""
}, context)
Input
- input
object
- AliasId required AliasId
Output
- output ResolveAliasOutput
SearchGameSessions
amazonaws_gamelift.SearchGameSessions({}, context)
Input
- input
object
- AliasId AliasId
- FilterExpression NonZeroAndMaxString
- FleetId FleetId
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- SortExpression NonZeroAndMaxString
Output
- output SearchGameSessionsOutput
StartGameSessionPlacement
amazonaws_gamelift.StartGameSessionPlacement({
"PlacementId": "",
"GameSessionQueueName": "",
"MaximumPlayerSessionCount": 0
}, context)
Input
- input
object
- DesiredPlayerSessions DesiredPlayerSessionList
- GameProperties GamePropertyList
- GameSessionData GameSessionData
- GameSessionName NonZeroAndMaxString
- GameSessionQueueName required GameSessionQueueName
- MaximumPlayerSessionCount required WholeNumber
- PlacementId required IdStringModel
- PlayerLatencies PlayerLatencyList
Output
StartMatchBackfill
amazonaws_gamelift.StartMatchBackfill({
"ConfigurationName": "",
"GameSessionArn": "",
"Players": []
}, context)
Input
- input
object
- ConfigurationName required MatchmakingIdStringModel
- GameSessionArn required ArnStringModel
- Players required PlayerList
- TicketId MatchmakingIdStringModel
Output
- output StartMatchBackfillOutput
StartMatchmaking
amazonaws_gamelift.StartMatchmaking({
"ConfigurationName": "",
"Players": []
}, context)
Input
- input
object
- ConfigurationName required MatchmakingIdStringModel
- Players required PlayerList
- TicketId MatchmakingIdStringModel
Output
- output StartMatchmakingOutput
StopGameSessionPlacement
amazonaws_gamelift.StopGameSessionPlacement({
"PlacementId": ""
}, context)
Input
- input
object
- PlacementId required IdStringModel
Output
StopMatchmaking
amazonaws_gamelift.StopMatchmaking({
"TicketId": ""
}, context)
Input
- input
object
- TicketId required MatchmakingIdStringModel
Output
- output StopMatchmakingOutput
UpdateAlias
amazonaws_gamelift.UpdateAlias({
"AliasId": ""
}, context)
Input
- input
object
- AliasId required AliasId
- Description NonZeroAndMaxString
- Name NonBlankAndLengthConstraintString
- RoutingStrategy RoutingStrategy
Output
- output UpdateAliasOutput
UpdateBuild
amazonaws_gamelift.UpdateBuild({
"BuildId": ""
}, context)
Input
- input
object
- BuildId required BuildId
- Name NonZeroAndMaxString
- Version NonZeroAndMaxString
Output
- output UpdateBuildOutput
UpdateFleetAttributes
amazonaws_gamelift.UpdateFleetAttributes({
"FleetId": ""
}, context)
Input
- input
object
- Description NonZeroAndMaxString
- FleetId required FleetId
- MetricGroups MetricGroupList
- Name NonZeroAndMaxString
- NewGameSessionProtectionPolicy ProtectionPolicy
- ResourceCreationLimitPolicy ResourceCreationLimitPolicy
Output
- output UpdateFleetAttributesOutput
UpdateFleetCapacity
amazonaws_gamelift.UpdateFleetCapacity({
"FleetId": ""
}, context)
Input
- input
object
- DesiredInstances WholeNumber
- FleetId required FleetId
- MaxSize WholeNumber
- MinSize WholeNumber
Output
- output UpdateFleetCapacityOutput
UpdateFleetPortSettings
amazonaws_gamelift.UpdateFleetPortSettings({
"FleetId": ""
}, context)
Input
- input
object
- FleetId required FleetId
- InboundPermissionAuthorizations IpPermissionsList
- InboundPermissionRevocations IpPermissionsList
Output
UpdateGameSession
amazonaws_gamelift.UpdateGameSession({
"GameSessionId": ""
}, context)
Input
- input
object
- GameSessionId required ArnStringModel
- MaximumPlayerSessionCount WholeNumber
- Name NonZeroAndMaxString
- PlayerSessionCreationPolicy PlayerSessionCreationPolicy
- ProtectionPolicy ProtectionPolicy
Output
- output UpdateGameSessionOutput
UpdateGameSessionQueue
amazonaws_gamelift.UpdateGameSessionQueue({
"Name": ""
}, context)
Input
- input
object
- Destinations GameSessionQueueDestinationList
- Name required GameSessionQueueName
- PlayerLatencyPolicies PlayerLatencyPolicyList
- TimeoutInSeconds WholeNumber
Output
- output UpdateGameSessionQueueOutput
UpdateMatchmakingConfiguration
amazonaws_gamelift.UpdateMatchmakingConfiguration({
"Name": ""
}, context)
Input
- input
object
- AcceptanceRequired BooleanModel
- AcceptanceTimeoutSeconds MatchmakingAcceptanceTimeoutInteger
- AdditionalPlayerCount WholeNumber
- CustomEventData CustomEventData
- Description NonZeroAndMaxString
- GameProperties GamePropertyList
- GameSessionData GameSessionData
- GameSessionQueueArns QueueArnsList
- Name required MatchmakingIdStringModel
- NotificationTarget SnsArnStringModel
- RequestTimeoutSeconds MatchmakingRequestTimeoutInteger
- RuleSetName MatchmakingIdStringModel
Output
UpdateRuntimeConfiguration
amazonaws_gamelift.UpdateRuntimeConfiguration({
"FleetId": "",
"RuntimeConfiguration": {}
}, context)
Input
- input
object
- FleetId required FleetId
- RuntimeConfiguration required RuntimeConfiguration
Output
ValidateMatchmakingRuleSet
amazonaws_gamelift.ValidateMatchmakingRuleSet({
"RuleSetBody": ""
}, context)
Input
- input
object
- RuleSetBody required RuleSetBody
Output
Definitions
AcceptMatchInput
- AcceptMatchInput
object
: Represents the input for a request action.- AcceptanceType required AcceptanceType
- PlayerIds required StringList
- TicketId required MatchmakingIdStringModel
AcceptMatchOutput
- AcceptMatchOutput
object
AcceptanceType
- AcceptanceType
string
(values: ACCEPT, REJECT)
Alias
- Alias
object
: Properties describing a fleet alias. Alias-related operations include: CreateAlias ListAliases DescribeAlias UpdateAlias DeleteAlias ResolveAlias- AliasArn ArnStringModel
- AliasId AliasId
- CreationTime Timestamp
- Description FreeText
- LastUpdatedTime Timestamp
- Name NonBlankAndLengthConstraintString
- RoutingStrategy RoutingStrategy
AliasId
- AliasId
string
AliasList
- AliasList
array
- items Alias
ArnStringModel
- ArnStringModel
string
AttributeValue
- AttributeValue
object
: Values for use in Player attribute key:value pairs. This object lets you specify an attribute value using any of the valid data types: string, number, string array or data map. Each AttributeValue object can use only one of the available properties.
AwsCredentials
- AwsCredentials
object
: Temporary access credentials used for uploading game build files to Amazon GameLift. They are valid for a limited time. If they expire before you upload your game build, get a new set by calling RequestUploadCredentials.- AccessKeyId NonEmptyString
- SecretAccessKey NonEmptyString
- SessionToken NonEmptyString
BooleanModel
- BooleanModel
boolean
Build
- Build
object
: Properties describing a game build. Build-related operations include: CreateBuild ListBuilds DescribeBuild UpdateBuild DeleteBuild- BuildId BuildId
- CreationTime Timestamp
- Name FreeText
- OperatingSystem OperatingSystem
- SizeOnDisk PositiveLong
- Status BuildStatus
- Version FreeText
BuildId
- BuildId
string
BuildList
- BuildList
array
- items Build
BuildStatus
- BuildStatus
string
(values: INITIALIZED, READY, FAILED)
ComparisonOperatorType
- ComparisonOperatorType
string
(values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold)
ConflictException
- ConflictException
object
: The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.- Message NonEmptyString
CreateAliasInput
- CreateAliasInput
object
: Represents the input for a request action.- Description NonZeroAndMaxString
- Name required NonBlankAndLengthConstraintString
- RoutingStrategy required RoutingStrategy
CreateAliasOutput
- CreateAliasOutput
object
: Represents the returned data in response to a request action.- Alias Alias
CreateBuildInput
- CreateBuildInput
object
: Represents the input for a request action.- Name NonZeroAndMaxString
- OperatingSystem OperatingSystem
- StorageLocation S3Location
- Version NonZeroAndMaxString
CreateBuildOutput
- CreateBuildOutput
object
: Represents the returned data in response to a request action.- Build Build
- StorageLocation S3Location
- UploadCredentials AwsCredentials
CreateFleetInput
- CreateFleetInput
object
: Represents the input for a request action.- BuildId required BuildId
- Description NonZeroAndMaxString
- EC2InboundPermissions IpPermissionsList
- EC2InstanceType required EC2InstanceType
- FleetType FleetType
- LogPaths StringList
- MetricGroups MetricGroupList
- Name required NonZeroAndMaxString
- NewGameSessionProtectionPolicy ProtectionPolicy
- PeerVpcAwsAccountId NonZeroAndMaxString
- PeerVpcId NonZeroAndMaxString
- ResourceCreationLimitPolicy ResourceCreationLimitPolicy
- RuntimeConfiguration RuntimeConfiguration
- ServerLaunchParameters NonZeroAndMaxString
- ServerLaunchPath NonZeroAndMaxString
CreateFleetOutput
- CreateFleetOutput
object
: Represents the returned data in response to a request action.- FleetAttributes FleetAttributes
CreateGameSessionInput
- CreateGameSessionInput
object
: Represents the input for a request action.- AliasId AliasId
- CreatorId NonZeroAndMaxString
- FleetId FleetId
- GameProperties GamePropertyList
- GameSessionData GameSessionData
- GameSessionId IdStringModel
- IdempotencyToken IdStringModel
- MaximumPlayerSessionCount required WholeNumber
- Name NonZeroAndMaxString
CreateGameSessionOutput
- CreateGameSessionOutput
object
: Represents the returned data in response to a request action.- GameSession GameSession
CreateGameSessionQueueInput
- CreateGameSessionQueueInput
object
: Represents the input for a request action.- Destinations GameSessionQueueDestinationList
- Name required GameSessionQueueName
- PlayerLatencyPolicies PlayerLatencyPolicyList
- TimeoutInSeconds WholeNumber
CreateGameSessionQueueOutput
- CreateGameSessionQueueOutput
object
: Represents the returned data in response to a request action.- GameSessionQueue GameSessionQueue
CreateMatchmakingConfigurationInput
- CreateMatchmakingConfigurationInput
object
: Represents the input for a request action.- AcceptanceRequired required BooleanModel
- AcceptanceTimeoutSeconds MatchmakingAcceptanceTimeoutInteger
- AdditionalPlayerCount WholeNumber
- CustomEventData CustomEventData
- Description NonZeroAndMaxString
- GameProperties GamePropertyList
- GameSessionData GameSessionData
- GameSessionQueueArns required QueueArnsList
- Name required MatchmakingIdStringModel
- NotificationTarget SnsArnStringModel
- RequestTimeoutSeconds required MatchmakingRequestTimeoutInteger
- RuleSetName required MatchmakingIdStringModel
CreateMatchmakingConfigurationOutput
- CreateMatchmakingConfigurationOutput
object
: Represents the returned data in response to a request action.- Configuration MatchmakingConfiguration
CreateMatchmakingRuleSetInput
- CreateMatchmakingRuleSetInput
object
: Represents the input for a request action.- Name required MatchmakingIdStringModel
- RuleSetBody required RuleSetBody
CreateMatchmakingRuleSetOutput
- CreateMatchmakingRuleSetOutput
object
: Represents the returned data in response to a request action.- RuleSet required MatchmakingRuleSet
CreatePlayerSessionInput
- CreatePlayerSessionInput
object
: Represents the input for a request action.- GameSessionId required ArnStringModel
- PlayerData PlayerData
- PlayerId required NonZeroAndMaxString
CreatePlayerSessionOutput
- CreatePlayerSessionOutput
object
: Represents the returned data in response to a request action.- PlayerSession PlayerSession
CreatePlayerSessionsInput
- CreatePlayerSessionsInput
object
: Represents the input for a request action.- GameSessionId required ArnStringModel
- PlayerDataMap PlayerDataMap
- PlayerIds required PlayerIdList
CreatePlayerSessionsOutput
- CreatePlayerSessionsOutput
object
: Represents the returned data in response to a request action.- PlayerSessions PlayerSessionList
CreateVpcPeeringAuthorizationInput
- CreateVpcPeeringAuthorizationInput
object
: Represents the input for a request action.- GameLiftAwsAccountId required NonZeroAndMaxString
- PeerVpcId required NonZeroAndMaxString
CreateVpcPeeringAuthorizationOutput
- CreateVpcPeeringAuthorizationOutput
object
: Represents the returned data in response to a request action.- VpcPeeringAuthorization VpcPeeringAuthorization
CreateVpcPeeringConnectionInput
- CreateVpcPeeringConnectionInput
object
: Represents the input for a request action.- FleetId required FleetId
- PeerVpcAwsAccountId required NonZeroAndMaxString
- PeerVpcId required NonZeroAndMaxString
CreateVpcPeeringConnectionOutput
- CreateVpcPeeringConnectionOutput
object
CustomEventData
- CustomEventData
string
DeleteAliasInput
- DeleteAliasInput
object
: Represents the input for a request action.- AliasId required AliasId
DeleteBuildInput
- DeleteBuildInput
object
: Represents the input for a request action.- BuildId required BuildId
DeleteFleetInput
- DeleteFleetInput
object
: Represents the input for a request action.- FleetId required FleetId
DeleteGameSessionQueueInput
- DeleteGameSessionQueueInput
object
: Represents the input for a request action.- Name required GameSessionQueueName
DeleteGameSessionQueueOutput
- DeleteGameSessionQueueOutput
object
DeleteMatchmakingConfigurationInput
- DeleteMatchmakingConfigurationInput
object
: Represents the input for a request action.- Name required MatchmakingIdStringModel
DeleteMatchmakingConfigurationOutput
- DeleteMatchmakingConfigurationOutput
object
DeleteScalingPolicyInput
- DeleteScalingPolicyInput
object
: Represents the input for a request action.- FleetId required FleetId
- Name required NonZeroAndMaxString
DeleteVpcPeeringAuthorizationInput
- DeleteVpcPeeringAuthorizationInput
object
: Represents the input for a request action.- GameLiftAwsAccountId required NonZeroAndMaxString
- PeerVpcId required NonZeroAndMaxString
DeleteVpcPeeringAuthorizationOutput
- DeleteVpcPeeringAuthorizationOutput
object
DeleteVpcPeeringConnectionInput
- DeleteVpcPeeringConnectionInput
object
: Represents the input for a request action.- FleetId required FleetId
- VpcPeeringConnectionId required NonZeroAndMaxString
DeleteVpcPeeringConnectionOutput
- DeleteVpcPeeringConnectionOutput
object
DescribeAliasInput
- DescribeAliasInput
object
: Represents the input for a request action.- AliasId required AliasId
DescribeAliasOutput
- DescribeAliasOutput
object
: Represents the returned data in response to a request action.- Alias Alias
DescribeBuildInput
- DescribeBuildInput
object
: Represents the input for a request action.- BuildId required BuildId
DescribeBuildOutput
- DescribeBuildOutput
object
: Represents the returned data in response to a request action.- Build Build
DescribeEC2InstanceLimitsInput
- DescribeEC2InstanceLimitsInput
object
: Represents the input for a request action.- EC2InstanceType EC2InstanceType
DescribeEC2InstanceLimitsOutput
- DescribeEC2InstanceLimitsOutput
object
: Represents the returned data in response to a request action.- EC2InstanceLimits EC2InstanceLimitList
DescribeFleetAttributesInput
- DescribeFleetAttributesInput
object
: Represents the input for a request action.- FleetIds FleetIdList
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
DescribeFleetAttributesOutput
- DescribeFleetAttributesOutput
object
: Represents the returned data in response to a request action.- FleetAttributes FleetAttributesList
- NextToken NonZeroAndMaxString
DescribeFleetCapacityInput
- DescribeFleetCapacityInput
object
: Represents the input for a request action.- FleetIds FleetIdList
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
DescribeFleetCapacityOutput
- DescribeFleetCapacityOutput
object
: Represents the returned data in response to a request action.- FleetCapacity FleetCapacityList
- NextToken NonZeroAndMaxString
DescribeFleetEventsInput
- DescribeFleetEventsInput
object
: Represents the input for a request action.- EndTime Timestamp
- FleetId required FleetId
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- StartTime Timestamp
DescribeFleetEventsOutput
- DescribeFleetEventsOutput
object
: Represents the returned data in response to a request action.- Events EventList
- NextToken NonZeroAndMaxString
DescribeFleetPortSettingsInput
- DescribeFleetPortSettingsInput
object
: Represents the input for a request action.- FleetId required FleetId
DescribeFleetPortSettingsOutput
- DescribeFleetPortSettingsOutput
object
: Represents the returned data in response to a request action.- InboundPermissions IpPermissionsList
DescribeFleetUtilizationInput
- DescribeFleetUtilizationInput
object
: Represents the input for a request action.- FleetIds FleetIdList
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
DescribeFleetUtilizationOutput
- DescribeFleetUtilizationOutput
object
: Represents the returned data in response to a request action.- FleetUtilization FleetUtilizationList
- NextToken NonZeroAndMaxString
DescribeGameSessionDetailsInput
- DescribeGameSessionDetailsInput
object
: Represents the input for a request action.- AliasId AliasId
- FleetId FleetId
- GameSessionId ArnStringModel
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- StatusFilter NonZeroAndMaxString
DescribeGameSessionDetailsOutput
- DescribeGameSessionDetailsOutput
object
: Represents the returned data in response to a request action.- GameSessionDetails GameSessionDetailList
- NextToken NonZeroAndMaxString
DescribeGameSessionPlacementInput
- DescribeGameSessionPlacementInput
object
: Represents the input for a request action.- PlacementId required IdStringModel
DescribeGameSessionPlacementOutput
- DescribeGameSessionPlacementOutput
object
: Represents the returned data in response to a request action.- GameSessionPlacement GameSessionPlacement
DescribeGameSessionQueuesInput
- DescribeGameSessionQueuesInput
object
: Represents the input for a request action.- Limit PositiveInteger
- Names GameSessionQueueNameList
- NextToken NonZeroAndMaxString
DescribeGameSessionQueuesOutput
- DescribeGameSessionQueuesOutput
object
: Represents the returned data in response to a request action.- GameSessionQueues GameSessionQueueList
- NextToken NonZeroAndMaxString
DescribeGameSessionsInput
- DescribeGameSessionsInput
object
: Represents the input for a request action.- AliasId AliasId
- FleetId FleetId
- GameSessionId ArnStringModel
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- StatusFilter NonZeroAndMaxString
DescribeGameSessionsOutput
- DescribeGameSessionsOutput
object
: Represents the returned data in response to a request action.- GameSessions GameSessionList
- NextToken NonZeroAndMaxString
DescribeInstancesInput
- DescribeInstancesInput
object
: Represents the input for a request action.- FleetId required FleetId
- InstanceId InstanceId
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
DescribeInstancesOutput
- DescribeInstancesOutput
object
: Represents the returned data in response to a request action.- Instances InstanceList
- NextToken NonZeroAndMaxString
DescribeMatchmakingConfigurationsInput
- DescribeMatchmakingConfigurationsInput
object
: Represents the input for a request action.- Limit PositiveInteger
- Names MatchmakingIdList
- NextToken NonZeroAndMaxString
- RuleSetName MatchmakingIdStringModel
DescribeMatchmakingConfigurationsOutput
- DescribeMatchmakingConfigurationsOutput
object
: Represents the returned data in response to a request action.- Configurations MatchmakingConfigurationList
- NextToken NonZeroAndMaxString
DescribeMatchmakingInput
- DescribeMatchmakingInput
object
: Represents the input for a request action.- TicketIds required MatchmakingIdList
DescribeMatchmakingOutput
- DescribeMatchmakingOutput
object
: Represents the returned data in response to a request action.- TicketList MatchmakingTicketList
DescribeMatchmakingRuleSetsInput
- DescribeMatchmakingRuleSetsInput
object
: Represents the input for a request action.- Limit RuleSetLimit
- Names MatchmakingRuleSetNameList
- NextToken NonZeroAndMaxString
DescribeMatchmakingRuleSetsOutput
- DescribeMatchmakingRuleSetsOutput
object
: Represents the returned data in response to a request action.- NextToken NonZeroAndMaxString
- RuleSets required MatchmakingRuleSetList
DescribePlayerSessionsInput
- DescribePlayerSessionsInput
object
: Represents the input for a request action.- GameSessionId ArnStringModel
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- PlayerId NonZeroAndMaxString
- PlayerSessionId PlayerSessionId
- PlayerSessionStatusFilter NonZeroAndMaxString
DescribePlayerSessionsOutput
- DescribePlayerSessionsOutput
object
: Represents the returned data in response to a request action.- NextToken NonZeroAndMaxString
- PlayerSessions PlayerSessionList
DescribeRuntimeConfigurationInput
- DescribeRuntimeConfigurationInput
object
: Represents the input for a request action.- FleetId required FleetId
DescribeRuntimeConfigurationOutput
- DescribeRuntimeConfigurationOutput
object
: Represents the returned data in response to a request action.- RuntimeConfiguration RuntimeConfiguration
DescribeScalingPoliciesInput
- DescribeScalingPoliciesInput
object
: Represents the input for a request action.- FleetId required FleetId
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- StatusFilter ScalingStatusType
DescribeScalingPoliciesOutput
- DescribeScalingPoliciesOutput
object
: Represents the returned data in response to a request action.- NextToken NonZeroAndMaxString
- ScalingPolicies ScalingPolicyList
DescribeVpcPeeringAuthorizationsInput
- DescribeVpcPeeringAuthorizationsInput
object
DescribeVpcPeeringAuthorizationsOutput
- DescribeVpcPeeringAuthorizationsOutput
object
- VpcPeeringAuthorizations VpcPeeringAuthorizationList
DescribeVpcPeeringConnectionsInput
- DescribeVpcPeeringConnectionsInput
object
: Represents the input for a request action.- FleetId FleetId
DescribeVpcPeeringConnectionsOutput
- DescribeVpcPeeringConnectionsOutput
object
: Represents the returned data in response to a request action.- VpcPeeringConnections VpcPeeringConnectionList
DesiredPlayerSession
- DesiredPlayerSession
object
: Player information for use when creating player sessions using a game session placement request with StartGameSessionPlacement.- PlayerData PlayerData
- PlayerId NonZeroAndMaxString
DesiredPlayerSessionList
- DesiredPlayerSessionList
array
- items DesiredPlayerSession
Double
- Double
number
DoubleObject
- DoubleObject
number
EC2InstanceCounts
- EC2InstanceCounts
object
: Current status of fleet capacity. The number of active instances should match or be in the process of matching the number of desired instances. Pending and terminating counts are non-zero only if fleet capacity is adjusting to an UpdateFleetCapacity request, or if access to resources is temporarily affected. Fleet-related operations include: CreateFleet ListFleets Describe fleets: DescribeFleetAttributes DescribeFleetPortSettings DescribeFleetUtilization DescribeRuntimeConfiguration DescribeFleetEvents Update fleets: UpdateFleetAttributes <