- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeAnomalyCommand
Returns details about an anomaly that you specify using its ID.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DevOpsGuruClient, DescribeAnomalyCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import
// const { DevOpsGuruClient, DescribeAnomalyCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import
const client = new DevOpsGuruClient(config);
const input = { // DescribeAnomalyRequest
Id: "STRING_VALUE", // required
AccountId: "STRING_VALUE",
};
const command = new DescribeAnomalyCommand(input);
const response = await client.send(command);
// { // DescribeAnomalyResponse
// ProactiveAnomaly: { // ProactiveAnomaly
// Id: "STRING_VALUE",
// Severity: "LOW" || "MEDIUM" || "HIGH",
// Status: "ONGOING" || "CLOSED",
// UpdateTime: new Date("TIMESTAMP"),
// AnomalyTimeRange: { // AnomalyTimeRange
// StartTime: new Date("TIMESTAMP"), // required
// EndTime: new Date("TIMESTAMP"),
// },
// AnomalyReportedTimeRange: { // AnomalyReportedTimeRange
// OpenTime: new Date("TIMESTAMP"), // required
// CloseTime: new Date("TIMESTAMP"),
// },
// PredictionTimeRange: { // PredictionTimeRange
// StartTime: new Date("TIMESTAMP"), // required
// EndTime: new Date("TIMESTAMP"),
// },
// SourceDetails: { // AnomalySourceDetails
// CloudWatchMetrics: [ // CloudWatchMetricsDetails
// { // CloudWatchMetricsDetail
// MetricName: "STRING_VALUE",
// Namespace: "STRING_VALUE",
// Dimensions: [ // CloudWatchMetricsDimensions
// { // CloudWatchMetricsDimension
// Name: "STRING_VALUE",
// Value: "STRING_VALUE",
// },
// ],
// Stat: "Sum" || "Average" || "SampleCount" || "Minimum" || "Maximum" || "p99" || "p90" || "p50",
// Unit: "STRING_VALUE",
// Period: Number("int"),
// MetricDataSummary: { // CloudWatchMetricsDataSummary
// TimestampMetricValuePairList: [ // TimestampMetricValuePairList
// { // TimestampMetricValuePair
// Timestamp: new Date("TIMESTAMP"),
// MetricValue: Number("double"),
// },
// ],
// StatusCode: "Complete" || "InternalError" || "PartialData",
// },
// },
// ],
// PerformanceInsightsMetrics: [ // PerformanceInsightsMetricsDetails
// { // PerformanceInsightsMetricsDetail
// MetricDisplayName: "STRING_VALUE",
// Unit: "STRING_VALUE",
// MetricQuery: { // PerformanceInsightsMetricQuery
// Metric: "STRING_VALUE",
// GroupBy: { // PerformanceInsightsMetricDimensionGroup
// Group: "STRING_VALUE",
// Dimensions: [ // PerformanceInsightsMetricDimensions
// "STRING_VALUE",
// ],
// Limit: Number("int"),
// },
// Filter: { // PerformanceInsightsMetricFilterMap
// "<keys>": "STRING_VALUE",
// },
// },
// ReferenceData: [ // PerformanceInsightsReferenceDataList
// { // PerformanceInsightsReferenceData
// Name: "STRING_VALUE",
// ComparisonValues: { // PerformanceInsightsReferenceComparisonValues
// ReferenceScalar: { // PerformanceInsightsReferenceScalar
// Value: Number("double"),
// },
// ReferenceMetric: { // PerformanceInsightsReferenceMetric
// MetricQuery: {
// Metric: "STRING_VALUE",
// GroupBy: {
// Group: "STRING_VALUE",
// Dimensions: [
// "STRING_VALUE",
// ],
// Limit: Number("int"),
// },
// Filter: {
// "<keys>": "STRING_VALUE",
// },
// },
// },
// },
// },
// ],
// StatsAtAnomaly: [ // PerformanceInsightsStats
// { // PerformanceInsightsStat
// Type: "STRING_VALUE",
// Value: Number("double"),
// },
// ],
// StatsAtBaseline: [
// {
// Type: "STRING_VALUE",
// Value: Number("double"),
// },
// ],
// },
// ],
// },
// AssociatedInsightId: "STRING_VALUE",
// ResourceCollection: { // ResourceCollection
// CloudFormation: { // CloudFormationCollection
// StackNames: [ // StackNames
// "STRING_VALUE",
// ],
// },
// Tags: [ // TagCollections
// { // TagCollection
// AppBoundaryKey: "STRING_VALUE", // required
// TagValues: [ // TagValues // required
// "STRING_VALUE",
// ],
// },
// ],
// },
// Limit: Number("double"),
// SourceMetadata: { // AnomalySourceMetadata
// Source: "STRING_VALUE",
// SourceResourceName: "STRING_VALUE",
// SourceResourceType: "STRING_VALUE",
// },
// AnomalyResources: [ // AnomalyResources
// { // AnomalyResource
// Name: "STRING_VALUE",
// Type: "STRING_VALUE",
// },
// ],
// Description: "STRING_VALUE",
// },
// ReactiveAnomaly: { // ReactiveAnomaly
// Id: "STRING_VALUE",
// Severity: "LOW" || "MEDIUM" || "HIGH",
// Status: "ONGOING" || "CLOSED",
// AnomalyTimeRange: {
// StartTime: new Date("TIMESTAMP"), // required
// EndTime: new Date("TIMESTAMP"),
// },
// AnomalyReportedTimeRange: {
// OpenTime: new Date("TIMESTAMP"), // required
// CloseTime: new Date("TIMESTAMP"),
// },
// SourceDetails: {
// CloudWatchMetrics: [
// {
// MetricName: "STRING_VALUE",
// Namespace: "STRING_VALUE",
// Dimensions: [
// {
// Name: "STRING_VALUE",
// Value: "STRING_VALUE",
// },
// ],
// Stat: "Sum" || "Average" || "SampleCount" || "Minimum" || "Maximum" || "p99" || "p90" || "p50",
// Unit: "STRING_VALUE",
// Period: Number("int"),
// MetricDataSummary: {
// TimestampMetricValuePairList: [
// {
// Timestamp: new Date("TIMESTAMP"),
// MetricValue: Number("double"),
// },
// ],
// StatusCode: "Complete" || "InternalError" || "PartialData",
// },
// },
// ],
// PerformanceInsightsMetrics: [
// {
// MetricDisplayName: "STRING_VALUE",
// Unit: "STRING_VALUE",
// MetricQuery: {
// Metric: "STRING_VALUE",
// GroupBy: {
// Group: "STRING_VALUE",
// Dimensions: [
// "STRING_VALUE",
// ],
// Limit: Number("int"),
// },
// Filter: {
// "<keys>": "STRING_VALUE",
// },
// },
// ReferenceData: [
// {
// Name: "STRING_VALUE",
// ComparisonValues: {
// ReferenceScalar: {
// Value: Number("double"),
// },
// ReferenceMetric: {
// MetricQuery: {
// Metric: "STRING_VALUE",
// GroupBy: {
// Group: "STRING_VALUE",
// Dimensions: [
// "STRING_VALUE",
// ],
// Limit: Number("int"),
// },
// Filter: {
// "<keys>": "STRING_VALUE",
// },
// },
// },
// },
// },
// ],
// StatsAtAnomaly: [
// {
// Type: "STRING_VALUE",
// Value: Number("double"),
// },
// ],
// StatsAtBaseline: [
// {
// Type: "STRING_VALUE",
// Value: Number("double"),
// },
// ],
// },
// ],
// },
// AssociatedInsightId: "STRING_VALUE",
// ResourceCollection: {
// CloudFormation: {
// StackNames: [
// "STRING_VALUE",
// ],
// },
// Tags: [
// {
// AppBoundaryKey: "STRING_VALUE", // required
// TagValues: [ // required
// "STRING_VALUE",
// ],
// },
// ],
// },
// Type: "CAUSAL" || "CONTEXTUAL",
// Name: "STRING_VALUE",
// Description: "STRING_VALUE",
// CausalAnomalyId: "STRING_VALUE",
// AnomalyResources: [
// {
// Name: "STRING_VALUE",
// Type: "STRING_VALUE",
// },
// ],
// },
// };
DescribeAnomalyCommand Input
See DescribeAnomalyCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
IdRequired | string | undefined | The ID of the anomaly. |
AccountId | string | undefined | The ID of the member account. |
DescribeAnomalyCommand Output
See DescribeAnomalyCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
ProactiveAnomaly | ProactiveAnomaly | undefined | A |
ReactiveAnomaly | ReactiveAnomaly | undefined | A |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | 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 in the IAM User Guide. |
| InternalServerException | server | An internal failure in an Amazon service occurred. |
| ResourceNotFoundException | client | A requested resource could not be found |
| ThrottlingException | client | The request was denied due to a request throttling. |
| ValidationException | client | Contains information about data passed in to a field during a request that is not valid. |
| DevOpsGuruServiceException | Base exception class for all service exceptions from DevOpsGuru service. |