

# ListEvents
<a name="API_ListEvents"></a>

 Returns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned. 

## Request Syntax
<a name="API_ListEvents_RequestSyntax"></a>

```
POST /events HTTP/1.1
Content-type: application/json

{
   "AccountId": "string",
   "Filters": { 
      "DataSource": "string",
      "EventClass": "string",
      "EventSource": "string",
      "EventTimeRange": { 
         "FromTime": number,
         "ToTime": number
      },
      "InsightId": "string",
      "ResourceCollection": { 
         "CloudFormation": { 
            "StackNames": [ "string" ]
         },
         "Tags": [ 
            { 
               "AppBoundaryKey": "string",
               "TagValues": [ "string" ]
            }
         ]
      }
   },
   "MaxResults": number,
   "NextToken": "string"
}
```

## URI Request Parameters
<a name="API_ListEvents_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ListEvents_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AccountId](#API_ListEvents_RequestSyntax) **   <a name="DevOpsGuru-ListEvents-request-AccountId"></a>
The ID of the AWS account.   
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `^\d{12}$`   
Required: No

 ** [Filters](#API_ListEvents_RequestSyntax) **   <a name="DevOpsGuru-ListEvents-request-Filters"></a>
 A `ListEventsFilters` object used to specify which events to return.   
Type: [ListEventsFilters](API_ListEventsFilters.md) object  
Required: Yes

 ** [MaxResults](#API_ListEvents_RequestSyntax) **   <a name="DevOpsGuru-ListEvents-request-MaxResults"></a>
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 200.  
Required: No

 ** [NextToken](#API_ListEvents_RequestSyntax) **   <a name="DevOpsGuru-ListEvents-request-NextToken"></a>
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: No

## Response Syntax
<a name="API_ListEvents_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Events": [ 
      { 
         "DataSource": "string",
         "EventClass": "string",
         "EventSource": "string",
         "Id": "string",
         "Name": "string",
         "ResourceCollection": { 
            "CloudFormation": { 
               "StackNames": [ "string" ]
            },
            "Tags": [ 
               { 
                  "AppBoundaryKey": "string",
                  "TagValues": [ "string" ]
               }
            ]
         },
         "Resources": [ 
            { 
               "Arn": "string",
               "Name": "string",
               "Type": "string"
            }
         ],
         "Time": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListEvents_ResponseElements"></a>

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](#API_ListEvents_ResponseSyntax) **   <a name="DevOpsGuru-ListEvents-response-Events"></a>
 A list of the requested events.   
Type: Array of [Event](API_Event.md) objects

 ** [NextToken](#API_ListEvents_ResponseSyntax) **   <a name="DevOpsGuru-ListEvents-response-NextToken"></a>
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` 

## Errors
<a name="API_ListEvents_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see [Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) in the *IAM User Guide*.   
HTTP Status Code: 403

 ** InternalServerException **   
An internal failure in an Amazon service occurred.    
 ** RetryAfterSeconds **   
 The number of seconds after which the action that caused the internal server exception can be retried. 
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A requested resource could not be found    
 ** ResourceId **   
 The ID of the AWS resource that could not be found.   
 ** ResourceType **   
 The type of the AWS resource that could not be found. 
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to a request throttling.    
 ** QuotaCode **   
 The code of the quota that was exceeded, causing the throttling exception.   
 ** RetryAfterSeconds **   
 The number of seconds after which the action that caused the throttling exception can be retried.   
 ** ServiceCode **   
 The code of the service that caused the throttling exception. 
HTTP Status Code: 429

 ** ValidationException **   
 Contains information about data passed in to a field during a request that is not valid.     
 ** Fields **   
 An array of fields that are associated with the validation exception.   
 ** Message **   
 A message that describes the validation exception.   
 ** Reason **   
 The reason the validation exception was thrown. 
HTTP Status Code: 400

## See Also
<a name="API_ListEvents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devops-guru-2020-12-01/ListEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devops-guru-2020-12-01/ListEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devops-guru-2020-12-01/ListEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devops-guru-2020-12-01/ListEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devops-guru-2020-12-01/ListEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devops-guru-2020-12-01/ListEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devops-guru-2020-12-01/ListEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devops-guru-2020-12-01/ListEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devops-guru-2020-12-01/ListEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devops-guru-2020-12-01/ListEvents) 