AddNotificationChannel

$result = $client->addNotificationChannel([/* ... */]);
$promise = $client->addNotificationChannelAsync([/* ... */]);

Adds a notification channel to DevOps Guru. A notification channel is used to notify you about important DevOps Guru events, such as when an insight is generated.

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for Amazon SNS topics.

If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics.

Parameter Syntax

$result = $client->addNotificationChannel([
    'Config' => [ // REQUIRED
        'Filters' => [
            'MessageTypes' => ['<string>', ...],
            'Severities' => ['<string>', ...],
        ],
        'Sns' => [ // REQUIRED
            'TopicArn' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'Id' => '<string>',
]

Result Details

Errors

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 in the IAM User Guide.

ConflictException:

An exception that is thrown when a conflict occurs.

InternalServerException:

An internal failure in an Amazon service occurred.

ResourceNotFoundException:

A requested resource could not be found

ServiceQuotaExceededException:

The request contains a value that exceeds a maximum quota.

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

DeleteInsight

$result = $client->deleteInsight([/* ... */]);
$promise = $client->deleteInsightAsync([/* ... */]);

Deletes the insight along with the associated anomalies, events and recommendations.

Parameter Syntax

$result = $client->deleteInsight([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ResourceNotFoundException:

A requested resource could not be found

ConflictException:

An exception that is thrown when a conflict occurs.

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

DescribeAccountHealth

$result = $client->describeAccountHealth([/* ... */]);
$promise = $client->describeAccountHealthAsync([/* ... */]);

Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your Amazon Web Services account. Use these numbers to gauge the health of operations in your Amazon Web Services account.

Parameter Syntax

$result = $client->describeAccountHealth([
]);

Parameter Details

Result Syntax

[
    'AnalyzedResourceCount' => <integer>,
    'MetricsAnalyzed' => <integer>,
    'OpenProactiveInsights' => <integer>,
    'OpenReactiveInsights' => <integer>,
    'ResourceHours' => <integer>,
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

DescribeAccountOverview

$result = $client->describeAccountOverview([/* ... */]);
$promise = $client->describeAccountOverviewAsync([/* ... */]);

For the time range passed in, returns the number of open reactive insight that were created, the number of open proactive insights that were created, and the Mean Time to Recover (MTTR) for all closed reactive insights.

Parameter Syntax

$result = $client->describeAccountOverview([
    'FromTime' => <integer || string || DateTime>, // REQUIRED
    'ToTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'MeanTimeToRecoverInMilliseconds' => <integer>,
    'ProactiveInsights' => <integer>,
    'ReactiveInsights' => <integer>,
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

DescribeAnomaly

$result = $client->describeAnomaly([/* ... */]);
$promise = $client->describeAnomalyAsync([/* ... */]);

Returns details about an anomaly that you specify using its ID.

Parameter Syntax

$result = $client->describeAnomaly([
    'AccountId' => '<string>',
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ProactiveAnomaly' => [
        'AnomalyReportedTimeRange' => [
            'CloseTime' => <DateTime>,
            'OpenTime' => <DateTime>,
        ],
        'AnomalyResources' => [
            [
                'Name' => '<string>',
                'Type' => '<string>',
            ],
            // ...
        ],
        'AnomalyTimeRange' => [
            'EndTime' => <DateTime>,
            'StartTime' => <DateTime>,
        ],
        'AssociatedInsightId' => '<string>',
        'Description' => '<string>',
        'Id' => '<string>',
        'Limit' => <float>,
        'PredictionTimeRange' => [
            'EndTime' => <DateTime>,
            'StartTime' => <DateTime>,
        ],
        'ResourceCollection' => [
            'CloudFormation' => [
                'StackNames' => ['<string>', ...],
            ],
            'Tags' => [
                [
                    'AppBoundaryKey' => '<string>',
                    'TagValues' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'Severity' => 'LOW|MEDIUM|HIGH',
        'SourceDetails' => [
            'CloudWatchMetrics' => [
                [
                    'Dimensions' => [
                        [
                            'Name' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'MetricDataSummary' => [
                        'StatusCode' => 'Complete|InternalError|PartialData',
                        'TimestampMetricValuePairList' => [
                            [
                                'MetricValue' => <float>,
                                'Timestamp' => <DateTime>,
                            ],
                            // ...
                        ],
                    ],
                    'MetricName' => '<string>',
                    'Namespace' => '<string>',
                    'Period' => <integer>,
                    'Stat' => 'Sum|Average|SampleCount|Minimum|Maximum|p99|p90|p50',
                    'Unit' => '<string>',
                ],
                // ...
            ],
            'PerformanceInsightsMetrics' => [
                [
                    'MetricDisplayName' => '<string>',
                    'MetricQuery' => [
                        'Filter' => ['<string>', ...],
                        'GroupBy' => [
                            'Dimensions' => ['<string>', ...],
                            'Group' => '<string>',
                            'Limit' => <integer>,
                        ],
                        'Metric' => '<string>',
                    ],
                    'ReferenceData' => [
                        [
                            'ComparisonValues' => [
                                'ReferenceMetric' => [
                                    'MetricQuery' => [
                                        'Filter' => ['<string>', ...],
                                        'GroupBy' => [
                                            'Dimensions' => ['<string>', ...],
                                            'Group' => '<string>',
                                            'Limit' => <integer>,
                                        ],
                                        'Metric' => '<string>',
                                    ],
                                ],
                                'ReferenceScalar' => [
                                    'Value' => <float>,
                                ],
                            ],
                            'Name' => '<string>',
                        ],
                        // ...
                    ],
                    'StatsAtAnomaly' => [
                        [
                            'Type' => '<string>',
                            'Value' => <float>,
                        ],
                        // ...
                    ],
                    'StatsAtBaseline' => [
                        [
                            'Type' => '<string>',
                            'Value' => <float>,
                        ],
                        // ...
                    ],
                    'Unit' => '<string>',
                ],
                // ...
            ],
        ],
        'SourceMetadata' => [
            'Source' => '<string>',
            'SourceResourceName' => '<string>',
            'SourceResourceType' => '<string>',
        ],
        'Status' => 'ONGOING|CLOSED',
        'UpdateTime' => <DateTime>,
    ],
    'ReactiveAnomaly' => [
        'AnomalyReportedTimeRange' => [
            'CloseTime' => <DateTime>,
            'OpenTime' => <DateTime>,
        ],
        'AnomalyResources' => [
            [
                'Name' => '<string>',
                'Type' => '<string>',
            ],
            // ...
        ],
        'AnomalyTimeRange' => [
            'EndTime' => <DateTime>,
            'StartTime' => <DateTime>,
        ],
        'AssociatedInsightId' => '<string>',
        'CausalAnomalyId' => '<string>',
        'Description' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'ResourceCollection' => [
            'CloudFormation' => [
                'StackNames' => ['<string>', ...],
            ],
            'Tags' => [
                [
                    'AppBoundaryKey' => '<string>',
                    'TagValues' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'Severity' => 'LOW|MEDIUM|HIGH',
        'SourceDetails' => [
            'CloudWatchMetrics' => [
                [
                    'Dimensions' => [
                        [
                            'Name' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'MetricDataSummary' => [
                        'StatusCode' => 'Complete|InternalError|PartialData',
                        'TimestampMetricValuePairList' => [
                            [
                                'MetricValue' => <float>,
                                'Timestamp' => <DateTime>,
                            ],
                            // ...
                        ],
                    ],
                    'MetricName' => '<string>',
                    'Namespace' => '<string>',
                    'Period' => <integer>,
                    'Stat' => 'Sum|Average|SampleCount|Minimum|Maximum|p99|p90|p50',
                    'Unit' => '<string>',
                ],
                // ...
            ],
            'PerformanceInsightsMetrics' => [
                [
                    'MetricDisplayName' => '<string>',
                    'MetricQuery' => [
                        'Filter' => ['<string>', ...],
                        'GroupBy' => [
                            'Dimensions' => ['<string>', ...],
                            'Group' => '<string>',
                            'Limit' => <integer>,
                        ],
                        'Metric' => '<string>',
                    ],
                    'ReferenceData' => [
                        [
                            'ComparisonValues' => [
                                'ReferenceMetric' => [
                                    'MetricQuery' => [
                                        'Filter' => ['<string>', ...],
                                        'GroupBy' => [
                                            'Dimensions' => ['<string>', ...],
                                            'Group' => '<string>',
                                            'Limit' => <integer>,
                                        ],
                                        'Metric' => '<string>',
                                    ],
                                ],
                                'ReferenceScalar' => [
                                    'Value' => <float>,
                                ],
                            ],
                            'Name' => '<string>',
                        ],
                        // ...
                    ],
                    'StatsAtAnomaly' => [
                        [
                            'Type' => '<string>',
                            'Value' => <float>,
                        ],
                        // ...
                    ],
                    'StatsAtBaseline' => [
                        [
                            'Type' => '<string>',
                            'Value' => <float>,
                        ],
                        // ...
                    ],
                    'Unit' => '<string>',
                ],
                // ...
            ],
        ],
        'Status' => 'ONGOING|CLOSED',
        'Type' => 'CAUSAL|CONTEXTUAL',
    ],
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ResourceNotFoundException:

A requested resource could not be found

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

DescribeEventSourcesConfig

$result = $client->describeEventSourcesConfig([/* ... */]);
$promise = $client->describeEventSourcesConfigAsync([/* ... */]);

Returns the integration status of services that are integrated with DevOps Guru as Consumer via EventBridge. The one service that can be integrated with DevOps Guru is Amazon CodeGuru Profiler, which can produce proactive recommendations which can be stored and viewed in DevOps Guru.

Parameter Syntax

$result = $client->describeEventSourcesConfig([
]);

Parameter Details

Result Syntax

[
    'EventSources' => [
        'AmazonCodeGuruProfiler' => [
            'Status' => 'ENABLED|DISABLED',
        ],
    ],
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

DescribeFeedback

$result = $client->describeFeedback([/* ... */]);
$promise = $client->describeFeedbackAsync([/* ... */]);

Returns the most recent feedback submitted in the current Amazon Web Services account and Region.

Parameter Syntax

$result = $client->describeFeedback([
    'InsightId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'InsightFeedback' => [
        'Feedback' => 'VALID_COLLECTION|RECOMMENDATION_USEFUL|ALERT_TOO_SENSITIVE|DATA_NOISY_ANOMALY|DATA_INCORRECT',
        'Id' => '<string>',
    ],
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ResourceNotFoundException:

A requested resource could not be found

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

DescribeInsight

$result = $client->describeInsight([/* ... */]);
$promise = $client->describeInsightAsync([/* ... */]);

Returns details about an insight that you specify using its ID.

Parameter Syntax

$result = $client->describeInsight([
    'AccountId' => '<string>',
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ProactiveInsight' => [
        'Description' => '<string>',
        'Id' => '<string>',
        'InsightTimeRange' => [
            'EndTime' => <DateTime>,
            'StartTime' => <DateTime>,
        ],
        'Name' => '<string>',
        'PredictionTimeRange' => [
            'EndTime' => <DateTime>,
            'StartTime' => <DateTime>,
        ],
        'ResourceCollection' => [
            'CloudFormation' => [
                'StackNames' => ['<string>', ...],
            ],
            'Tags' => [
                [
                    'AppBoundaryKey' => '<string>',
                    'TagValues' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'Severity' => 'LOW|MEDIUM|HIGH',
        'SsmOpsItemId' => '<string>',
        'Status' => 'ONGOING|CLOSED',
    ],
    'ReactiveInsight' => [
        'Description' => '<string>',
        'Id' => '<string>',
        'InsightTimeRange' => [
            'EndTime' => <DateTime>,
            'StartTime' => <DateTime>,
        ],
        'Name' => '<string>',
        'ResourceCollection' => [
            'CloudFormation' => [
                'StackNames' => ['<string>', ...],
            ],
            'Tags' => [
                [
                    'AppBoundaryKey' => '<string>',
                    'TagValues' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'Severity' => 'LOW|MEDIUM|HIGH',
        'SsmOpsItemId' => '<string>',
        'Status' => 'ONGOING|CLOSED',
    ],
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ResourceNotFoundException:

A requested resource could not be found

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

DescribeOrganizationHealth

$result = $client->describeOrganizationHealth([/* ... */]);
$promise = $client->describeOrganizationHealthAsync([/* ... */]);

Returns active insights, predictive insights, and resource hours analyzed in last hour.

Parameter Syntax

$result = $client->describeOrganizationHealth([
    'AccountIds' => ['<string>', ...],
    'OrganizationalUnitIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'MetricsAnalyzed' => <integer>,
    'OpenProactiveInsights' => <integer>,
    'OpenReactiveInsights' => <integer>,
    'ResourceHours' => <integer>,
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

DescribeOrganizationOverview

$result = $client->describeOrganizationOverview([/* ... */]);
$promise = $client->describeOrganizationOverviewAsync([/* ... */]);

Returns an overview of your organization's history based on the specified time range. The overview includes the total reactive and proactive insights.

Parameter Syntax

$result = $client->describeOrganizationOverview([
    'AccountIds' => ['<string>', ...],
    'FromTime' => <integer || string || DateTime>, // REQUIRED
    'OrganizationalUnitIds' => ['<string>', ...],
    'ToTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'ProactiveInsights' => <integer>,
    'ReactiveInsights' => <integer>,
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

DescribeOrganizationResourceCollectionHealth

$result = $client->describeOrganizationResourceCollectionHealth([/* ... */]);
$promise = $client->describeOrganizationResourceCollectionHealthAsync([/* ... */]);

Provides an overview of your system's health. If additional member accounts are part of your organization, you can filter those accounts using the AccountIds field.

Parameter Syntax

$result = $client->describeOrganizationResourceCollectionHealth([
    'AccountIds' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OrganizationResourceCollectionType' => 'AWS_CLOUD_FORMATION|AWS_SERVICE|AWS_ACCOUNT|AWS_TAGS', // REQUIRED
    'OrganizationalUnitIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Account' => [
        [
            'AccountId' => '<string>',
            'Insight' => [
                'OpenProactiveInsights' => <integer>,
                'OpenReactiveInsights' => <integer>,
            ],
        ],
        // ...
    ],
    'CloudFormation' => [
        [
            'AnalyzedResourceCount' => <integer>,
            'Insight' => [
                'MeanTimeToRecoverInMilliseconds' => <integer>,
                'OpenProactiveInsights' => <integer>,
                'OpenReactiveInsights' => <integer>,
            ],
            'StackName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'Service' => [
        [
            'AnalyzedResourceCount' => <integer>,
            'Insight' => [
                'OpenProactiveInsights' => <integer>,
                'OpenReactiveInsights' => <integer>,
            ],
            'ServiceName' => 'API_GATEWAY|APPLICATION_ELB|AUTO_SCALING_GROUP|CLOUD_FRONT|DYNAMO_DB|EC2|ECS|EKS|ELASTIC_BEANSTALK|ELASTI_CACHE|ELB|ES|KINESIS|LAMBDA|NAT_GATEWAY|NETWORK_ELB|RDS|REDSHIFT|ROUTE_53|S3|SAGE_MAKER|SNS|SQS|STEP_FUNCTIONS|SWF',
        ],
        // ...
    ],
    'Tags' => [
        [
            'AnalyzedResourceCount' => <integer>,
            'AppBoundaryKey' => '<string>',
            'Insight' => [
                'MeanTimeToRecoverInMilliseconds' => <integer>,
                'OpenProactiveInsights' => <integer>,
                'OpenReactiveInsights' => <integer>,
            ],
            'TagValue' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

DescribeResourceCollectionHealth

$result = $client->describeResourceCollectionHealth([/* ... */]);
$promise = $client->describeResourceCollectionHealthAsync([/* ... */]);

Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in resource collections in your account. You specify the type of Amazon Web Services resources collection. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

Parameter Syntax

$result = $client->describeResourceCollectionHealth([
    'NextToken' => '<string>',
    'ResourceCollectionType' => 'AWS_CLOUD_FORMATION|AWS_SERVICE|AWS_TAGS', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CloudFormation' => [
        [
            'AnalyzedResourceCount' => <integer>,
            'Insight' => [
                'MeanTimeToRecoverInMilliseconds' => <integer>,
                'OpenProactiveInsights' => <integer>,
                'OpenReactiveInsights' => <integer>,
            ],
            'StackName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'Service' => [
        [
            'AnalyzedResourceCount' => <integer>,
            'Insight' => [
                'OpenProactiveInsights' => <integer>,
                'OpenReactiveInsights' => <integer>,
            ],
            'ServiceName' => 'API_GATEWAY|APPLICATION_ELB|AUTO_SCALING_GROUP|CLOUD_FRONT|DYNAMO_DB|EC2|ECS|EKS|ELASTIC_BEANSTALK|ELASTI_CACHE|ELB|ES|KINESIS|LAMBDA|NAT_GATEWAY|NETWORK_ELB|RDS|REDSHIFT|ROUTE_53|S3|SAGE_MAKER|SNS|SQS|STEP_FUNCTIONS|SWF',
        ],
        // ...
    ],
    'Tags' => [
        [
            'AnalyzedResourceCount' => <integer>,
            'AppBoundaryKey' => '<string>',
            'Insight' => [
                'MeanTimeToRecoverInMilliseconds' => <integer>,
                'OpenProactiveInsights' => <integer>,
                'OpenReactiveInsights' => <integer>,
            ],
            'TagValue' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

DescribeServiceIntegration

$result = $client->describeServiceIntegration([/* ... */]);
$promise = $client->describeServiceIntegrationAsync([/* ... */]);

Returns the integration status of services that are integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon Web Services Systems Manager, which can be used to create an OpsItem for each generated insight.

Parameter Syntax

$result = $client->describeServiceIntegration([
]);

Parameter Details

Result Syntax

[
    'ServiceIntegration' => [
        'KMSServerSideEncryption' => [
            'KMSKeyId' => '<string>',
            'OptInStatus' => 'ENABLED|DISABLED',
            'Type' => 'CUSTOMER_MANAGED_KEY|AWS_OWNED_KMS_KEY',
        ],
        'LogsAnomalyDetection' => [
            'OptInStatus' => 'ENABLED|DISABLED',
        ],
        'OpsCenter' => [
            'OptInStatus' => 'ENABLED|DISABLED',
        ],
    ],
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ResourceNotFoundException:

A requested resource could not be found

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

GetCostEstimation

$result = $client->getCostEstimation([/* ... */]);
$promise = $client->getCostEstimationAsync([/* ... */]);

Returns an estimate of the monthly cost for DevOps Guru to analyze your Amazon Web Services resources. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.

Parameter Syntax

$result = $client->getCostEstimation([
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Costs' => [
        [
            'Cost' => <float>,
            'Count' => <integer>,
            'State' => 'ACTIVE|INACTIVE',
            'Type' => '<string>',
            'UnitCost' => <float>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'ResourceCollection' => [
        'CloudFormation' => [
            'StackNames' => ['<string>', ...],
        ],
        'Tags' => [
            [
                'AppBoundaryKey' => '<string>',
                'TagValues' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'Status' => 'ONGOING|COMPLETED',
    'TimeRange' => [
        'EndTime' => <DateTime>,
        'StartTime' => <DateTime>,
    ],
    'TotalCost' => <float>,
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ResourceNotFoundException:

A requested resource could not be found

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

GetResourceCollection

$result = $client->getResourceCollection([/* ... */]);
$promise = $client->getResourceCollectionAsync([/* ... */]);

Returns lists Amazon Web Services resources that are of the specified resource collection type. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

Parameter Syntax

$result = $client->getResourceCollection([
    'NextToken' => '<string>',
    'ResourceCollectionType' => 'AWS_CLOUD_FORMATION|AWS_SERVICE|AWS_TAGS', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ResourceCollection' => [
        'CloudFormation' => [
            'StackNames' => ['<string>', ...],
        ],
        'Tags' => [
            [
                'AppBoundaryKey' => '<string>',
                'TagValues' => ['<string>', ...],
            ],
            // ...
        ],
    ],
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ResourceNotFoundException:

A requested resource could not be found

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

ListAnomaliesForInsight

$result = $client->listAnomaliesForInsight([/* ... */]);
$promise = $client->listAnomaliesForInsightAsync([/* ... */]);

Returns a list of the anomalies that belong to an insight that you specify using its ID.

Parameter Syntax

$result = $client->listAnomaliesForInsight([
    'AccountId' => '<string>',
    'Filters' => [
        'ServiceCollection' => [
            'ServiceNames' => ['<string>', ...],
        ],
    ],
    'InsightId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StartTimeRange' => [
        'FromTime' => <integer || string || DateTime>,
        'ToTime' => <integer || string || DateTime>,
    ],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ProactiveAnomalies' => [
        [
            'AnomalyReportedTimeRange' => [
                'CloseTime' => <DateTime>,
                'OpenTime' => <DateTime>,
            ],
            'AnomalyResources' => [
                [
                    'Name' => '<string>',
                    'Type' => '<string>',
                ],
                // ...
            ],
            'AnomalyTimeRange' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'AssociatedInsightId' => '<string>',
            'Description' => '<string>',
            'Id' => '<string>',
            'Limit' => <float>,
            'PredictionTimeRange' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'ResourceCollection' => [
                'CloudFormation' => [
                    'StackNames' => ['<string>', ...],
                ],
                'Tags' => [
                    [
                        'AppBoundaryKey' => '<string>',
                        'TagValues' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'Severity' => 'LOW|MEDIUM|HIGH',
            'SourceDetails' => [
                'CloudWatchMetrics' => [
                    [
                        'Dimensions' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'MetricDataSummary' => [
                            'StatusCode' => 'Complete|InternalError|PartialData',
                            'TimestampMetricValuePairList' => [
                                [
                                    'MetricValue' => <float>,
                                    'Timestamp' => <DateTime>,
                                ],
                                // ...
                            ],
                        ],
                        'MetricName' => '<string>',
                        'Namespace' => '<string>',
                        'Period' => <integer>,
                        'Stat' => 'Sum|Average|SampleCount|Minimum|Maximum|p99|p90|p50',
                        'Unit' => '<string>',
                    ],
                    // ...
                ],
                'PerformanceInsightsMetrics' => [
                    [
                        'MetricDisplayName' => '<string>',
                        'MetricQuery' => [
                            'Filter' => ['<string>', ...],
                            'GroupBy' => [
                                'Dimensions' => ['<string>', ...],
                                'Group' => '<string>',
                                'Limit' => <integer>,
                            ],
                            'Metric' => '<string>',
                        ],
                        'ReferenceData' => [
                            [
                                'ComparisonValues' => [
                                    'ReferenceMetric' => [
                                        'MetricQuery' => [
                                            'Filter' => ['<string>', ...],
                                            'GroupBy' => [
                                                'Dimensions' => ['<string>', ...],
                                                'Group' => '<string>',
                                                'Limit' => <integer>,
                                            ],
                                            'Metric' => '<string>',
                                        ],
                                    ],
                                    'ReferenceScalar' => [
                                        'Value' => <float>,
                                    ],
                                ],
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'StatsAtAnomaly' => [
                            [
                                'Type' => '<string>',
                                'Value' => <float>,
                            ],
                            // ...
                        ],
                        'StatsAtBaseline' => [
                            [
                                'Type' => '<string>',
                                'Value' => <float>,
                            ],
                            // ...
                        ],
                        'Unit' => '<string>',
                    ],
                    // ...
                ],
            ],
            'SourceMetadata' => [
                'Source' => '<string>',
                'SourceResourceName' => '<string>',
                'SourceResourceType' => '<string>',
            ],
            'Status' => 'ONGOING|CLOSED',
            'UpdateTime' => <DateTime>,
        ],
        // ...
    ],
    'ReactiveAnomalies' => [
        [
            'AnomalyReportedTimeRange' => [
                'CloseTime' => <DateTime>,
                'OpenTime' => <DateTime>,
            ],
            'AnomalyResources' => [
                [
                    'Name' => '<string>',
                    'Type' => '<string>',
                ],
                // ...
            ],
            'AnomalyTimeRange' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'AssociatedInsightId' => '<string>',
            'CausalAnomalyId' => '<string>',
            'Description' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'ResourceCollection' => [
                'CloudFormation' => [
                    'StackNames' => ['<string>', ...],
                ],
                'Tags' => [
                    [
                        'AppBoundaryKey' => '<string>',
                        'TagValues' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'Severity' => 'LOW|MEDIUM|HIGH',
            'SourceDetails' => [
                'CloudWatchMetrics' => [
                    [
                        'Dimensions' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'MetricDataSummary' => [
                            'StatusCode' => 'Complete|InternalError|PartialData',
                            'TimestampMetricValuePairList' => [
                                [
                                    'MetricValue' => <float>,
                                    'Timestamp' => <DateTime>,
                                ],
                                // ...
                            ],
                        ],
                        'MetricName' => '<string>',
                        'Namespace' => '<string>',
                        'Period' => <integer>,
                        'Stat' => 'Sum|Average|SampleCount|Minimum|Maximum|p99|p90|p50',
                        'Unit' => '<string>',
                    ],
                    // ...
                ],
                'PerformanceInsightsMetrics' => [
                    [
                        'MetricDisplayName' => '<string>',
                        'MetricQuery' => [
                            'Filter' => ['<string>', ...],
                            'GroupBy' => [
                                'Dimensions' => ['<string>', ...],
                                'Group' => '<string>',
                                'Limit' => <integer>,
                            ],
                            'Metric' => '<string>',
                        ],
                        'ReferenceData' => [
                            [
                                'ComparisonValues' => [
                                    'ReferenceMetric' => [
                                        'MetricQuery' => [
                                            'Filter' => ['<string>', ...],
                                            'GroupBy' => [
                                                'Dimensions' => ['<string>', ...],
                                                'Group' => '<string>',
                                                'Limit' => <integer>,
                                            ],
                                            'Metric' => '<string>',
                                        ],
                                    ],
                                    'ReferenceScalar' => [
                                        'Value' => <float>,
                                    ],
                                ],
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                        'StatsAtAnomaly' => [
                            [
                                'Type' => '<string>',
                                'Value' => <float>,
                            ],
                            // ...
                        ],
                        'StatsAtBaseline' => [
                            [
                                'Type' => '<string>',
                                'Value' => <float>,
                            ],
                            // ...
                        ],
                        'Unit' => '<string>',
                    ],
                    // ...
                ],
            ],
            'Status' => 'ONGOING|CLOSED',
            'Type' => 'CAUSAL|CONTEXTUAL',
        ],
        // ...
    ],
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ResourceNotFoundException:

A requested resource could not be found

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

ListAnomalousLogGroups

$result = $client->listAnomalousLogGroups([/* ... */]);
$promise = $client->listAnomalousLogGroupsAsync([/* ... */]);

Returns the list of log groups that contain log anomalies.

Parameter Syntax

$result = $client->listAnomalousLogGroups([
    'InsightId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AnomalousLogGroups' => [
        [
            'ImpactEndTime' => <DateTime>,
            'ImpactStartTime' => <DateTime>,
            'LogAnomalyShowcases' => [
                [
                    'LogAnomalyClasses' => [
                        [
                            'Explanation' => '<string>',
                            'LogAnomalyToken' => '<string>',
                            'LogAnomalyType' => 'KEYWORD|KEYWORD_TOKEN|FORMAT|HTTP_CODE|BLOCK_FORMAT|NUMERICAL_POINT|NUMERICAL_NAN|NEW_FIELD_NAME',
                            'LogEventId' => '<string>',
                            'LogEventTimestamp' => <DateTime>,
                            'LogStreamName' => '<string>',
                            'NumberOfLogLinesOccurrences' => <integer>,
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'LogGroupName' => '<string>',
            'NumberOfLogLinesScanned' => <integer>,
        ],
        // ...
    ],
    'InsightId' => '<string>',
    'NextToken' => '<string>',
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ResourceNotFoundException:

A requested resource could not be found

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

ListEvents

$result = $client->listEvents([/* ... */]);
$promise = $client->listEventsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listEvents([
    'AccountId' => '<string>',
    'Filters' => [ // REQUIRED
        'DataSource' => 'AWS_CLOUD_TRAIL|AWS_CODE_DEPLOY',
        'EventClass' => 'INFRASTRUCTURE|DEPLOYMENT|SECURITY_CHANGE|CONFIG_CHANGE|SCHEMA_CHANGE',
        'EventSource' => '<string>',
        'EventTimeRange' => [
            'FromTime' => <integer || string || DateTime>, // REQUIRED
            'ToTime' => <integer || string || DateTime>, // REQUIRED
        ],
        'InsightId' => '<string>',
        'ResourceCollection' => [
            'CloudFormation' => [
                'StackNames' => ['<string>', ...],
            ],
            'Tags' => [
                [
                    'AppBoundaryKey' => '<string>', // REQUIRED
                    'TagValues' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
        ],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Events' => [
        [
            'DataSource' => 'AWS_CLOUD_TRAIL|AWS_CODE_DEPLOY',
            'EventClass' => 'INFRASTRUCTURE|DEPLOYMENT|SECURITY_CHANGE|CONFIG_CHANGE|SCHEMA_CHANGE',
            'EventSource' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'ResourceCollection' => [
                'CloudFormation' => [
                    'StackNames' => ['<string>', ...],
                ],
                'Tags' => [
                    [
                        'AppBoundaryKey' => '<string>',
                        'TagValues' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'Resources' => [
                [
                    'Arn' => '<string>',
                    'Name' => '<string>',
                    'Type' => '<string>',
                ],
                // ...
            ],
            'Time' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ResourceNotFoundException:

A requested resource could not be found

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

ListInsights

$result = $client->listInsights([/* ... */]);
$promise = $client->listInsightsAsync([/* ... */]);

Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time and status (ONGOING, CLOSED, or ANY).

Parameter Syntax

$result = $client->listInsights([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StatusFilter' => [ // REQUIRED
        'Any' => [
            'StartTimeRange' => [ // REQUIRED
                'FromTime' => <integer || string || DateTime>,
                'ToTime' => <integer || string || DateTime>,
            ],
            'Type' => 'REACTIVE|PROACTIVE', // REQUIRED
        ],
        'Closed' => [
            'EndTimeRange' => [ // REQUIRED
                'FromTime' => <integer || string || DateTime>,
                'ToTime' => <integer || string || DateTime>,
            ],
            'Type' => 'REACTIVE|PROACTIVE', // REQUIRED
        ],
        'Ongoing' => [
            'Type' => 'REACTIVE|PROACTIVE', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ProactiveInsights' => [
        [
            'AssociatedResourceArns' => ['<string>', ...],
            'Id' => '<string>',
            'InsightTimeRange' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'Name' => '<string>',
            'PredictionTimeRange' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'ResourceCollection' => [
                'CloudFormation' => [
                    'StackNames' => ['<string>', ...],
                ],
                'Tags' => [
                    [
                        'AppBoundaryKey' => '<string>',
                        'TagValues' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'ServiceCollection' => [
                'ServiceNames' => ['<string>', ...],
            ],
            'Severity' => 'LOW|MEDIUM|HIGH',
            'Status' => 'ONGOING|CLOSED',
        ],
        // ...
    ],
    'ReactiveInsights' => [
        [
            'AssociatedResourceArns' => ['<string>', ...],
            'Id' => '<string>',
            'InsightTimeRange' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'Name' => '<string>',
            'ResourceCollection' => [
                'CloudFormation' => [
                    'StackNames' => ['<string>', ...],
                ],
                'Tags' => [
                    [
                        'AppBoundaryKey' => '<string>',
                        'TagValues' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'ServiceCollection' => [
                'ServiceNames' => ['<string>', ...],
            ],
            'Severity' => 'LOW|MEDIUM|HIGH',
            'Status' => 'ONGOING|CLOSED',
        ],
        // ...
    ],
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

ListMonitoredResources

$result = $client->listMonitoredResources([/* ... */]);
$promise = $client->listMonitoredResourcesAsync([/* ... */]);

Returns the list of all log groups that are being monitored and tagged by DevOps Guru.

Parameter Syntax

$result = $client->listMonitoredResources([
    'Filters' => [
        'ResourcePermission' => 'FULL_PERMISSION|MISSING_PERMISSION', // REQUIRED
        'ResourceTypeFilters' => ['<string>', ...], // REQUIRED
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'MonitoredResourceIdentifiers' => [
        [
            'LastUpdated' => <DateTime>,
            'MonitoredResourceName' => '<string>',
            'ResourceCollection' => [
                'CloudFormation' => [
                    'StackNames' => ['<string>', ...],
                ],
                'Tags' => [
                    [
                        'AppBoundaryKey' => '<string>',
                        'TagValues' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'ResourcePermission' => 'FULL_PERMISSION|MISSING_PERMISSION',
            'Type' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

A requested resource could not be found

InternalServerException:

An internal failure in an Amazon service occurred.

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

ListNotificationChannels

$result = $client->listNotificationChannels([/* ... */]);
$promise = $client->listNotificationChannelsAsync([/* ... */]);

Returns a list of notification channels configured for DevOps Guru. Each notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).

Parameter Syntax

$result = $client->listNotificationChannels([
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Channels' => [
        [
            'Config' => [
                'Filters' => [
                    'MessageTypes' => ['<string>', ...],
                    'Severities' => ['<string>', ...],
                ],
                'Sns' => [
                    'TopicArn' => '<string>',
                ],
            ],
            'Id' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

ListOrganizationInsights

$result = $client->listOrganizationInsights([/* ... */]);
$promise = $client->listOrganizationInsightsAsync([/* ... */]);

Returns a list of insights associated with the account or OU Id.

Parameter Syntax

$result = $client->listOrganizationInsights([
    'AccountIds' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OrganizationalUnitIds' => ['<string>', ...],
    'StatusFilter' => [ // REQUIRED
        'Any' => [
            'StartTimeRange' => [ // REQUIRED
                'FromTime' => <integer || string || DateTime>,
                'ToTime' => <integer || string || DateTime>,
            ],
            'Type' => 'REACTIVE|PROACTIVE', // REQUIRED
        ],
        'Closed' => [
            'EndTimeRange' => [ // REQUIRED
                'FromTime' => <integer || string || DateTime>,
                'ToTime' => <integer || string || DateTime>,
            ],
            'Type' => 'REACTIVE|PROACTIVE', // REQUIRED
        ],
        'Ongoing' => [
            'Type' => 'REACTIVE|PROACTIVE', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ProactiveInsights' => [
        [
            'AccountId' => '<string>',
            'Id' => '<string>',
            'InsightTimeRange' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'Name' => '<string>',
            'OrganizationalUnitId' => '<string>',
            'PredictionTimeRange' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'ResourceCollection' => [
                'CloudFormation' => [
                    'StackNames' => ['<string>', ...],
                ],
                'Tags' => [
                    [
                        'AppBoundaryKey' => '<string>',
                        'TagValues' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'ServiceCollection' => [
                'ServiceNames' => ['<string>', ...],
            ],
            'Severity' => 'LOW|MEDIUM|HIGH',
            'Status' => 'ONGOING|CLOSED',
        ],
        // ...
    ],
    'ReactiveInsights' => [
        [
            'AccountId' => '<string>',
            'Id' => '<string>',
            'InsightTimeRange' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'Name' => '<string>',
            'OrganizationalUnitId' => '<string>',
            'ResourceCollection' => [
                'CloudFormation' => [
                    'StackNames' => ['<string>', ...],
                ],
                'Tags' => [
                    [
                        'AppBoundaryKey' => '<string>',
                        'TagValues' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'ServiceCollection' => [
                'ServiceNames' => ['<string>', ...],
            ],
            'Severity' => 'LOW|MEDIUM|HIGH',
            'Status' => 'ONGOING|CLOSED',
        ],
        // ...
    ],
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

ListRecommendations

$result = $client->listRecommendations([/* ... */]);
$promise = $client->listRecommendationsAsync([/* ... */]);

Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.

Parameter Syntax

$result = $client->listRecommendations([
    'AccountId' => '<string>',
    'InsightId' => '<string>', // REQUIRED
    'Locale' => 'DE_DE|EN_US|EN_GB|ES_ES|FR_FR|IT_IT|JA_JP|KO_KR|PT_BR|ZH_CN|ZH_TW',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Recommendations' => [
        [
            'Category' => '<string>',
            'Description' => '<string>',
            'Link' => '<string>',
            'Name' => '<string>',
            'Reason' => '<string>',
            'RelatedAnomalies' => [
                [
                    'AnomalyId' => '<string>',
                    'Resources' => [
                        [
                            'Name' => '<string>',
                            'Type' => '<string>',
                        ],
                        // ...
                    ],
                    'SourceDetails' => [
                        [
                            'CloudWatchMetrics' => [
                                [
                                    'MetricName' => '<string>',
                                    'Namespace' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'RelatedEvents' => [
                [
                    'Name' => '<string>',
                    'Resources' => [
                        [
                            'Name' => '<string>',
                            'Type' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ResourceNotFoundException:

A requested resource could not be found

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

PutFeedback

$result = $client->putFeedback([/* ... */]);
$promise = $client->putFeedbackAsync([/* ... */]);

Collects customer feedback about the specified insight.

Parameter Syntax

$result = $client->putFeedback([
    'InsightFeedback' => [
        'Feedback' => 'VALID_COLLECTION|RECOMMENDATION_USEFUL|ALERT_TOO_SENSITIVE|DATA_NOISY_ANOMALY|DATA_INCORRECT',
        'Id' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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 in the IAM User Guide.

ConflictException:

An exception that is thrown when a conflict occurs.

InternalServerException:

An internal failure in an Amazon service occurred.

ResourceNotFoundException:

A requested resource could not be found

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

RemoveNotificationChannel

$result = $client->removeNotificationChannel([/* ... */]);
$promise = $client->removeNotificationChannelAsync([/* ... */]);

Removes a notification channel from DevOps Guru. A notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations.

Parameter Syntax

$result = $client->removeNotificationChannel([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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 in the IAM User Guide.

ConflictException:

An exception that is thrown when a conflict occurs.

InternalServerException:

An internal failure in an Amazon service occurred.

ResourceNotFoundException:

A requested resource could not be found

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

SearchInsights

$result = $client->searchInsights([/* ... */]);
$promise = $client->searchInsightsAsync([/* ... */]);

Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time, one or more statuses (ONGOING or CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE).

Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search.

Parameter Syntax

$result = $client->searchInsights([
    'Filters' => [
        'ResourceCollection' => [
            'CloudFormation' => [
                'StackNames' => ['<string>', ...],
            ],
            'Tags' => [
                [
                    'AppBoundaryKey' => '<string>', // REQUIRED
                    'TagValues' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
        ],
        'ServiceCollection' => [
            'ServiceNames' => ['<string>', ...],
        ],
        'Severities' => ['<string>', ...],
        'Statuses' => ['<string>', ...],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StartTimeRange' => [ // REQUIRED
        'FromTime' => <integer || string || DateTime>,
        'ToTime' => <integer || string || DateTime>,
    ],
    'Type' => 'REACTIVE|PROACTIVE', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ProactiveInsights' => [
        [
            'AssociatedResourceArns' => ['<string>', ...],
            'Id' => '<string>',
            'InsightTimeRange' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'Name' => '<string>',
            'PredictionTimeRange' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'ResourceCollection' => [
                'CloudFormation' => [
                    'StackNames' => ['<string>', ...],
                ],
                'Tags' => [
                    [
                        'AppBoundaryKey' => '<string>',
                        'TagValues' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'ServiceCollection' => [
                'ServiceNames' => ['<string>', ...],
            ],
            'Severity' => 'LOW|MEDIUM|HIGH',
            'Status' => 'ONGOING|CLOSED',
        ],
        // ...
    ],
    'ReactiveInsights' => [
        [
            'AssociatedResourceArns' => ['<string>', ...],
            'Id' => '<string>',
            'InsightTimeRange' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'Name' => '<string>',
            'ResourceCollection' => [
                'CloudFormation' => [
                    'StackNames' => ['<string>', ...],
                ],
                'Tags' => [
                    [
                        'AppBoundaryKey' => '<string>',
                        'TagValues' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'ServiceCollection' => [
                'ServiceNames' => ['<string>', ...],
            ],
            'Severity' => 'LOW|MEDIUM|HIGH',
            'Status' => 'ONGOING|CLOSED',
        ],
        // ...
    ],
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

SearchOrganizationInsights

$result = $client->searchOrganizationInsights([/* ... */]);
$promise = $client->searchOrganizationInsightsAsync([/* ... */]);

Returns a list of insights in your organization. You can specify which insights are returned by their start time, one or more statuses (ONGOING, CLOSED, and CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE).

Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search.

Parameter Syntax

$result = $client->searchOrganizationInsights([
    'AccountIds' => ['<string>', ...], // REQUIRED
    'Filters' => [
        'ResourceCollection' => [
            'CloudFormation' => [
                'StackNames' => ['<string>', ...],
            ],
            'Tags' => [
                [
                    'AppBoundaryKey' => '<string>', // REQUIRED
                    'TagValues' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
        ],
        'ServiceCollection' => [
            'ServiceNames' => ['<string>', ...],
        ],
        'Severities' => ['<string>', ...],
        'Statuses' => ['<string>', ...],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StartTimeRange' => [ // REQUIRED
        'FromTime' => <integer || string || DateTime>,
        'ToTime' => <integer || string || DateTime>,
    ],
    'Type' => 'REACTIVE|PROACTIVE', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ProactiveInsights' => [
        [
            'AssociatedResourceArns' => ['<string>', ...],
            'Id' => '<string>',
            'InsightTimeRange' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'Name' => '<string>',
            'PredictionTimeRange' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'ResourceCollection' => [
                'CloudFormation' => [
                    'StackNames' => ['<string>', ...],
                ],
                'Tags' => [
                    [
                        'AppBoundaryKey' => '<string>',
                        'TagValues' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'ServiceCollection' => [
                'ServiceNames' => ['<string>', ...],
            ],
            'Severity' => 'LOW|MEDIUM|HIGH',
            'Status' => 'ONGOING|CLOSED',
        ],
        // ...
    ],
    'ReactiveInsights' => [
        [
            'AssociatedResourceArns' => ['<string>', ...],
            'Id' => '<string>',
            'InsightTimeRange' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'Name' => '<string>',
            'ResourceCollection' => [
                'CloudFormation' => [
                    'StackNames' => ['<string>', ...],
                ],
                'Tags' => [
                    [
                        'AppBoundaryKey' => '<string>',
                        'TagValues' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'ServiceCollection' => [
                'ServiceNames' => ['<string>', ...],
            ],
            'Severity' => 'LOW|MEDIUM|HIGH',
            'Status' => 'ONGOING|CLOSED',
        ],
        // ...
    ],
]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

StartCostEstimation

$result = $client->startCostEstimation([/* ... */]);
$promise = $client->startCostEstimationAsync([/* ... */]);

Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources.

Parameter Syntax

$result = $client->startCostEstimation([
    'ClientToken' => '<string>',
    'ResourceCollection' => [ // REQUIRED
        'CloudFormation' => [
            'StackNames' => ['<string>', ...],
        ],
        'Tags' => [
            [
                'AppBoundaryKey' => '<string>', // REQUIRED
                'TagValues' => ['<string>', ...], // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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 in the IAM User Guide.

ConflictException:

An exception that is thrown when a conflict occurs.

InternalServerException:

An internal failure in an Amazon service occurred.

ResourceNotFoundException:

A requested resource could not be found

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

UpdateEventSourcesConfig

$result = $client->updateEventSourcesConfig([/* ... */]);
$promise = $client->updateEventSourcesConfigAsync([/* ... */]);

Enables or disables integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon CodeGuru Profiler, which can produce proactive recommendations which can be stored and viewed in DevOps Guru.

Parameter Syntax

$result = $client->updateEventSourcesConfig([
    'EventSources' => [
        'AmazonCodeGuruProfiler' => [
            'Status' => 'ENABLED|DISABLED',
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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 in the IAM User Guide.

InternalServerException:

An internal failure in an Amazon service occurred.

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

UpdateResourceCollection

$result = $client->updateResourceCollection([/* ... */]);
$promise = $client->updateResourceCollectionAsync([/* ... */]);

Updates the collection of resources that DevOps Guru analyzes. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks. This method also creates the IAM role required for you to use DevOps Guru.

Parameter Syntax

$result = $client->updateResourceCollection([
    'Action' => 'ADD|REMOVE', // REQUIRED
    'ResourceCollection' => [ // REQUIRED
        'CloudFormation' => [
            'StackNames' => ['<string>', ...],
        ],
        'Tags' => [
            [
                'AppBoundaryKey' => '<string>', // REQUIRED
                'TagValues' => ['<string>', ...], // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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 in the IAM User Guide.

ConflictException:

An exception that is thrown when a conflict occurs.

InternalServerException:

An internal failure in an Amazon service occurred.

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.

UpdateServiceIntegration

$result = $client->updateServiceIntegration([/* ... */]);
$promise = $client->updateServiceIntegrationAsync([/* ... */]);

Enables or disables integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon Web Services Systems Manager, which can be used to create an OpsItem for each generated insight.

Parameter Syntax

$result = $client->updateServiceIntegration([
    'ServiceIntegration' => [ // REQUIRED
        'KMSServerSideEncryption' => [
            'KMSKeyId' => '<string>',
            'OptInStatus' => 'ENABLED|DISABLED',
            'Type' => 'CUSTOMER_MANAGED_KEY|AWS_OWNED_KMS_KEY',
        ],
        'LogsAnomalyDetection' => [
            'OptInStatus' => 'ENABLED|DISABLED',
        ],
        'OpsCenter' => [
            'OptInStatus' => 'ENABLED|DISABLED',
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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 in the IAM User Guide.

ConflictException:

An exception that is thrown when a conflict occurs.

InternalServerException:

An internal failure in an Amazon service occurred.

ThrottlingException:

The request was denied due to a request throttling.

ValidationException:

Contains information about data passed in to a field during a request that is not valid.