resumeGameServerGroup method

Future<ResumeGameServerGroupOutput> resumeGameServerGroup({
  1. required String gameServerGroupName,
  2. required List<GameServerGroupAction> resumeActions,
})

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Reinstates activity on a game server group after it has been suspended. A game server group might be suspended by theSuspendGameServerGroup operation, or it might be suspended involuntarily due to a configuration problem. In the second case, you can manually resume activity on the group once the configuration problem has been resolved. Refer to the game server group status and status reason for more information on why group activity is suspended.

To resume activity, specify a game server group ARN and the type of activity to be resumed. If successful, a GameServerGroup object is returned showing that the resumed activity is no longer listed in SuspendedActions.

Learn more

GameLift FleetIQ Guide

Related operations

May throw InvalidRequestException. May throw NotFoundException. May throw UnauthorizedException. May throw InternalServiceException.

Parameter gameServerGroupName : A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Parameter resumeActions : The activity to resume for this game server group.

Implementation

Future<ResumeGameServerGroupOutput> resumeGameServerGroup({
  required String gameServerGroupName,
  required List<GameServerGroupAction> resumeActions,
}) async {
  ArgumentError.checkNotNull(gameServerGroupName, 'gameServerGroupName');
  _s.validateStringLength(
    'gameServerGroupName',
    gameServerGroupName,
    1,
    256,
    isRequired: true,
  );
  ArgumentError.checkNotNull(resumeActions, 'resumeActions');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'GameLift.ResumeGameServerGroup'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'GameServerGroupName': gameServerGroupName,
      'ResumeActions': resumeActions.map((e) => e.toValue()).toList(),
    },
  );

  return ResumeGameServerGroupOutput.fromJson(jsonResponse.body);
}