Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListConfigurationHistory

Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are:

INFO: creating a new alarm or updating an alarm threshold.
WARN: alarm not created due to insufficient data points used to predict thresholds.
ERROR: alarm not created due to permission errors or exceeding quotas.

Request Syntax


{
   "AccountId": "string",
   "EndTime": number,
   "EventStatus": "string",
   "MaxResults": number,
   "NextToken": "string",
   "ResourceGroupName": "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.

AccountId

The AWS account ID for the resource group owner.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

Required: No

EndTime

The end time of the event.

Type: Timestamp

Required: No

EventStatus

The status of the configuration update event. Possible values include INFO, WARN, and ERROR.

Type: String

Valid Values: INFO | WARN | ERROR

Required: No

MaxResults

The maximum number of results returned by ListConfigurationHistory in paginated output. When this parameter is used, ListConfigurationHistory returns only MaxResults in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another ListConfigurationHistory request with the returned NextToken value. If this parameter is not used, then ListConfigurationHistory returns all results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 40.

Required: No

NextToken

The NextToken value returned from a previous paginated ListConfigurationHistory request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

Type: String

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

Pattern: .+

Required: No

ResourceGroupName

Resource group to which the application belongs.

Type: String

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

Pattern: [a-zA-Z0-9\.\-_]*

Required: No

StartTime

The start time of the event.

Type: Timestamp

Required: No

Response Syntax


{
   "EventList": [ 
      { 
         "AccountId": "string",
         "EventDetail": "string",
         "EventResourceName": "string",
         "EventResourceType": "string",
         "EventStatus": "string",
         "EventTime": number,
         "MonitoredResourceARN": "string",
         "ResourceGroupName": "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.

EventList

The list of configuration events and their corresponding details.

Type: Array of ConfigurationEvent objects

NextToken

The NextToken value to include in a future ListConfigurationHistory request. When the results of a ListConfigurationHistory request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

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

Pattern: .+

Errors

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

InternalServerException

The server encountered an internal error and is unable to complete the request.

HTTP Status Code: 400

ResourceNotFoundException

The resource does not exist in the customer account.

HTTP Status Code: 400

ValidationException

The parameter is not valid.

HTTP Status Code: 400