ResumeGameServerGroupCommand

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 the SuspendGameServerGroup  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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { GameLiftClient, ResumeGameServerGroupCommand } from "@aws-sdk/client-gamelift"; // ES Modules import
// const { GameLiftClient, ResumeGameServerGroupCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import
const client = new GameLiftClient(config);
const input = { // ResumeGameServerGroupInput
  GameServerGroupName: "STRING_VALUE", // required
  ResumeActions: [ // GameServerGroupActions // required
    "REPLACE_INSTANCE_TYPES",
  ],
};
const command = new ResumeGameServerGroupCommand(input);
const response = await client.send(command);
// { // ResumeGameServerGroupOutput
//   GameServerGroup: { // GameServerGroup
//     GameServerGroupName: "STRING_VALUE",
//     GameServerGroupArn: "STRING_VALUE",
//     RoleArn: "STRING_VALUE",
//     InstanceDefinitions: [ // InstanceDefinitions
//       { // InstanceDefinition
//         InstanceType: "c4.large" || "c4.xlarge" || "c4.2xlarge" || "c4.4xlarge" || "c4.8xlarge" || "c5.large" || "c5.xlarge" || "c5.2xlarge" || "c5.4xlarge" || "c5.9xlarge" || "c5.12xlarge" || "c5.18xlarge" || "c5.24xlarge" || "c5a.large" || "c5a.xlarge" || "c5a.2xlarge" || "c5a.4xlarge" || "c5a.8xlarge" || "c5a.12xlarge" || "c5a.16xlarge" || "c5a.24xlarge" || "c6g.medium" || "c6g.large" || "c6g.xlarge" || "c6g.2xlarge" || "c6g.4xlarge" || "c6g.8xlarge" || "c6g.12xlarge" || "c6g.16xlarge" || "r4.large" || "r4.xlarge" || "r4.2xlarge" || "r4.4xlarge" || "r4.8xlarge" || "r4.16xlarge" || "r5.large" || "r5.xlarge" || "r5.2xlarge" || "r5.4xlarge" || "r5.8xlarge" || "r5.12xlarge" || "r5.16xlarge" || "r5.24xlarge" || "r5a.large" || "r5a.xlarge" || "r5a.2xlarge" || "r5a.4xlarge" || "r5a.8xlarge" || "r5a.12xlarge" || "r5a.16xlarge" || "r5a.24xlarge" || "r6g.medium" || "r6g.large" || "r6g.xlarge" || "r6g.2xlarge" || "r6g.4xlarge" || "r6g.8xlarge" || "r6g.12xlarge" || "r6g.16xlarge" || "m4.large" || "m4.xlarge" || "m4.2xlarge" || "m4.4xlarge" || "m4.10xlarge" || "m5.large" || "m5.xlarge" || "m5.2xlarge" || "m5.4xlarge" || "m5.8xlarge" || "m5.12xlarge" || "m5.16xlarge" || "m5.24xlarge" || "m5a.large" || "m5a.xlarge" || "m5a.2xlarge" || "m5a.4xlarge" || "m5a.8xlarge" || "m5a.12xlarge" || "m5a.16xlarge" || "m5a.24xlarge" || "m6g.medium" || "m6g.large" || "m6g.xlarge" || "m6g.2xlarge" || "m6g.4xlarge" || "m6g.8xlarge" || "m6g.12xlarge" || "m6g.16xlarge", // required
//         WeightedCapacity: "STRING_VALUE",
//       },
//     ],
//     BalancingStrategy: "SPOT_ONLY" || "SPOT_PREFERRED" || "ON_DEMAND_ONLY",
//     GameServerProtectionPolicy: "NO_PROTECTION" || "FULL_PROTECTION",
//     AutoScalingGroupArn: "STRING_VALUE",
//     Status: "NEW" || "ACTIVATING" || "ACTIVE" || "DELETE_SCHEDULED" || "DELETING" || "DELETED" || "ERROR",
//     StatusReason: "STRING_VALUE",
//     SuspendedActions: [ // GameServerGroupActions
//       "REPLACE_INSTANCE_TYPES",
//     ],
//     CreationTime: new Date("TIMESTAMP"),
//     LastUpdatedTime: new Date("TIMESTAMP"),
//   },
// };

ResumeGameServerGroupCommand Input

Parameter
Type
Description
GameServerGroupName
Required
string | undefined

A unique identifier for the game server group. Use either the name or ARN value.

ResumeActions
Required
GameServerGroupAction[] | undefined

The activity to resume for this game server group.

ResumeGameServerGroupCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
GameServerGroup
GameServerGroup | undefined

An object that describes the game server group resource, with the SuspendedActions property updated to reflect the resumed activity.

Throws

Name
Fault
Details
InternalServiceException
server

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

InvalidRequestException
client

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

NotFoundException
client

The requested resources was not found. The resource was either not created yet or deleted.

UnauthorizedException
client

The client failed authentication. Clients should not retry such requests.

GameLiftServiceException
Base exception class for all service exceptions from GameLift service.