AWS SDK for PHP 3.x

Client: Aws\DevOpsGuru\DevOpsGuruClient

Service ID: devops-guru

Version: 2020-12-01

This page describes the parameters and results for the operations of the Amazon DevOps Guru (2020-12-01), and shows how to use the Aws\DevOpsGuru\DevOpsGuruClient object to call the described operations. This documentation is specific to the 2020-12-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AddNotificationChannel ( array $params = [] )
Adds a notification channel to DevOps Guru.
DescribeAccountHealth ( array $params = [] )
Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your AWS account.
DescribeAccountOverview ( array $params = [] )
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.
DescribeAnomaly ( array $params = [] )
Returns details about an anomaly that you specify using its ID.
DescribeFeedback ( array $params = [] )
Returns the most recent feedback submitted in the current AWS account and Region.
DescribeInsight ( array $params = [] )
Returns details about an insight that you specify using its ID.
DescribeResourceCollectionHealth ( array $params = [] )
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.
DescribeServiceIntegration ( array $params = [] )
Returns the integration status of services that are integrated with DevOps Guru.
GetResourceCollection ( array $params = [] )
Returns lists AWS resources that are of the specified resource collection type.
ListAnomaliesForInsight ( array $params = [] )
Returns a list of the anomalies that belong to an insight that you specify using its ID.
ListEvents ( array $params = [] )
Returns a list of the events emitted by the resources that are evaluated by DevOps Guru.
ListInsights ( array $params = [] )
Returns a list of insights in your AWS account.
ListNotificationChannels ( array $params = [] )
Returns a list of notification channels configured for DevOps Guru.
ListRecommendations ( array $params = [] )
Returns a list of a specified insight's recommendations.
PutFeedback ( array $params = [] )
Collects customer feedback about the specified insight.
RemoveNotificationChannel ( array $params = [] )
Removes a notification channel from DevOps Guru.
SearchInsights ( array $params = [] )
Returns a list of insights in your AWS account.
UpdateResourceCollection ( array $params = [] )
Updates the collection of resources that DevOps Guru analyzes.
UpdateServiceIntegration ( array $params = [] )
Enables or disables integration with a service that can be integrated with DevOps Guru.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeResourceCollectionHealth
GetResourceCollection
ListAnomaliesForInsight
ListEvents
ListInsights
ListNotificationChannels
ListRecommendations
SearchInsights

Operations

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 it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.

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

Parameter Syntax

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

Parameter Details

Members

Config

Required: Yes
Type: NotificationChannelConfig structure

A NotificationChannelConfig object that specifies what type of notification channel to add. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).

Result Syntax

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

Result Details

Members

Id

Required: Yes
Type: string

The ID of the added notification channel.

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.

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 AWS account. Use these numbers to gauge the health of operations in your AWS account.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

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

Result Details

Members

MetricsAnalyzed

Required: Yes
Type: int

An integer that specifies the number of metrics that have been analyzed in your AWS account.

OpenProactiveInsights

Required: Yes
Type: int

An integer that specifies the number of open proactive insights in your AWS account.

OpenReactiveInsights

Required: Yes
Type: int

An integer that specifies the number of open reactive insights in your AWS account.

ResourceHours

Required: Yes
Type: long (int|float)

The number of Amazon DevOps Guru resource analysis hours billed to the current AWS account in the last hour.

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

Members

FromTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The start of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred after this day.

ToTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The end of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred before this day. If this is not specified, then the current day is used.

Result Syntax

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

Result Details

Members

MeanTimeToRecoverInMilliseconds

Required: Yes
Type: long (int|float)

The Mean Time to Recover (MTTR) for all closed insights that were created during the time range passed in.

ProactiveInsights

Required: Yes
Type: int

An integer that specifies the number of open proactive insights in your AWS account that were created during the time range passed in.

ReactiveInsights

Required: Yes
Type: int

An integer that specifies the number of open reactive insights in your AWS account that were created during the time range passed in.

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([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of the anomaly.

Result Syntax

[
    'ProactiveAnomaly' => [
        'AnomalyTimeRange' => [
            'EndTime' => <DateTime>,
            'StartTime' => <DateTime>,
        ],
        'AssociatedInsightId' => '<string>',
        'Id' => '<string>',
        'Limit' => <float>,
        'PredictionTimeRange' => [
            'EndTime' => <DateTime>,
            'StartTime' => <DateTime>,
        ],
        'ResourceCollection' => [
            'CloudFormation' => [
                'StackNames' => ['<string>', ...],
            ],
        ],
        'Severity' => 'LOW|MEDIUM|HIGH',
        'SourceDetails' => [
            'CloudWatchMetrics' => [
                [
                    'Dimensions' => [
                        [
                            'Name' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'MetricName' => '<string>',
                    'Namespace' => '<string>',
                    'Period' => <integer>,
                    'Stat' => 'Sum|Average|SampleCount|Minimum|Maximum|p99|p90|p50',
                    'Unit' => '<string>',
                ],
                // ...
            ],
        ],
        'Status' => 'ONGOING|CLOSED',
        'UpdateTime' => <DateTime>,
    ],
    'ReactiveAnomaly' => [
        'AnomalyTimeRange' => [
            'EndTime' => <DateTime>,
            'StartTime' => <DateTime>,
        ],
        'AssociatedInsightId' => '<string>',
        'Id' => '<string>',
        'ResourceCollection' => [
            'CloudFormation' => [
                'StackNames' => ['<string>', ...],
            ],
        ],
        'Severity' => 'LOW|MEDIUM|HIGH',
        'SourceDetails' => [
            'CloudWatchMetrics' => [
                [
                    'Dimensions' => [
                        [
                            'Name' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'MetricName' => '<string>',
                    'Namespace' => '<string>',
                    'Period' => <integer>,
                    'Stat' => 'Sum|Average|SampleCount|Minimum|Maximum|p99|p90|p50',
                    'Unit' => '<string>',
                ],
                // ...
            ],
        ],
        'Status' => 'ONGOING|CLOSED',
    ],
]

Result Details

Members

ProactiveAnomaly

Type: ProactiveAnomaly structure

An ReactiveAnomaly object that represents the requested anomaly.

ReactiveAnomaly

Type: ReactiveAnomaly structure

An ProactiveAnomaly object that represents the requested anomaly.

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.

DescribeFeedback

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

Returns the most recent feedback submitted in the current AWS account and Region.

Parameter Syntax

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

Parameter Details

Members

InsightId

Type: string

The ID of the insight for which the feedback was provided.

Result Syntax

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

Result Details

Members

InsightFeedback

Type: InsightFeedback structure

Information about insight feedback received from a customer.

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([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Id

Required: Yes
Type: string

The ID of the insight.

Result Syntax

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

Result Details

Members

ProactiveInsight

Type: ProactiveInsight structure

An ProactiveInsight object that represents the requested insight.

ReactiveInsight

Type: ReactiveInsight structure

An ReactiveInsight object that represents the requested insight.

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.

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 AWS resources collection. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.

Parameter Syntax

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

Parameter Details

Members

NextToken

Type: string

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

ResourceCollectionType

Required: Yes
Type: string

An AWS resource collection type. This type specifies how analyzed AWS resources are defined. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.

Result Syntax

[
    'CloudFormation' => [
        [
            'Insight' => [
                'MeanTimeToRecoverInMilliseconds' => <integer>,
                'OpenProactiveInsights' => <integer>,
                'OpenReactiveInsights' => <integer>,
            ],
            'StackName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

CloudFormation

Required: Yes
Type: Array of CloudFormationHealth structures

The returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with the requested system health information.

NextToken

Type: string

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

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 AWS Systems Manager, which can be used to create an OpsItem for each generated insight.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[
    'ServiceIntegration' => [
        'OpsCenter' => [
            'OptInStatus' => 'ENABLED|DISABLED',
        ],
    ],
]

Result Details

Members

ServiceIntegration

Type: ServiceIntegrationConfig structure

Information about the integration of DevOps Guru with another AWS service, such as AWS Systems Manager.

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.

GetResourceCollection

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

Returns lists AWS resources that are of the specified resource collection type. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.

Parameter Syntax

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

Parameter Details

Members

NextToken

Type: string

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

ResourceCollectionType

Required: Yes
Type: string

The type of AWS resource collections to return. The one valid value is CLOUD_FORMATION for AWS CloudFormation stacks.

Result Syntax

[
    'NextToken' => '<string>',
    'ResourceCollection' => [
        'CloudFormation' => [
            'StackNames' => ['<string>', ...],
        ],
    ],
]

Result Details

Members

NextToken

Type: string

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

ResourceCollection

Type: ResourceCollectionFilter structure

The requested list of AWS resource collections. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.

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([
    'InsightId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StartTimeRange' => [
        'FromTime' => <integer || string || DateTime>,
        'ToTime' => <integer || string || DateTime>,
    ],
]);

Parameter Details

Members

InsightId

Required: Yes
Type: string

The ID of the insight. The returned anomalies belong to this insight.

MaxResults

Type: int

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

NextToken

Type: string

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

StartTimeRange

Type: StartTimeRange structure

A time range used to specify when the requested anomalies started. All returned anomalies started during this time range.

Result Syntax

[
    'NextToken' => '<string>',
    'ProactiveAnomalies' => [
        [
            'AnomalyTimeRange' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'AssociatedInsightId' => '<string>',
            'Id' => '<string>',
            'Limit' => <float>,
            'PredictionTimeRange' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'ResourceCollection' => [
                'CloudFormation' => [
                    'StackNames' => ['<string>', ...],
                ],
            ],
            'Severity' => 'LOW|MEDIUM|HIGH',
            'SourceDetails' => [
                'CloudWatchMetrics' => [
                    [
                        'Dimensions' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'MetricName' => '<string>',
                        'Namespace' => '<string>',
                        'Period' => <integer>,
                        'Stat' => 'Sum|Average|SampleCount|Minimum|Maximum|p99|p90|p50',
                        'Unit' => '<string>',
                    ],
                    // ...
                ],
            ],
            'Status' => 'ONGOING|CLOSED',
            'UpdateTime' => <DateTime>,
        ],
        // ...
    ],
    'ReactiveAnomalies' => [
        [
            'AnomalyTimeRange' => [
                'EndTime' => <DateTime>,
                'StartTime' => <DateTime>,
            ],
            'AssociatedInsightId' => '<string>',
            'Id' => '<string>',
            'ResourceCollection' => [
                'CloudFormation' => [
                    'StackNames' => ['<string>', ...],
                ],
            ],
            'Severity' => 'LOW|MEDIUM|HIGH',
            'SourceDetails' => [
                'CloudWatchMetrics' => [
                    [
                        'Dimensions' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'MetricName' => '<string>',
                        'Namespace' => '<string>',
                        'Period' => <integer>,
                        'Stat' => 'Sum|Average|SampleCount|Minimum|Maximum|p99|p90|p50',
                        'Unit' => '<string>',
                    ],
                    // ...
                ],
            ],
            'Status' => 'ONGOING|CLOSED',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

ProactiveAnomalies

Type: Array of ProactiveAnomalySummary structures

An array of ProactiveAnomalySummary objects that represent the requested anomalies

ReactiveAnomalies

Type: Array of ReactiveAnomalySummary structures

An array of ReactiveAnomalySummary objects that represent the requested anomalies

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([
    '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>', ...],
            ],
        ],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Required: Yes
Type: ListEventsFilters structure

A ListEventsFilters object used to specify which events to return.

MaxResults

Type: int

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

NextToken

Type: string

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

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>', ...],
                ],
            ],
            'Resources' => [
                [
                    'Arn' => '<string>',
                    'Name' => '<string>',
                    'Type' => '<string>',
                ],
                // ...
            ],
            'Time' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Events

Required: Yes
Type: Array of Event structures

A list of the requested events.

NextToken

Type: string

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

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 AWS 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

Members

MaxResults

Type: int

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

NextToken

Type: string

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

StatusFilter

Required: Yes
Type: ListInsightsStatusFilter structure

A filter used to filter the returned insights by their status. You can specify one status filter.

Result Syntax

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

Result Details

Members

NextToken

Type: string

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

ProactiveInsights

Type: Array of ProactiveInsightSummary structures

The returned list of proactive insights.

ReactiveInsights

Type: Array of ReactiveInsightSummary structures

The returned list of reactive insights.

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.

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

Members

NextToken

Type: string

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Result Syntax

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

Result Details

Members

Channels

Type: Array of NotificationChannel structures

An array that contains the requested notification channels.

NextToken

Type: string

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

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([
    'InsightId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Members

InsightId

Required: Yes
Type: string

The ID of the requested insight.

NextToken

Type: string

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Result Syntax

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

Result Details

Members

NextToken

Type: string

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Recommendations

Type: Array of Recommendation structures

An array of the requested recommendations.

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

Members

InsightFeedback

Type: InsightFeedback structure

The feedback from customers is about the recommendations in this insight.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

Id

Required: Yes
Type: string

The ID of the notification channel to be removed.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 AWS account. 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->searchInsights([
    'Filters' => [
        'ResourceCollection' => [
            'CloudFormation' => [
                'StackNames' => ['<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

Members

Filters

Type: SearchInsightsFilters structure

A SearchInsightsFilters object that is used to set the severity and status filters on your insight search.

MaxResults

Type: int

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

NextToken

Type: string

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

StartTimeRange

Required: Yes
Type: StartTimeRange structure

The start of the time range passed in. Returned insights occurred after this time.

Type

Required: Yes
Type: string

The type of insights you are searching for (REACTIVE or PROACTIVE).

Result Syntax

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

Result Details

Members

NextToken

Type: string

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

ProactiveInsights

Type: Array of ProactiveInsightSummary structures

The returned proactive insights.

ReactiveInsights

Type: Array of ReactiveInsightSummary structures

The returned reactive insights.

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 one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the 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>', ...],
        ],
    ],
]);

Parameter Details

Members

Action

Required: Yes
Type: string

Specifies if the resource collection in the request is added or deleted to the resource collection.

ResourceCollection

Required: Yes
Type: UpdateResourceCollectionFilter structure

Contains information used to update a collection of AWS resources.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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 AWS Systems Manager, which can be used to create an OpsItem for each generated insight.

Parameter Syntax

$result = $client->updateServiceIntegration([
    'ServiceIntegration' => [ // REQUIRED
        'OpsCenter' => [
            'OptInStatus' => 'ENABLED|DISABLED',
        ],
    ],
]);

Parameter Details

Members

ServiceIntegration

Required: Yes
Type: UpdateServiceIntegrationConfig structure

An IntegratedServiceConfig object used to specify the integrated service you want to update, and whether you want to update it to enabled or disabled.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

Shapes

AccessDeniedException

Description

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.

Members

Message

Required: Yes
Type: string

AnomalySourceDetails

Description

Details about the source of the anomalous operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.

Members

CloudWatchMetrics

Type: Array of CloudWatchMetricsDetail structures

An array of CloudWatchMetricsDetail object that contains information about the analyzed metrics that displayed anomalous behavior.

AnomalyTimeRange

Description

A time range that specifies when the observed unusual behavior in an anomaly started and ended.

Members

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the anomalous behavior ended.

StartTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the anomalous behavior started.

CloudFormationCollection

Description

Information about AWS CloudFormation stacks. You can use stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide.

Members

StackNames

Type: Array of strings

An array of CloudFormation stack names.

CloudFormationCollectionFilter

Description

Information about AWS CloudFormation stacks. You can use stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide.

Members

StackNames

Type: Array of strings

An array of CloudFormation stack names.

CloudFormationHealth

Description

Information about the health of AWS resources in your account that are specified by an AWS CloudFormation stack.

Members

Insight

Type: InsightHealth structure

Information about the health of the AWS resources in your account that are specified by an AWS CloudFormation stack, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.

StackName

Type: string

The name of the CloudFormation stack.

CloudWatchMetricsDetail

Description

Information about an Amazon CloudWatch metric.

Members

Dimensions

Type: Array of CloudWatchMetricsDimension structures

An array of CloudWatch dimensions associated with

MetricName

Type: string

The name of the CloudWatch metric.

Namespace

Type: string

The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.

Period

Type: int

The length of time associated with the CloudWatch metric in number of seconds.

Stat

Type: string

The type of statistic associated with the CloudWatch metric. For more information, see Statistics in the Amazon CloudWatch User Guide.

Unit

Type: string

The unit of measure used for the CloudWatch metric. For example, Bytes, Seconds, Count, and Percent.

CloudWatchMetricsDimension

Description

The dimension of a Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in your account for operational problems and anomalous behavior. A dimension is a name/value pair that is part of the identity of a metric. A metric can have up to 10 dimensions. For more information, see Dimensions in the Amazon CloudWatch User Guide.

Members

Name

Type: string

The name of the CloudWatch dimension.

Value

Type: string

The value of the CloudWatch dimension.

ConflictException

Description

An exception that is thrown when a conflict occurs.

Members

Message

Required: Yes
Type: string

ResourceId

Required: Yes
Type: string

The ID of the AWS resource in which a conflict occurred.

ResourceType

Required: Yes
Type: string

The type of the AWS resource in which a conflict occurred.

EndTimeRange

Description

A range of time that specifies when anomalous behavior in an anomaly or insight ended.

Members

FromTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The earliest end time in the time range.

ToTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The latest end time in the time range.

Event

Description

An AWS resource event. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.

Members

DataSource

Type: string

The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, where DevOps Guru analysis found the event.

EventClass

Type: string

The class of the event. The class specifies what the event is related to, such as an infrastructure change, a deployment, or a schema change.

EventSource

Type: string

The AWS source that emitted the event.

Id

Type: string

The ID of the event.

Name

Type: string

The name of the event.

ResourceCollection

Type: ResourceCollection structure

A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.

Resources

Type: Array of EventResource structures

An EventResource object that contains information about the resource that emitted the event.

Time

Type: timestamp (string|DateTime or anything parsable by strtotime)

A Timestamp that specifies the time the event occurred.

EventResource

Description

The AWS resource that emitted an event. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the resource that emitted an event.

Name

Type: string

The name of the resource that emitted an event.

Type

Type: string

The type of resource that emitted an event.

EventTimeRange

Description

The time range during which an AWS event occurred. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.

Members

FromTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the event started.

ToTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the event ended.

InsightFeedback

Description

Information about insight feedback received from a customer.

Members

Feedback

Type: string

The feedback provided by the customer.

Id

Type: string

The insight feedback ID.

InsightHealth

Description

Information about the number of open reactive and proactive insights that can be used to gauge the health of your system.

Members

MeanTimeToRecoverInMilliseconds

Type: long (int|float)

The Meant Time to Recover (MTTR) for the insight.

OpenProactiveInsights

Type: int

The number of open proactive insights.

OpenReactiveInsights

Type: int

The number of open reactive insights.

InsightTimeRange

Description

A time ranged that specifies when the observed behavior in an insight started and ended.

Members

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the behavior described in an insight ended.

StartTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the behavior described in an insight started.

InternalServerException

Description

An internal failure in an Amazon service occurred.

Members

Message

Required: Yes
Type: string

RetryAfterSeconds

Type: int

The number of seconds after which the action that caused the internal server exception can be retried.

ListEventsFilters

Description

Filters you can use to specify which events are returned when ListEvents is called.

Members

DataSource

Type: string

The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, of the events you want returned.

EventClass

Type: string

The class of the events you want to filter for, such as an infrastructure change, a deployment, or a schema change.

EventSource

Type: string

The AWS source that emitted the events you want to filter for.

EventTimeRange

Type: EventTimeRange structure

A time range during which you want the filtered events to have occurred.

InsightId

Type: string

An ID of an insight that is related to the events you want to filter for.

ResourceCollection

Type: ResourceCollection structure

ListInsightsAnyStatusFilter

Description

Used to filter for insights that have any status.

Members

StartTimeRange

Required: Yes
Type: StartTimeRange structure

A time range used to specify when the behavior of the filtered insights started.

Type

Required: Yes
Type: string

Use to filter for either REACTIVE or PROACTIVE insights.

ListInsightsClosedStatusFilter

Description

Used to filter for insights that have the status CLOSED.

Members

EndTimeRange

Required: Yes
Type: EndTimeRange structure

A time range used to specify when the behavior of the filtered insights ended.

Type

Required: Yes
Type: string

Use to filter for either REACTIVE or PROACTIVE insights.

ListInsightsOngoingStatusFilter

Description

Used to filter for insights that have the status ONGOING.

Members

Type

Required: Yes
Type: string

Use to filter for either REACTIVE or PROACTIVE insights.

ListInsightsStatusFilter

Description

A filter used by ListInsights to specify which insights to return.

Members

Any

Type: ListInsightsAnyStatusFilter structure

A ListInsightsAnyStatusFilter that specifies insights of any status that are either REACTIVE or PROACTIVE.

Closed

Type: ListInsightsClosedStatusFilter structure

A ListInsightsClosedStatusFilter that specifies closed insights that are either REACTIVE or PROACTIVE.

Ongoing

Type: ListInsightsOngoingStatusFilter structure

A ListInsightsAnyStatusFilter that specifies ongoing insights that are either REACTIVE or PROACTIVE.

NotificationChannel

Description

Information about a notification channel. A notification channel is used to notify you when DevOps Guru creates an insight. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).

Members

Config

Type: NotificationChannelConfig structure

A NotificationChannelConfig object that contains information about configured notification channels.

Id

Type: string

The ID of a notification channel.

NotificationChannelConfig

Description

Information about notification channels you have configured with DevOps Guru. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).

Members

Sns

Required: Yes
Type: SnsChannelConfig structure

Information about a notification channel configured in DevOps Guru to send notifications when insights are created.

OpsCenterIntegration

Description

Information about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight.

Members

OptInStatus

Type: string

Specifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight.

OpsCenterIntegrationConfig

Description

Information about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight.

Members

OptInStatus

Type: string

Specifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight.

PredictionTimeRange

Description

The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.

Members

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the behavior in a proactive insight is expected to end.

StartTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.

ProactiveAnomaly

Description

Information about an anomaly. This object is returned by ListAnomalies.

Members

AnomalyTimeRange

Type: AnomalyTimeRange structure

A time range that specifies when the observed unusual behavior in an anomaly started and ended.

AssociatedInsightId

Type: string

The ID of the insight that contains this anomaly. An insight is composed of related anomalies.

Id

Type: string

The ID of a proactive anomaly.

Limit

Type: double

A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly.

PredictionTimeRange

Type: PredictionTimeRange structure

The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.

ResourceCollection

Type: ResourceCollection structure

Severity

Type: string

The severity of a proactive anomaly.

SourceDetails

Type: AnomalySourceDetails structure

Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.

Status

Type: string

The status of a proactive anomaly.

UpdateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time of the anomaly's most recent update.

ProactiveAnomalySummary

Description

Details about a proactive anomaly. This object is returned by DescribeAnomaly.

Members

AnomalyTimeRange

Type: AnomalyTimeRange structure

A time range that specifies when the observed unusual behavior in an anomaly started and ended.

AssociatedInsightId

Type: string

The ID of the insight that contains this anomaly. An insight is composed of related anomalies.

Id

Type: string

The ID of the anomaly.

Limit

Type: double

A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly.

PredictionTimeRange

Type: PredictionTimeRange structure

The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.

ResourceCollection

Type: ResourceCollection structure

Severity

Type: string

The severity of the anomaly.

SourceDetails

Type: AnomalySourceDetails structure

Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.

Status

Type: string

The status of the anomaly.

UpdateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time of the anomaly's most recent update.

ProactiveInsight

Description

Details about a proactive insight. This object is returned by ListInsights.

Members

Id

Type: string

The ID of the proactive insight.

InsightTimeRange

Type: InsightTimeRange structure

A time ranged that specifies when the observed behavior in an insight started and ended.

Name

Type: string

The name of the proactive insight.

PredictionTimeRange

Type: PredictionTimeRange structure

The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.

ResourceCollection

Type: ResourceCollection structure

Severity

Type: string

The severity of the proactive insight.

SsmOpsItemId

Type: string

The ID of the AWS System Manager OpsItem created for this insight. You must enable the creation of OpstItems insights before they are created for each insight.

Status

Type: string

The status of the proactive insight.

ProactiveInsightSummary

Description

Details about a proactive insight. This object is returned by DescribeInsight.

Members

Id

Type: string

The ID of the proactive insight.

InsightTimeRange

Type: InsightTimeRange structure

A time ranged that specifies when the observed behavior in an insight started and ended.

Name

Type: string

The name of the proactive insight.

PredictionTimeRange

Type: PredictionTimeRange structure

The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.

ResourceCollection

Type: ResourceCollection structure

Severity

Type: string

The severity of the proactive insight.

Status

Type: string

The status of the proactive insight.

ReactiveAnomaly

Description

Details about a reactive anomaly. This object is returned by ListAnomalies.

Members

AnomalyTimeRange

Type: AnomalyTimeRange structure

A time range that specifies when the observed unusual behavior in an anomaly started and ended.

AssociatedInsightId

Type: string

The ID of the insight that contains this anomaly. An insight is composed of related anomalies.

Id

Type: string

The ID of the reactive anomaly.

ResourceCollection

Type: ResourceCollection structure

Severity

Type: string

The severity of the anomaly.

SourceDetails

Type: AnomalySourceDetails structure

Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.

Status

Type: string

The status of the anomaly.

ReactiveAnomalySummary

Description

Details about a reactive anomaly. This object is returned by DescribeAnomaly.

Members

AnomalyTimeRange

Type: AnomalyTimeRange structure

A time range that specifies when the observed unusual behavior in an anomaly started and ended.

AssociatedInsightId

Type: string

The ID of the insight that contains this anomaly. An insight is composed of related anomalies.

Id

Type: string

The ID of the reactive anomaly.

ResourceCollection

Type: ResourceCollection structure

Severity

Type: string

The severity of the reactive anomaly.

SourceDetails

Type: AnomalySourceDetails structure

Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.

Status

Type: string

The status of the reactive anomaly.

ReactiveInsight

Description

Information about a reactive insight. This object is returned by ListInsights.

Members

Id

Type: string

The ID of a reactive insight.

InsightTimeRange

Type: InsightTimeRange structure

A time ranged that specifies when the observed behavior in an insight started and ended.

Name

Type: string

The name of a reactive insight.

ResourceCollection

Type: ResourceCollection structure

Severity

Type: string

The severity of a reactive insight.

SsmOpsItemId

Type: string

The ID of the AWS System Manager OpsItem created for this insight. You must enable the creation of OpstItems insights before they are created for each insight.

Status

Type: string

The status of a reactive insight.

ReactiveInsightSummary

Description

Information about a reactive insight. This object is returned by DescribeInsight.

Members

Id

Type: string

The ID of a reactive summary.

InsightTimeRange

Type: InsightTimeRange structure

A time ranged that specifies when the observed behavior in an insight started and ended.

Name

Type: string

The name of a reactive insight.

ResourceCollection

Type: ResourceCollection structure

Severity

Type: string

The severity of a reactive insight.

Status

Type: string

The status of a reactive insight.

Recommendation

Description

Recommendation information to help you remediate detected anomalous behavior that generated an insight.

Members

Description

Type: string

A description of the problem.

Link

Type: string

A hyperlink to information to help you address the problem.

Name

Type: string

The name of the recommendation.

Reason

Type: string

The reason DevOps Guru flagged the anomalous behavior as a problem.

RelatedAnomalies

Type: Array of RecommendationRelatedAnomaly structures

Anomalies that are related to the problem. Use these Anomalies to learn more about what's happening and to help address the issue.

RelatedEvents

Type: Array of RecommendationRelatedEvent structures

Events that are related to the problem. Use these events to learn more about what's happening and to help address the issue.

RecommendationRelatedAnomaly

Description

Information about an anomaly that is related to a recommendation.

Members

Resources

Type: Array of RecommendationRelatedAnomalyResource structures

An array of objects that represent resources in which DevOps Guru detected anomalous behavior. Each object contains the name and type of the resource.

SourceDetails

Type: Array of RecommendationRelatedAnomalySourceDetail structures

Information about where the anomalous behavior related the recommendation was found. For example, details in Amazon CloudWatch metrics.

RecommendationRelatedAnomalyResource

Description

Information about a resource in which DevOps Guru detected anomalous behavior.

Members

Name

Type: string

The name of the resource.

Type

Type: string

The type of the resource.

RecommendationRelatedAnomalySourceDetail

Description

Contains an array of RecommendationRelatedCloudWatchMetricsSourceDetail objects that contain the name and namespace of an Amazon CloudWatch metric.

Members

CloudWatchMetrics

Type: Array of RecommendationRelatedCloudWatchMetricsSourceDetail structures

An array of CloudWatchMetricsDetail objects that contains information about the analyzed metrics that displayed anomalous behavior.

RecommendationRelatedCloudWatchMetricsSourceDetail

Description

Information about an Amazon CloudWatch metric that is analyzed by DevOps Guru. It is one of many analyzed metrics that are used to generate insights.

Members

MetricName

Type: string

The name of the CloudWatch metric.

Namespace

Type: string

The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.

RecommendationRelatedEvent

Description

Information about an event that is related to a recommendation.

Members

Name

Type: string

The name of the event. This corresponds to the Name field in an Event object.

Resources

Type: Array of RecommendationRelatedEventResource structures

A ResourceCollection object that contains arrays of the names of AWS CloudFormation stacks.

RecommendationRelatedEventResource

Description

Information about an AWS resource that emitted and event that is related to a recommendation in an insight.

Members

Name

Type: string

The name of the resource that emitted the event. This corresponds to the Name field in an EventResource object.

Type

Type: string

The type of the resource that emitted the event. This corresponds to the Type field in an EventResource object.

ResourceCollection

Description

Members

CloudFormation

Type: CloudFormationCollection structure

An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes.

ResourceCollectionFilter

Description

Information about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.

Members

CloudFormation

Type: CloudFormationCollectionFilter structure

Information about AWS CloudFormation stacks. You can use stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide.

ResourceNotFoundException

Description

A requested resource could not be found

Members

Message

Required: Yes
Type: string

ResourceId

Required: Yes
Type: string

The ID of the AWS resource that could not be found.

ResourceType

Required: Yes
Type: string

The type of the AWS resource that could not be found.

SearchInsightsFilters

Description

Specifies one or more severity values and one or more status values that are used to search for insights.

Members

ResourceCollection

Type: ResourceCollection structure

Severities

Type: Array of strings

An array of severity values used to search for insights.

Statuses

Type: Array of strings

An array of status values used to search for insights.

ServiceIntegrationConfig

Description

Information about the integration of DevOps Guru with another AWS service, such as AWS Systems Manager.

Members

OpsCenter

Type: OpsCenterIntegration structure

Information about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight.

ServiceQuotaExceededException

Description

The request contains a value that exceeds a maximum quota.

Members

Message

Type: string

SnsChannelConfig

Description

Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.

Members

TopicArn

Type: string

The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.

StartTimeRange

Description

A time range used to specify when the behavior of an insight or anomaly started.

Members

FromTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time of the time range.

ToTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The end time of the time range.

ThrottlingException

Description

The request was denied due to a request throttling.

Members

Message

Required: Yes
Type: string

QuotaCode

Type: string

The code of the quota that was exceeded, causing the throttling exception.

RetryAfterSeconds

Type: int

The number of seconds after which the action that caused the throttling exception can be retried.

ServiceCode

Type: string

The code of the service that caused the throttling exception.

UpdateCloudFormationCollectionFilter

Description

Contains the names of AWS CloudFormation stacks used to update a collection of stacks.

Members

StackNames

Type: Array of strings

An array of the name of stacks to update.

UpdateResourceCollectionFilter

Description

Contains information used to update a collection of AWS resources.

Members

CloudFormation

Type: UpdateCloudFormationCollectionFilter structure

An collection of AWS CloudFormation stacks.

UpdateServiceIntegrationConfig

Description

Information about updating the integration status of an AWS service, such as AWS Systems Manager, with DevOps Guru.

Members

OpsCenter

Type: OpsCenterIntegrationConfig structure

Information about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight.

ValidationException

Description

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

Members

Fields

Type: Array of ValidationExceptionField structures

An array of fields that are associated with the validation exception.

Message

Required: Yes
Type: string

A message that describes the validation exception.

Reason

Type: string

The reason the validation exception was thrown.

ValidationExceptionField

Description

The field associated with the validation exception.

Members

Message

Required: Yes
Type: string

The message associated with the validation exception with information to help determine its cause.

Name

Required: Yes
Type: string

The name of the field.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon DevOps Guru 2020-12-01

Operation Summary

Paginators

Operations

AddNotificationChannel

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeAccountHealth

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeAccountOverview

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeAnomaly

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeFeedback

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeInsight

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeResourceCollectionHealth

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeServiceIntegration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetResourceCollection

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details