Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeEvents

Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.

If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent event.

Note

When you call the DescribeEvents operation and specify an entity for the entityValues parameter, AWS Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, AWS Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event.
This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

Request Syntax


{
   "filter": { 
      "availabilityZones": [ "string" ],
      "endTimes": [ 
         { 
            "from": number,
            "to": number
         }
      ],
      "entityArns": [ "string" ],
      "entityValues": [ "string" ],
      "eventArns": [ "string" ],
      "eventStatusCodes": [ "string" ],
      "eventTypeCategories": [ "string" ],
      "eventTypeCodes": [ "string" ],
      "lastUpdatedTimes": [ 
         { 
            "from": number,
            "to": number
         }
      ],
      "regions": [ "string" ],
      "services": [ "string" ],
      "startTimes": [ 
         { 
            "from": number,
            "to": number
         }
      ],
      "tags": [ 
         { 
            "string" : "string" 
         }
      ]
   },
   "locale": "string",
   "maxResults": number,
   "nextToken": "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.

filter

Values to narrow the results returned.

Type: EventFilter object

Required: No

locale

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 256.

Pattern: .{2,256}

Required: No

maxResults

The maximum number of items to return in one batch, between 10 and 100, inclusive.

Type: Integer

Valid Range: Minimum value of 10. Maximum value of 100.

Required: No

nextToken

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 10000.

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Required: No

Response Syntax


{
   "events": [ 
      { 
         "arn": "string",
         "availabilityZone": "string",
         "endTime": number,
         "eventScopeCode": "string",
         "eventTypeCategory": "string",
         "eventTypeCode": "string",
         "lastUpdatedTime": number,
         "region": "string",
         "service": "string",
         "startTime": number,
         "statusCode": "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

The events that match the specified filter criteria.

Type: Array of Event objects

nextToken

Type: String

Length Constraints: Minimum length of 4. Maximum length of 10000.

Pattern: [a-zA-Z0-9=/+_.-]{4,10000}

Errors

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

InvalidPaginationToken

The specified pagination token (nextToken) is not valid.

HTTP Status Code: 400

UnsupportedLocale

The specified locale is not supported.

HTTP Status Code: 400