Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeObservation

Describes an anomaly or error with the application.

Request Syntax


{
   "AccountId": "string",
   "ObservationId": "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.

AccountId

The AWS account ID for the resource group owner.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

Required: No

ObservationId

The ID of the observation.

Type: String

Length Constraints: Fixed length of 38.

Pattern: o-[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

Required: Yes

Response Syntax


{
   "Observation": { 
      "CloudWatchEventDetailType": "string",
      "CloudWatchEventId": "string",
      "CloudWatchEventSource": "string",
      "CodeDeployApplication": "string",
      "CodeDeployDeploymentGroup": "string",
      "CodeDeployDeploymentId": "string",
      "CodeDeployInstanceGroupId": "string",
      "CodeDeployState": "string",
      "EbsCause": "string",
      "EbsEvent": "string",
      "EbsRequestId": "string",
      "EbsResult": "string",
      "Ec2State": "string",
      "EndTime": number,
      "HealthEventArn": "string",
      "HealthEventDescription": "string",
      "HealthEventTypeCategory": "string",
      "HealthEventTypeCode": "string",
      "HealthService": "string",
      "Id": "string",
      "LineTime": number,
      "LogFilter": "string",
      "LogGroup": "string",
      "LogText": "string",
      "MetricName": "string",
      "MetricNamespace": "string",
      "RdsEventCategories": "string",
      "RdsEventMessage": "string",
      "S3EventName": "string",
      "SourceARN": "string",
      "SourceType": "string",
      "StartTime": number,
      "StatesArn": "string",
      "StatesExecutionArn": "string",
      "StatesInput": "string",
      "StatesStatus": "string",
      "Unit": "string",
      "Value": number,
      "XRayErrorPercent": number,
      "XRayFaultPercent": number,
      "XRayNodeName": "string",
      "XRayNodeType": "string",
      "XRayRequestAverageLatency": number,
      "XRayRequestCount": number,
      "XRayThrottlePercent": number
   }
}

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.

Observation

Information about the observation.

Type: Observation object

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