matchmakings
Creates, updates, deletes, gets or lists a matchmakings resource.
Overview
| Name | matchmakings |
| Type | Resource |
| Id | aws.gamelift.matchmakings |
Fields
The following fields are returned by SELECT queries:
- describe_matchmaking
| Name | Datatype | Description |
|---|---|---|
ticket_list | array | A collection of existing matchmaking ticket objects matching the request. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_matchmaking | select | region | This API works with the following fleet types: EC2, Anywhere, Container Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection information for the resulting new game session. To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists. This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration. Learn more Add FlexMatch to a game client Set Up FlexMatch event notification | |
validate_matchmaking_rule_set | exec | region, RuleSetBody | This API works with the following fleet types: EC2, Anywhere, Container Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string. Learn more Build a rule set |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_matchmaking
This API works with the following fleet types: EC2, Anywhere, Container Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection information for the resulting new game session. To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists. This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration. Learn more Add FlexMatch to a game client Set Up FlexMatch event notification
SELECT
ticket_list
FROM aws.gamelift.matchmakings
WHERE region = '{{ region }}' -- required
;
Lifecycle Methods
- validate_matchmaking_rule_set
This API works with the following fleet types: EC2, Anywhere, Container Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string. Learn more Build a rule set
EXEC aws.gamelift.matchmakings.validate_matchmaking_rule_set
@region='{{ region }}' --required
@@json=
'{
"RuleSetBody": "{{ RuleSetBody }}"
}'
;