StartMatchBackfillInput

public struct StartMatchBackfillInput : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property.

    Declaration

    Swift

    public let configurationName: String

  • Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it. This is the same as the game session ID.

    Declaration

    Swift

    public let gameSessionArn: String

  • Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game. PlayerID, PlayerAttributes, Team -- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data. LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.

    Declaration

    Swift

    public let players: [Player]

  • A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.

    Declaration

    Swift

    public let ticketId: String?

  • Undocumented

    Declaration

    Swift

    public init(configurationName: String, gameSessionArn: String, players: [Player], ticketId: String? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws