DescribeFleetEvents
Retrieves entries from a fleet's event log. Fleet events are initiated by changes in status, such as during fleet creation and termination, changes in capacity, etc. If a fleet has multiple locations, events are also initiated by changes to status and capacity in remote locations.
You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a collection of event log entries matching the request are returned.
Learn more
Setting up Amazon GameLift Servers fleets
Request Syntax
{
"EndTime": number,
"FleetId": "string",
"Limit": number,
"NextToken": "string",
"StartTime": number
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
- FleetId
-
A unique identifier for the fleet to get event logs for. You can use either the fleet ID or ARN value.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
^[a-z]*fleet-[a-zA-Z0-9\-]+$|^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$Required: Yes
- EndTime
-
The most recent date to retrieve event logs for. If no end time is specified, this call returns entries from the specified start time up to the present. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").
Type: Timestamp
Required: No
- Limit
-
The maximum number of results to return. Use this parameter with
NextTokento get results as a set of sequential pages.Type: Integer
Valid Range: Minimum value of 1.
Required: No
- NextToken
-
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- StartTime
-
The earliest date to retrieve event logs for. If no start time is specified, this call returns entries starting from when the fleet was created to the specified end time. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").
Type: Timestamp
Required: No
Response Syntax
{
"Events": [
{
"Count": number,
"EventCode": "string",
"EventId": "string",
"EventTime": number,
"Message": "string",
"PreSignedLogUrl": "string",
"ResourceId": "string"
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Events
-
A collection of objects containing event log entries for the specified fleet.
Type: Array of Event objects
- NextToken
-
A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
HTTP Status Code: 500
- InvalidRequestException
-
One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
HTTP Status Code: 400
- NotFoundException
-
The requested resources was not found. The resource was either not created yet or deleted.
HTTP Status Code: 400
- UnauthorizedException
-
The client failed authentication. Clients should not retry such requests.
HTTP Status Code: 400
- UnsupportedRegionException
-
The requested operation is not supported in the Region specified.
HTTP Status Code: 400
Examples
Request events for a specified time span
This example returns all events that occurred for the fleet during the specified time span. In this example, the time span is on January 21, 2020, from 15:45:00 to 16:15:00 (local time).
HTTP requests are authenticated using an AWS Signature Version 4 signature in the Authorization header field.
Sample Request
{
"FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
"StartTime": 1579647600,
"EndTime": 1579649400,
"Limit": 5
}Sample Response
{
"Events": [
{
"EventId": "a37b6892-5d07-4d3b-8b47-80244ecf66b9",
"ResourceId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
"EventCode": "FLEET_STATE_ACTIVE",
"Message": "Fleet fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa changed state to ACTIVE",
"EventTime": 1579649342.191
},
{
"EventId": "67da4ec9-92a3-4d95-886a-5d6772c24063",
"ResourceId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
"EventCode": "FLEET_STATE_ACTIVATING",
"Message": "Fleet fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa changed state to ACTIVATING",
"EventTime": 1579649321.427
},
{
"EventId": "23813a46-a9e6-4a53-8847-f12e6a8381ac",
"ResourceId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
"EventCode": "FLEET_STATE_BUILDING",
"Message": "Fleet fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa changed state to BUILDING",
"EventTime": 1579649321.243
},
{
"EventId": "3bf217d0-1d44-42f9-9202-433ed475d2e8",
"ResourceId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
"EventCode": "FLEET_STATE_VALIDATING",
"Message": "Fleet fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa changed state to VALIDATING",
"EventTime": 1579649197.449
},
{
"EventId": "2ecd0130-5986-44eb-99a7-62df27741084",
"ResourceId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
"EventCode": "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND",
"Message": "Failed to find a valid path",
"EventTime": 1569319075.839,
"PreSignedLogUrl": "https://gamelift-event-logs-prod-us-west-2.s3.us-west-2.amazonaws.com/logs/fleet-83422059-8329-42a2-a4d6-c4444386a6f8/events/2ecd0130-5986-44eb-99a7-62df27741084/FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND.txt?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEB8aCXVzLXdlc3QtMiJHMEUCIHV5K%2FLPx8h310D%2FAvx0%2FZxsDy5XA3cJOwPdu3T0eBa%2FAiEA1yovokcZYy%2FV4CWW6l26aFyiSHO%2Bxz%2FBMAhEHYHMQNcqkQMImP%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAAGgw3NDEwNjE1OTIxNzEiDI8rsZtzLzlwEDQhXSrlAtl5Ae%2Fgo6FCIzqXPbXfBOnSvFYqeDlriZarEpKqKrUt8mXQv9iqHResqCph9AKo49lwgSYTT2QoSxnrD7%2FUgv%2BZm2pVuczvuKtUA0fcx6s0GxpjIAzdIE%2F5P%2FB7B9M%2BVZ%2F9KF82hbJi0HTE6Y7BjKsEgFCvk4UXILhfjtan9iQl8%2F21ZTurAcJbm7Y5tuLF9SWSK3%2BEa7VXOcCK4D4O1sMjmdRm0q0CKZ%2FIaXoHkNvg0RVTa0hIqdvpaDQlsSBNdqTXbjHTu6fETE9Y9Ky%2BiJK5KiUG%2F59GjCpDcvS1FqKeLUEmKT7wysGmvjMc2n%2Fr%2F9VxQfte7w9srXwlLAQuwhiXAAyI5ICMZ5JvzjzQwTqD4CHTVKUUDwL%2BRZzbuuqkJObZml02CkRGp%2B74RTAzLbWptVqZTIfzctiCTmWxb%2FmKyELRYsVLrwNJ%2BGJ7%2BCrN0RC%2FjlgfLYIZyeAqjPgAu5HjgX%2BM7jCo9M7wBTrnAXKOFQuf9dvA84SuwXOJFp17LYGjrHMKv0qC3GfbTMrZ6kzeNV9awKCpXB2Gnx9z2KvIlJdqirWVpvHVGwKCmJBCesDzjJHrae3neogI1uW%2F9C6%2B4jIZPME3jXmZcEHqqw5uvAVF7aeIavtUZU8pxpDIWT0YE4p3Kriy2AA7ziCRKtVfjV839InyLk8LUjsioWK2qlpg2HXKFLpAXw1QsQyxYmFMB9sGKOUlbL7Jdkk%2BYUq8%2FDTlLxqj1S%2FiO4TI0Wo7ilAo%2FKKWWF4guuNDexj8EOOynSp1yImB%2BZf2Fua3O44W4eEXAMPLE33333&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20170621T231808Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20170621%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
}
],
"NextToken": "eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjEXAMPLE2"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
