Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeEvents

Describes events for a specified server. Results are ordered by time, with newest events first.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "ServerName": "string"
}

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.

MaxResults

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Required: No

ServerName

The name of the server for which you want to view events.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 40.

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

Required: Yes

Response Syntax


{
   "NextToken": "string",
   "ServerEvents": [ 
      { 
         "CreatedAt": number,
         "LogUrl": "string",
         "Message": "string",
         "ServerName": "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.

NextToken

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

ServerEvents

Contains the response to a DescribeEvents request.

Type: Array of ServerEvent objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidNextTokenException

This occurs when the provided nextToken is not valid.

Message: Error or informational message that can contain more detail about a nextToken failure.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource does not exist, or access was denied.

Message: Error or informational message that can contain more detail about problems locating or accessing a resource.

HTTP Status Code: 400

ValidationException

One or more of the provided request parameters are not valid.

Message: Error or informational message that can contain more detail about a validation failure.

HTTP Status Code: 400