[ aws . application-insights ]

describe-observation

Description

Describes an anomaly or error with the application.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-observation
--observation-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--observation-id (string)

The ID of the observation.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Observation -> (structure)

Information about the observation.

Id -> (string)

The ID of the observation type.

StartTime -> (timestamp)

The time when the observation was first detected, in epoch seconds.

EndTime -> (timestamp)

The time when the observation ended, in epoch seconds.

SourceType -> (string)

The source type of the observation.

SourceARN -> (string)

The source resource ARN of the observation.

LogGroup -> (string)

The log group name.

LineTime -> (timestamp)

The timestamp in the CloudWatch Logs that specifies when the matched line occurred.

LogText -> (string)

The log text of the observation.

LogFilter -> (string)

The log filter of the observation.

MetricNamespace -> (string)

The namespace of the observation metric.

MetricName -> (string)

The name of the observation metric.

Unit -> (string)

The unit of the source observation metric.

Value -> (double)

The value of the source observation metric.

CloudWatchEventId -> (string)

The ID of the CloudWatch Event-based observation related to the detected problem.

CloudWatchEventSource -> (string)

The source of the CloudWatch Event.

CloudWatchEventDetailType -> (string)

The detail type of the CloudWatch Event-based observation, for example, EC2 Instance State-change Notification .

HealthEventArn -> (string)

The Amazon Resource Name (ARN) of the AWS Health Event-based observation.

HealthService -> (string)

The service to which the AWS Health Event belongs, such as EC2.

HealthEventTypeCode -> (string)

The type of the AWS Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE .

HealthEventTypeCategory -> (string)

The category of the AWS Health event, such as issue .

HealthEventDescription -> (string)

The description of the AWS Health event provided by the service, such as Amazon EC2.

CodeDeployDeploymentId -> (string)

The deployment ID of the CodeDeploy-based observation related to the detected problem.

CodeDeployDeploymentGroup -> (string)

The deployment group to which the CodeDeploy deployment belongs.

CodeDeployState -> (string)

The status of the CodeDeploy deployment, for example SUCCESS or FAILURE .

CodeDeployApplication -> (string)

The CodeDeploy application to which the deployment belongs.

CodeDeployInstanceGroupId -> (string)

The instance group to which the CodeDeploy instance belongs.

Ec2State -> (string)

The state of the instance, such as STOPPING or TERMINATING .

RdsEventCategories -> (string)

The category of an RDS event.

RdsEventMessage -> (string)

The message of an RDS event.

S3EventName -> (string)

The name of the S3 CloudWatch Event-based observation.

StatesExecutionArn -> (string)

The Amazon Resource Name (ARN) of the step function execution-based observation.

StatesArn -> (string)

The Amazon Resource Name (ARN) of the step function-based observation.

StatesStatus -> (string)

The status of the step function-related observation.

StatesInput -> (string)

The input to the step function-based observation.

EbsEvent -> (string)

The type of EBS CloudWatch event, such as createVolume , deleteVolume or attachVolume .

EbsResult -> (string)

The result of an EBS CloudWatch event, such as failed or succeeded .

EbsCause -> (string)

The cause of an EBS CloudWatch event.

EbsRequestId -> (string)

The request ID of an EBS CloudWatch event.

XRayFaultPercent -> (integer)

The X-Ray request fault percentage for this node.

XRayThrottlePercent -> (integer)

The X-Ray request throttle percentage for this node.

XRayErrorPercent -> (integer)

The X-Ray request error percentage for this node.

XRayRequestCount -> (integer)

The X-Ray request count for this node.

XRayRequestAverageLatency -> (long)

The X-Ray node request average latency for this node.

XRayNodeName -> (string)

The name of the X-Ray node.

XRayNodeType -> (string)

The type of the X-Ray node.