amazonka-gamelift-2.0: Amazon GameLift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GameLift.UpdateGameSessionQueue

Description

Updates the configuration of a game session queue, which determines how the queue processes new game session requests. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.

Learn more

Using Multi-Region Queues

Synopsis

Creating a Request

data UpdateGameSessionQueue Source #

See: newUpdateGameSessionQueue smart constructor.

Constructors

UpdateGameSessionQueue' 

Fields

  • customEventData :: Maybe Text

    Information to be added to all events that are related to this game session queue.

  • destinations :: Maybe [GameSessionQueueDestination]

    A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. 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 :: Maybe FilterConfiguration

    A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.

  • notificationTarget :: Maybe Text

    An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

  • playerLatencyPolicies :: Maybe [PlayerLatencyPolicy]

    A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.

  • priorityConfiguration :: Maybe PriorityConfiguration

    Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. To remove an existing priority configuration, pass in an empty set.

  • timeoutInSeconds :: Maybe Natural

    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.

  • name :: Text

    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.

Instances

Instances details
ToJSON UpdateGameSessionQueue Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

ToHeaders UpdateGameSessionQueue Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

ToPath UpdateGameSessionQueue Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

ToQuery UpdateGameSessionQueue Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

AWSRequest UpdateGameSessionQueue Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

Associated Types

type AWSResponse UpdateGameSessionQueue #

Generic UpdateGameSessionQueue Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

Associated Types

type Rep UpdateGameSessionQueue :: Type -> Type #

Read UpdateGameSessionQueue Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

Show UpdateGameSessionQueue Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

NFData UpdateGameSessionQueue Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

Methods

rnf :: UpdateGameSessionQueue -> () #

Eq UpdateGameSessionQueue Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

Hashable UpdateGameSessionQueue Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

type AWSResponse UpdateGameSessionQueue Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

type Rep UpdateGameSessionQueue Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

type Rep UpdateGameSessionQueue = D1 ('MetaData "UpdateGameSessionQueue" "Amazonka.GameLift.UpdateGameSessionQueue" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "UpdateGameSessionQueue'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "customEventData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "destinations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GameSessionQueueDestination]))) :*: (S1 ('MetaSel ('Just "filterConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FilterConfiguration)) :*: S1 ('MetaSel ('Just "notificationTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "playerLatencyPolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PlayerLatencyPolicy])) :*: S1 ('MetaSel ('Just "priorityConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PriorityConfiguration))) :*: (S1 ('MetaSel ('Just "timeoutInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateGameSessionQueue Source #

Create a value of UpdateGameSessionQueue with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateGameSessionQueue, updateGameSessionQueue_customEventData - Information to be added to all events that are related to this game session queue.

UpdateGameSessionQueue, updateGameSessionQueue_destinations - A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. 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.

UpdateGameSessionQueue, updateGameSessionQueue_filterConfiguration - A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.

UpdateGameSessionQueue, updateGameSessionQueue_notificationTarget - An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

UpdateGameSessionQueue, updateGameSessionQueue_playerLatencyPolicies - A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.

UpdateGameSessionQueue, updateGameSessionQueue_priorityConfiguration - Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. To remove an existing priority configuration, pass in an empty set.

UpdateGameSessionQueue, updateGameSessionQueue_timeoutInSeconds - 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.

UpdateGameSessionQueue, updateGameSessionQueue_name - 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.

Request Lenses

updateGameSessionQueue_customEventData :: Lens' UpdateGameSessionQueue (Maybe Text) Source #

Information to be added to all events that are related to this game session queue.

updateGameSessionQueue_destinations :: Lens' UpdateGameSessionQueue (Maybe [GameSessionQueueDestination]) Source #

A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. 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.

updateGameSessionQueue_filterConfiguration :: Lens' UpdateGameSessionQueue (Maybe FilterConfiguration) Source #

A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.

updateGameSessionQueue_notificationTarget :: Lens' UpdateGameSessionQueue (Maybe Text) Source #

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

updateGameSessionQueue_playerLatencyPolicies :: Lens' UpdateGameSessionQueue (Maybe [PlayerLatencyPolicy]) Source #

A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.

updateGameSessionQueue_priorityConfiguration :: Lens' UpdateGameSessionQueue (Maybe PriorityConfiguration) Source #

Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. To remove an existing priority configuration, pass in an empty set.

updateGameSessionQueue_timeoutInSeconds :: Lens' UpdateGameSessionQueue (Maybe Natural) Source #

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.

updateGameSessionQueue_name :: Lens' UpdateGameSessionQueue Text Source #

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.

Destructuring the Response

data UpdateGameSessionQueueResponse Source #

See: newUpdateGameSessionQueueResponse smart constructor.

Constructors

UpdateGameSessionQueueResponse' 

Fields

Instances

Instances details
Generic UpdateGameSessionQueueResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

Associated Types

type Rep UpdateGameSessionQueueResponse :: Type -> Type #

Read UpdateGameSessionQueueResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

Show UpdateGameSessionQueueResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

NFData UpdateGameSessionQueueResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

Eq UpdateGameSessionQueueResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

type Rep UpdateGameSessionQueueResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateGameSessionQueue

type Rep UpdateGameSessionQueueResponse = D1 ('MetaData "UpdateGameSessionQueueResponse" "Amazonka.GameLift.UpdateGameSessionQueue" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "UpdateGameSessionQueueResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameSessionQueue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GameSessionQueue)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateGameSessionQueueResponse Source #

Create a value of UpdateGameSessionQueueResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:gameSessionQueue:UpdateGameSessionQueueResponse', updateGameSessionQueueResponse_gameSessionQueue - An object that describes the newly updated game session queue.

$sel:httpStatus:UpdateGameSessionQueueResponse', updateGameSessionQueueResponse_httpStatus - The response's http status code.

Response Lenses