Amazon DevOps Guru 2020-12-01
- 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.
- DeleteInsight ( array $params = [] )
Deletes the insight along with the associated anomalies, events and recommendations.
- DescribeAccountHealth ( array $params = [] )
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.
- 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.
- DescribeEventSourcesConfig ( array $params = [] )
Returns the integration status of services that are integrated with DevOps Guru as Consumer via EventBridge.
- DescribeFeedback ( array $params = [] )
Returns the most recent feedback submitted in the current Amazon Web Services account and Region.
- DescribeInsight ( array $params = [] )
Returns details about an insight that you specify using its ID.
- DescribeOrganizationHealth ( array $params = [] )
Returns active insights, predictive insights, and resource hours analyzed in last hour.
- DescribeOrganizationOverview ( array $params = [] )
Returns an overview of your organization's history based on the specified time range.
- DescribeOrganizationResourceCollectionHealth ( array $params = [] )
Provides an overview of your system's health.
- 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.
- GetCostEstimation ( array $params = [] )
Returns an estimate of the monthly cost for DevOps Guru to analyze your Amazon Web Services resources.
- GetResourceCollection ( array $params = [] )
Returns lists Amazon Web Services 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 Amazon Web Services account.
- ListNotificationChannels ( array $params = [] )
Returns a list of notification channels configured for DevOps Guru.
- ListOrganizationInsights ( array $params = [] )
Returns a list of insights associated with the account or OU Id.
- 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 Amazon Web Services account.
- SearchOrganizationInsights ( array $params = [] )
Returns a list of insights in your organization.
- StartCostEstimation ( array $params = [] )
Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources.
- UpdateEventSourcesConfig ( array $params = [] )
Enables or disables integration with a service that can be integrated with DevOps Guru.
- 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:
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. DevOps Guru only supports standard SNS topics. For more information, see Permissions for cross account Amazon SNS topics.
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 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
'Sns' => [ // REQUIRED
'TopicArn' => '<string>',
],
],
]);
Parameter Details
Members
- Config
-
- Required: Yes
- Type: NotificationChannelConfig structure
A
NotificationChannelConfigobject 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
Errors
-
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.
-
An exception that is thrown when a conflict occurs.
-
An internal failure in an Amazon service occurred.
-
A requested resource could not be found
-
ServiceQuotaExceededException:
The request contains a value that exceeds a maximum quota.
-
The request was denied due to a request throttling.
-
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
-
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.
-
An internal failure in an Amazon service occurred.
-
A requested resource could not be found
-
An exception that is thrown when a conflict occurs.
-
The request was denied due to a request throttling.
-
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
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 Amazon Web Services account.
- OpenProactiveInsights
-
- Required: Yes
- Type: int
An integer that specifies the number of open proactive insights in your Amazon Web Services account.
- OpenReactiveInsights
-
- Required: Yes
- Type: int
An integer that specifies the number of open reactive insights in your Amazon Web Services account.
- ResourceHours
-
- Required: Yes
- Type: long (int|float)
The number of Amazon DevOps Guru resource analysis hours billed to the current Amazon Web Services account in the last hour.
Errors
-
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.
-
An internal failure in an Amazon service occurred.
-
The request was denied due to a request throttling.
-
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 Amazon Web Services 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 Amazon Web Services account that were created during the time range passed in.
Errors
-
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.
-
An internal failure in an Amazon service occurred.
-
The request was denied due to a request throttling.
-
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
Members
Result Syntax
[
'ProactiveAnomaly' => [
'AnomalyReportedTimeRange' => [
'CloseTime' => <DateTime>,
'OpenTime' => <DateTime>,
],
'AnomalyResources' => [
[
'Name' => '<string>',
'Type' => '<string>',
],
// ...
],
'AnomalyTimeRange' => [
'EndTime' => <DateTime>,
'StartTime' => <DateTime>,
],
'AssociatedInsightId' => '<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
Members
- ProactiveAnomaly
-
- Type: ProactiveAnomaly structure
A
ProactiveAnomalyobject that represents the requested anomaly. - ReactiveAnomaly
-
- Type: ReactiveAnomaly structure
A
ReactiveAnomalyobject that represents the requested anomaly.
Errors
-
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.
-
An internal failure in an Amazon service occurred.
-
A requested resource could not be found
-
The request was denied due to a request throttling.
-
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
Members
Result Syntax
[
'EventSources' => [
'AmazonCodeGuruProfiler' => [
'Status' => 'ENABLED|DISABLED',
],
],
]
Result Details
Members
- EventSources
-
- Type: EventSourcesConfig structure
Lists the event sources in the configuration.
Errors
-
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.
-
An internal failure in an Amazon service occurred.
-
The request was denied due to a request throttling.
-
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
Members
- InsightFeedback
-
- Type: InsightFeedback structure
Information about insight feedback received from a customer.
Errors
-
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.
-
An internal failure in an Amazon service occurred.
-
A requested resource could not be found
-
The request was denied due to a request throttling.
-
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
Members
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
Members
- ProactiveInsight
-
- Type: ProactiveInsight structure
A
ProactiveInsightobject that represents the requested insight. - ReactiveInsight
-
- Type: ReactiveInsight structure
A
ReactiveInsightobject that represents the requested insight.
Errors
-
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.
-
An internal failure in an Amazon service occurred.
-
A requested resource could not be found
-
The request was denied due to a request throttling.
-
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
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 organization.
- OpenProactiveInsights
-
- Required: Yes
- Type: int
An integer that specifies the number of open proactive insights in your Amazon Web Services account.
- OpenReactiveInsights
-
- Required: Yes
- Type: int
An integer that specifies the number of open reactive insights in your Amazon Web Services account.
- ResourceHours
-
- Required: Yes
- Type: long (int|float)
The number of Amazon DevOps Guru resource analysis hours billed to the current Amazon Web Services account in the last hour.
Errors
-
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.
-
An internal failure in an Amazon service occurred.
-
The request was denied due to a request throttling.
-
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
Members
- AccountIds
-
- Type: Array of strings
The ID of the Amazon Web Services account.
- 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.
- OrganizationalUnitIds
-
- Type: Array of strings
The ID of the organizational unit.
- 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
[
'ProactiveInsights' => <integer>,
'ReactiveInsights' => <integer>,
]
Result Details
Members
Errors
-
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.
-
An internal failure in an Amazon service occurred.
-
The request was denied due to a request throttling.
-
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
Members
- AccountIds
-
- Type: Array of strings
The ID of the Amazon Web Services account.
- 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
nextTokenvalue. - 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.
- OrganizationResourceCollectionType
-
- Required: Yes
- Type: string
An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. 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.
- OrganizationalUnitIds
-
- Type: Array of strings
The ID of the organizational unit.
Result Syntax
[
'Account' => [
[
'AccountId' => '<string>',
'Insight' => [
'OpenProactiveInsights' => <integer>,
'OpenReactiveInsights' => <integer>,
],
],
// ...
],
'CloudFormation' => [
[
'Insight' => [
'MeanTimeToRecoverInMilliseconds' => <integer>,
'OpenProactiveInsights' => <integer>,
'OpenReactiveInsights' => <integer>,
],
'StackName' => '<string>',
],
// ...
],
'NextToken' => '<string>',
'Service' => [
[
'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' => [
[
'AppBoundaryKey' => '<string>',
'Insight' => [
'MeanTimeToRecoverInMilliseconds' => <integer>,
'OpenProactiveInsights' => <integer>,
'OpenReactiveInsights' => <integer>,
],
'TagValue' => '<string>',
],
// ...
],
]
Result Details
Members
- Account
-
- Type: Array of AccountHealth structures
The name of the organization's account.
- CloudFormation
-
- Type: Array of CloudFormationHealth structures
The returned
CloudFormationHealthOverviewobject that contains anInsightHealthOverviewobject 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.
- Service
-
- Type: Array of ServiceHealth structures
An array of
ServiceHealthobjects that describes the health of the Amazon Web Services services associated with the resources in the collection. - Tags
-
- Type: Array of TagHealth structures
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
-
A tag key (for example,
CostCenter,Environment,Project, orSecret). Tag keys are case-sensitive. -
An optional field known as a tag value (for example,
111122223333,Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix
Devops-guru-. The tag key might beDevops-guru-deployment-applicationorDevops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key nameddevops-guru-rdsand a key namedDevOps-Guru-RDS. Possible key/value pairs in your application might beDevops-Guru-production-application/RDSorDevops-Guru-production-application/containers.
Errors
-
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.
-
An internal failure in an Amazon service occurred.
-
The request was denied due to a request throttling.
-
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
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 Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. 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.
Result Syntax
[
'CloudFormation' => [
[
'Insight' => [
'MeanTimeToRecoverInMilliseconds' => <integer>,
'OpenProactiveInsights' => <integer>,
'OpenReactiveInsights' => <integer>,
],
'StackName' => '<string>',
],
// ...
],
'NextToken' => '<string>',
'Service' => [
[
'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' => [
[
'AppBoundaryKey' => '<string>',
'Insight' => [
'MeanTimeToRecoverInMilliseconds' => <integer>,
'OpenProactiveInsights' => <integer>,
'OpenReactiveInsights' => <integer>,
],
'TagValue' => '<string>',
],
// ...
],
]
Result Details
Members
- CloudFormation
-
- Type: Array of CloudFormationHealth structures
The returned
CloudFormationHealthOverviewobject that contains anInsightHealthOverviewobject 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.
- Service
-
- Type: Array of ServiceHealth structures
An array of
ServiceHealthobjects that describes the health of the Amazon Web Services services associated with the resources in the collection. - Tags
-
- Type: Array of TagHealth structures
The Amazon Web Services tags that are used by resources in the resource collection.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
-
A tag key (for example,
CostCenter,Environment,Project, orSecret). Tag keys are case-sensitive. -
An optional field known as a tag value (for example,
111122223333,Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix
Devops-guru-. The tag key might beDevops-guru-deployment-applicationorDevops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key nameddevops-guru-rdsand a key namedDevOps-Guru-RDS. Possible key/value pairs in your application might beDevops-Guru-production-application/RDSorDevops-Guru-production-application/containers.
Errors
-
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.
-
An internal failure in an Amazon service occurred.
-
The request was denied due to a request throttling.
-
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
Members
Result Syntax
[
'ServiceIntegration' => [
'OpsCenter' => [
'OptInStatus' => 'ENABLED|DISABLED',
],
],
]
Result Details
Members
- ServiceIntegration
-
- Type: ServiceIntegrationConfig structure
Information about the integration of DevOps Guru with another Amazon Web Services service, such as Amazon Web Services Systems Manager.
Errors
-
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.
-
An internal failure in an Amazon service occurred.
-
The request was denied due to a request throttling.
-
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
Members
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
Members
- Costs
-
- Type: Array of ServiceResourceCost structures
An array of
ResourceCostobjects that each contains details about the monthly cost estimate to analyze one of your Amazon Web Services resources. - 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: CostEstimationResourceCollectionFilter structure
The collection of the Amazon Web Services resources used to create your monthly DevOps Guru cost estimate.
- Status
-
- Type: string
The status of creating this cost estimate. If it's still in progress, the status
ONGOINGis returned. If it is finished, the statusCOMPLETEDis returned. - TimeRange
-
- Type: CostEstimationTimeRange structure
The start and end time of the cost estimation.
- TotalCost
-
- Type: double
The estimated monthly cost to analyze the Amazon Web Services resources. This value is the sum of the estimated costs to analyze each resource in the
Costsobject in this response.
Errors
-
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.
-
An internal failure in an Amazon service occurred.
-
A requested resource could not be found
-
The request was denied due to a request throttling.
-
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
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 Amazon Web Services resource collections to return. The one valid value is
CLOUD_FORMATIONfor Amazon Web Services CloudFormation stacks.
Result Syntax
[
'NextToken' => '<string>',
'ResourceCollection' => [
'CloudFormation' => [
'StackNames' => ['<string>', ...],
],
'Tags' => [
[
'AppBoundaryKey' => '<string>',
'TagValues' => ['<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 Amazon Web Services resource collections. 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.
Errors
-
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.
-
An internal failure in an Amazon service occurred.
-
A requested resource could not be found
-
The request was denied due to a request throttling.
-
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>',
'InsightId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'StartTimeRange' => [
'FromTime' => <integer || string || DateTime>,
'ToTime' => <integer || string || DateTime>,
],
]);
Parameter Details
Members
- AccountId
-
- Type: string
The ID of the Amazon Web Services account.
- 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
nextTokenvalue. - 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' => [
[
'AnomalyReportedTimeRange' => [
'CloseTime' => <DateTime>,
'OpenTime' => <DateTime>,
],
'AnomalyResources' => [
[
'Name' => '<string>',
'Type' => '<string>',
],
// ...
],
'AnomalyTimeRange' => [
'EndTime' => <DateTime>,
'StartTime' => <DateTime>,
],
'AssociatedInsightId' => '<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
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
ProactiveAnomalySummaryobjects that represent the requested anomalies - ReactiveAnomalies
-
- Type: Array of ReactiveAnomalySummary structures
An array of
ReactiveAnomalySummaryobjects that represent the requested anomalies
Errors
-
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.
-
An internal failure in an Amazon service occurred.
-
A requested resource could not be found
-
The request was denied due to a request throttling.
-
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
Members
- AccountId
-
- Type: string
The ID of the Amazon Web Services account.
- Filters
-
- Required: Yes
- Type: ListEventsFilters structure
A
ListEventsFiltersobject 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
nextTokenvalue. - 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>', ...],
],
'Tags' => [
[
'AppBoundaryKey' => '<string>',
'TagValues' => ['<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
-
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.
-
An internal failure in an Amazon service occurred.
-
A requested resource could not be found
-
The request was denied due to a request throttling.
-
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
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
nextTokenvalue. - 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' => [
[
'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
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
-
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.
-
An internal failure in an Amazon service occurred.
-
The request was denied due to a request throttling.
-
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
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
-
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.
-
An internal failure in an Amazon service occurred.
-
The request was denied due to a request throttling.
-
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
Members
- AccountIds
-
- Type: Array of strings
The ID of the Amazon Web Services account.
- 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
nextTokenvalue. - 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.
- OrganizationalUnitIds
-
- Type: Array of strings
The ID of the organizational unit.
- StatusFilter
-
- Required: Yes
- Type: ListInsightsStatusFilter structure
A filter used by
ListInsightsto specify which insights to return.
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
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 ProactiveOrganizationInsightSummary structures
An integer that specifies the number of open proactive insights in your Amazon Web Services account.
- ReactiveInsights
-
- Type: Array of ReactiveOrganizationInsightSummary structures
An integer that specifies the number of open reactive insights in your Amazon Web Services account.
Errors
-
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.
-
An internal failure in an Amazon service occurred.
-
The request was denied due to a request throttling.
-
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
Members
- AccountId
-
- Type: string
The ID of the Amazon Web Services account.
- InsightId
-
- Required: Yes
- Type: string
The ID of the requested insight.
- Locale
-
- Type: string
A locale that specifies the language to use for recommendations.
- 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' => [
[
'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
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
-
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.
-
An internal failure in an Amazon service occurred.
-
A requested resource could not be found
-
The request was denied due to a request throttling.
-
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
Errors
-
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.
-
An exception that is thrown when a conflict occurs.
-
An internal failure in an Amazon service occurred.
-
A requested resource could not be found
-
The request was denied due to a request throttling.
-
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
-
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.
-
An exception that is thrown when a conflict occurs.
-
An internal failure in an Amazon service occurred.
-
A requested resource could not be found
-
The request was denied due to a request throttling.
-
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, 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>', ...],
],
'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
Members
- Filters
-
- Type: SearchInsightsFilters structure
A
SearchInsightsFiltersobject 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
nextTokenvalue. - 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 (
REACTIVEorPROACTIVE).
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
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
-
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.
-
An internal failure in an Amazon service occurred.
-
The request was denied due to a request throttling.
-
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
Members
- AccountIds
-
- Required: Yes
- Type: Array of strings
The ID of the Amazon Web Services account.
- Filters
-
- Type: SearchOrganizationInsightsFilters structure
A
SearchOrganizationInsightsFiltersobject 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
nextTokenvalue. - 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
A time range used to specify when the behavior of an insight or anomaly started.
- Type
-
- Required: Yes
- Type: string
The type of insights you are searching for (
REACTIVEorPROACTIVE).
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
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
An integer that specifies the number of open proactive insights in your Amazon Web Services account.
- ReactiveInsights
-
- Type: Array of ReactiveInsightSummary structures
An integer that specifies the number of open reactive insights in your Amazon Web Services account.
Errors
-
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.
-
An internal failure in an Amazon service occurred.
-
The request was denied due to a request throttling.
-
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
Members
- ClientToken
-
- Type: string
The idempotency token used to identify each cost estimate request.
- ResourceCollection
-
- Required: Yes
- Type: CostEstimationResourceCollectionFilter structure
The collection of Amazon Web Services resources used to create a monthly DevOps Guru cost estimate.
Result Syntax
[]
Result Details
Errors
-
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.
-
An exception that is thrown when a conflict occurs.
-
An internal failure in an Amazon service occurred.
-
A requested resource could not be found
-
The request was denied due to a request throttling.
-
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
Members
- EventSources
-
- Type: EventSourcesConfig structure
Configuration information about the integration of DevOps Guru as the Consumer via EventBridge with another AWS Service.
Result Syntax
[]
Result Details
Errors
-
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.
-
An internal failure in an Amazon service occurred.
-
The request was denied due to a request throttling.
-
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
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 Amazon Web Services resources.
Result Syntax
[]
Result Details
Errors
-
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.
-
An exception that is thrown when a conflict occurs.
-
An internal failure in an Amazon service occurred.
-
The request was denied due to a request throttling.
-
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
'OpsCenter' => [
'OptInStatus' => 'ENABLED|DISABLED',
],
],
]);
Parameter Details
Members
- ServiceIntegration
-
- Required: Yes
- Type: UpdateServiceIntegrationConfig structure
An
IntegratedServiceConfigobject 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
Errors
-
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.
-
An exception that is thrown when a conflict occurs.
-
An internal failure in an Amazon service occurred.
-
The request was denied due to a request throttling.
-
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
AccountHealth
Description
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.
Members
- AccountId
-
- Type: string
The ID of the Amazon Web Services account.
- Insight
-
- Type: AccountInsightHealth structure
Information about the health of the Amazon Web Services resources in your account, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.
AccountInsightHealth
Description
Information about the number of open reactive and proactive insights that can be used to gauge the health of your system.
Members
AmazonCodeGuruProfilerIntegration
Description
Information about your account's integration with Amazon CodeGuru Profiler. This returns whether DevOps Guru is configured to consume recommendations generated from Amazon CodeGuru Profiler.
Members
AnomalyReportedTimeRange
Description
A time range that specifies when DevOps Guru opens and then closes an anomaly. This is different from AnomalyTimeRange, which specifies the time range when DevOps Guru actually observes the anomalous behavior.
Members
AnomalyResource
Description
The Amazon Web Services resources in which DevOps Guru detected unusual behavior that resulted in the generation of an anomaly. When DevOps Guru detects multiple related anomalies, it creates and insight with details about the anomalous behavior and suggestions about how to correct the problem.
Members
AnomalySourceDetails
Description
Details about the source of the anomalous operational data that triggered the anomaly.
Members
- CloudWatchMetrics
-
- Type: Array of CloudWatchMetricsDetail structures
An array of
CloudWatchMetricsDetailobjects that contain information about analyzed CloudWatch metrics that show anomalous behavior. - PerformanceInsightsMetrics
-
- Type: Array of PerformanceInsightsMetricsDetail structures
An array of
PerformanceInsightsMetricsDetailobjects that contain information about analyzed Performance Insights metrics that show anomalous behavior.
AnomalySourceMetadata
Description
Metadata about the detection source that generates proactive anomalies. The anomaly is detected using analysis of the metric data over a period of time
Members
AnomalyTimeRange
Description
A time range that specifies when the observed unusual behavior in an anomaly started and ended. This is different from AnomalyReportedTimeRange, which specifies the time range when DevOps Guru opens and then closes an anomaly.
Members
CloudFormationCollection
Description
Information about Amazon Web Services CloudFormation stacks. You can use up to 500 stacks to specify which Amazon Web Services resources in your account to analyze. For more information, see Stacks in the Amazon Web Services CloudFormation User Guide.
Members
CloudFormationCollectionFilter
Description
Information about Amazon Web Services CloudFormation stacks. You can use up to 500 stacks to specify which Amazon Web Services resources in your account to analyze. For more information, see Stacks in the Amazon Web Services CloudFormation User Guide.
Members
CloudFormationCostEstimationResourceCollectionFilter
Description
Information about an Amazon Web Services CloudFormation stack used to create a monthly cost estimate for DevOps Guru to analyze Amazon Web Services resources. The maximum number of stacks you can specify for a cost estimate is one. The estimate created is for the cost to analyze the Amazon Web Services resources defined by the stack. For more information, see Stacks in the Amazon Web Services CloudFormation User Guide.
Members
CloudFormationHealth
Description
Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services CloudFormation stack.
Members
- Insight
-
- Type: InsightHealth structure
Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services 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.
CloudWatchMetricsDataSummary
Description
Contains information about the analyzed metrics that displayed anomalous behavior.
Members
- StatusCode
-
- Type: string
This is an enum of the status showing whether the metric value pair list has partial or complete data, or if there was an error.
- TimestampMetricValuePairList
-
- Type: Array of TimestampMetricValuePair structures
This is a list of Amazon CloudWatch metric values at given timestamp.
CloudWatchMetricsDetail
Description
Information about an Amazon CloudWatch metric.
Members
- Dimensions
-
- Type: Array of CloudWatchMetricsDimension structures
An array of CloudWatch dimensions associated with
- MetricDataSummary
-
- Type: CloudWatchMetricsDataSummary structure
This object returns anomaly metric data.
- 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, andPercent.
CloudWatchMetricsDimension
Description
The dimension of am 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
ConflictException
Description
An exception that is thrown when a conflict occurs.
Members
CostEstimationResourceCollectionFilter
Description
Information about a filter used to specify which Amazon Web Services resources are analyzed to create a monthly DevOps Guru cost estimate. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.
Members
- CloudFormation
-
- Type: CloudFormationCostEstimationResourceCollectionFilter structure
An object that specifies the CloudFormation stack that defines the Amazon Web Services resources used to create a monthly estimate for DevOps Guru.
- Tags
-
- Type: Array of TagCostEstimationResourceCollectionFilter structures
The Amazon Web Services tags used to filter the resource collection that is used for a cost estimate.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
-
A tag key (for example,
CostCenter,Environment,Project, orSecret). Tag keys are case-sensitive. -
An optional field known as a tag value (for example,
111122223333,Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix
Devops-guru-. The tag key might beDevops-guru-deployment-applicationorDevops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key nameddevops-guru-rdsand a key namedDevOps-Guru-RDS. Possible key/value pairs in your application might beDevops-Guru-production-application/RDSorDevops-Guru-production-application/containers.
CostEstimationTimeRange
Description
The time range of a cost estimation.
Members
EndTimeRange
Description
A range of time that specifies when anomalous behavior in an anomaly or insight ended.
Members
Event
Description
An Amazon Web Services resource event. Amazon Web Services 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_TRAILorAWS_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 Amazon Web Services 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 Amazon Web Services resources supported by DevOps Guru. 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.
- Resources
-
- Type: Array of EventResource structures
An
EventResourceobject that contains information about the resource that emitted the event. - Time
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A
Timestampthat specifies the time the event occurred.
EventResource
Description
The Amazon Web Services resource that emitted an event. Amazon Web Services resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.
Members
EventSourcesConfig
Description
Information about the integration of DevOps Guru as consumer with another AWS service, such as AWS CodeGuru Profiler via EventBridge.
Members
- AmazonCodeGuruProfiler
-
- Type: AmazonCodeGuruProfilerIntegration structure
Information about whether DevOps Guru is configured to consume recommendations which are generated from AWS CodeGuru Profiler.
EventTimeRange
Description
The time range during which an Amazon Web Services event occurred. Amazon Web Services resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.
Members
InsightFeedback
Description
Information about insight feedback received from a customer.
Members
InsightHealth
Description
Information about the number of open reactive and proactive insights that can be used to gauge the health of your system.
Members
InsightTimeRange
Description
A time ranged that specifies when the observed behavior in an insight started and ended.
Members
InternalServerException
Description
An internal failure in an Amazon service occurred.
Members
ListEventsFilters
Description
Filters you can use to specify which events are returned when ListEvents is called.
Members
- DataSource
-
- Type: string
The source,
AWS_CLOUD_TRAILorAWS_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 Amazon Web Services 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
A collection of Amazon Web Services resources supported by DevOps Guru. 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.
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
REACTIVEorPROACTIVEinsights.
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
REACTIVEorPROACTIVEinsights.
ListInsightsOngoingStatusFilter
Description
Used to filter for insights that have the status ONGOING.
Members
ListInsightsStatusFilter
Description
A filter used by ListInsights to specify which insights to return.
Members
- Any
-
- Type: ListInsightsAnyStatusFilter structure
A
ListInsightsAnyStatusFilterthat specifies insights of any status that are eitherREACTIVEorPROACTIVE. - Closed
-
- Type: ListInsightsClosedStatusFilter structure
A
ListInsightsClosedStatusFilterthat specifies closed insights that are eitherREACTIVEorPROACTIVE. - Ongoing
-
- Type: ListInsightsOngoingStatusFilter structure
A
ListInsightsAnyStatusFilterthat specifies ongoing insights that are eitherREACTIVEorPROACTIVE.
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).
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. DevOps Guru only supports standard SNS topics. For more information, see Permissions for cross account Amazon SNS topics.
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 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.
Members
- Config
-
- Type: NotificationChannelConfig structure
A
NotificationChannelConfigobject 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.
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. DevOps Guru only supports standard SNS topics. For more information, see Permissions for cross account Amazon SNS topics.
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 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.
OpsCenterIntegration
Description
Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager OpsCenter for each created insight.
Members
OpsCenterIntegrationConfig
Description
Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager OpsCenter for each created insight.
Members
PerformanceInsightsMetricDimensionGroup
Description
A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql dimension group consists of the following dimensions: db.sql.id, db.sql.db_id, db.sql.statement, and db.sql.tokenized_id.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
-
To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
-
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.
Members
- Dimensions
-
- Type: Array of strings
A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested or are present in the response.
Valid values for elements in the
Dimensionsarray are:-
db.application.name- The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL) -
db.host.id- The host ID of the connected client (all engines) -
db.host.name- The host name of the connected client (all engines) -
db.name- The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB) -
db.session_type.name- The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL) -
db.sql.id- The SQL ID generated by Performance Insights (all engines) -
db.sql.db_id- The SQL ID generated by the database (all engines) -
db.sql.statement- The SQL text that is being executed (all engines) -
db.sql.tokenized_id -
db.sql_tokenized.id- The SQL digest ID generated by Performance Insights (all engines) -
db.sql_tokenized.db_id- SQL digest ID generated by the database (all engines) -
db.sql_tokenized.statement- The SQL digest text (all engines) -
db.user.id- The ID of the user logged in to the database (all engines) -
db.user.name- The name of the user logged in to the database (all engines) -
db.wait_event.name- The event for which the backend is waiting (all engines) -
db.wait_event.type- The type of event for which the backend is waiting (all engines) -
db.wait_event_type.name- The name of the event type for which the backend is waiting (all engines)
- Group
-
- Type: string
The name of the dimension group. Its valid values are:
-
db- The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB) -
db.application- The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL) -
db.host- The host name of the connected client (all engines) -
db.session_type- The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL) -
db.sql- The SQL that is currently executing (all engines) -
db.sql_tokenized- The SQL digest (all engines) -
db.wait_event- The event for which the database backend is waiting (all engines) -
db.wait_event_type- The type of event for which the database backend is waiting (all engines) -
db.user- The user logged in to the database (all engines)
- Limit
-
- Type: int
The maximum number of items to fetch for this dimension group.
PerformanceInsightsMetricQuery
Description
A single query to be processed. Use these parameters to query the Performance Insights GetResourceMetrics API to retrieve the metrics for an anomaly. For more information, see GetResourceMetrics in the Amazon RDS Performance Insights API Reference.
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
-
To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
-
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.
Members
- Filter
-
- Type: Associative array of custom strings keys (PerformanceInsightsMetricFilterKey) to strings
One or more filters to apply to a Performance Insights
GetResourceMetricsAPI query. Restrictions:-
Any number of filters by the same dimension, as specified in the
GroupByparameter. -
A single filter for any other dimension in this dimension group.
- GroupBy
-
- Type: PerformanceInsightsMetricDimensionGroup structure
The specification for how to aggregate the data points from a Performance Insights
GetResourceMetricsAPI query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension. - Metric
-
- Type: string
The name of the meteric used used when querying an Performance Insights
GetResourceMetricsAPI for anomaly metrics.Valid values for
Metricare:-
db.load.avg- a scaled representation of the number of active sessions for the database engine. -
db.sampledload.avg- the raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold,
db.load.avganddb.sampledload.avgare the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, withdb.load.avgshowing the scaled values,db.sampledload.avgshowing the raw values, anddb.sampledload.avgless thandb.load.avg. For most use cases, you can querydb.load.avgonly.
PerformanceInsightsMetricsDetail
Description
Details about Performance Insights metrics.
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
-
To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
-
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.
Members
- MetricDisplayName
-
- Type: string
The name used for a specific Performance Insights metric.
- MetricQuery
-
- Type: PerformanceInsightsMetricQuery structure
A single query to be processed for the metric. For more information, see
PerformanceInsightsMetricQuery. - ReferenceData
-
- Type: Array of PerformanceInsightsReferenceData structures
For more information, see
PerformanceInsightsReferenceData. - StatsAtAnomaly
-
- Type: Array of PerformanceInsightsStat structures
The metric statistics during the anomalous period detected by DevOps Guru;
- StatsAtBaseline
-
- Type: Array of PerformanceInsightsStat structures
Typical metric statistics that are not considered anomalous. When DevOps Guru analyzes metrics, it compares them to
StatsAtBaselineto help determine if they are anomalous. - Unit
-
- Type: string
The unit of measure for a metric. For example, a session or a process.
PerformanceInsightsReferenceComparisonValues
Description
Reference scalar values and other metrics that DevOps Guru displays on a graph in its console along with the actual metrics it analyzed. Compare these reference values to your actual metrics to help you understand anomalous behavior that DevOps Guru detected.
Members
- ReferenceMetric
-
- Type: PerformanceInsightsReferenceMetric structure
A metric that DevOps Guru compares to actual metric values. This reference metric is used to determine if an actual metric should be considered anomalous.
- ReferenceScalar
-
- Type: PerformanceInsightsReferenceScalar structure
A scalar value DevOps Guru for a metric that DevOps Guru compares to actual metric values. This reference value is used to determine if an actual metric value should be considered anomalous.
PerformanceInsightsReferenceData
Description
Reference data used to evaluate Performance Insights to determine if its performance is anomalous or not.
Members
- ComparisonValues
-
- Type: PerformanceInsightsReferenceComparisonValues structure
The specific reference values used to evaluate the Performance Insights. For more information, see
PerformanceInsightsReferenceComparisonValues. - Name
-
- Type: string
The name of the reference data.
PerformanceInsightsReferenceMetric
Description
Information about a reference metric used to evaluate Performance Insights.
Members
- MetricQuery
-
- Type: PerformanceInsightsMetricQuery structure
A query to be processed on the metric.
PerformanceInsightsReferenceScalar
Description
A reference value to compare Performance Insights metrics against to determine if the metrics demonstrate anomalous behavior.
Members
PerformanceInsightsStat
Description
A statistic in a Performance Insights collection.
Members
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
- AnomalyReportedTimeRange
-
- Type: AnomalyReportedTimeRange structure
An
AnomalyReportedTimeRangeobject that specifies the time range between when the anomaly is opened and the time when it is closed. - AnomalyResources
-
- Type: Array of AnomalyResource structures
Information about a resource in which DevOps Guru detected anomalous behavior.
- AnomalyTimeRange
-
- Type: AnomalyTimeRange structure
A time range that specifies when the observed unusual behavior in an anomaly started and ended. This is different from
AnomalyReportedTimeRange, which specifies the time range when DevOps Guru opens and then closes an anomaly. - 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
A collection of Amazon Web Services resources supported by DevOps Guru. 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.
- Severity
-
- Type: string
The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
- 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.
- SourceMetadata
-
- Type: AnomalySourceMetadata structure
The metadata for the anomaly.
- 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
- AnomalyReportedTimeRange
-
- Type: AnomalyReportedTimeRange structure
An
AnomalyReportedTimeRangeobject that specifies the time range between when the anomaly is opened and the time when it is closed. - AnomalyResources
-
- Type: Array of AnomalyResource structures
Information about a resource in which DevOps Guru detected anomalous behavior.
- AnomalyTimeRange
-
- Type: AnomalyTimeRange structure
A time range that specifies when the observed unusual behavior in an anomaly started and ended. This is different from
AnomalyReportedTimeRange, which specifies the time range when DevOps Guru opens and then closes an anomaly. - 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
A collection of Amazon Web Services resources supported by DevOps Guru. 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.
- Severity
-
- Type: string
The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
- 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.
- SourceMetadata
-
- Type: AnomalySourceMetadata structure
The metadata of the source which detects proactive anomalies.
- 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
- Description
-
- Type: string
Describes the proactive insight.
- 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
A collection of Amazon Web Services resources supported by DevOps Guru. 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.
- Severity
-
- Type: string
The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
- SsmOpsItemId
-
- Type: string
The ID of the Amazon Web Services 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
- AssociatedResourceArns
-
- Type: Array of strings
The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.
- 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
A collection of Amazon Web Services resources supported by DevOps Guru. 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.
- ServiceCollection
-
- Type: ServiceCollection structure
A collection of the names of Amazon Web Services services.
- Severity
-
- Type: string
The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
- Status
-
- Type: string
The status of the proactive insight.
ProactiveOrganizationInsightSummary
Description
Details about a proactive insight. This object is returned by DescribeInsight.
Members
- AccountId
-
- Type: string
The ID of the Amazon Web Services account.
- Id
-
- Type: string
The ID of the insight 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 the insight summary.
- OrganizationalUnitId
-
- Type: string
The ID of the organizational unit.
- 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
A collection of Amazon Web Services resources supported by DevOps Guru. 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.
- ServiceCollection
-
- Type: ServiceCollection structure
A collection of the names of Amazon Web Services services.
- Severity
-
- Type: string
An array of severity values used to search for insights. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
- Status
-
- Type: string
An array of status values used to search for insights.
ReactiveAnomaly
Description
Details about a reactive anomaly. This object is returned by ListAnomalies.
Members
- AnomalyReportedTimeRange
-
- Type: AnomalyReportedTimeRange structure
An
AnomalyReportedTimeRangeobject that specifies the time range between when the anomaly is opened and the time when it is closed. - AnomalyResources
-
- Type: Array of AnomalyResource structures
The Amazon Web Services resources in which anomalous behavior was detected by DevOps Guru.
- AnomalyTimeRange
-
- Type: AnomalyTimeRange structure
A time range that specifies when the observed unusual behavior in an anomaly started and ended. This is different from
AnomalyReportedTimeRange, which specifies the time range when DevOps Guru opens and then closes an anomaly. - AssociatedInsightId
-
- Type: string
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
- CausalAnomalyId
-
- Type: string
The ID of the causal anomaly that is associated with this reactive anomaly. The ID of a `CAUSAL` anomaly is always `NULL`.
- Description
-
- Type: string
A description of the reactive anomaly.
- Id
-
- Type: string
The ID of the reactive anomaly.
- Name
-
- Type: string
The name of the reactive anomaly.
- ResourceCollection
-
- Type: ResourceCollection structure
A collection of Amazon Web Services resources supported by DevOps Guru. 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.
- Severity
-
- Type: string
The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
- 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.
- Type
-
- Type: string
The type of the reactive anomaly. It can be one of the following types.
-
CAUSAL- the anomaly can cause a new insight. -
CONTEXTUAL- the anomaly contains additional information about an insight or its causal anomaly.
ReactiveAnomalySummary
Description
Details about a reactive anomaly. This object is returned by DescribeAnomaly.
Members
- AnomalyReportedTimeRange
-
- Type: AnomalyReportedTimeRange structure
An
AnomalyReportedTimeRangeobject that specifies the time range between when the anomaly is opened and the time when it is closed. - AnomalyResources
-
- Type: Array of AnomalyResource structures
The Amazon Web Services resources in which anomalous behavior was detected by DevOps Guru.
- AnomalyTimeRange
-
- Type: AnomalyTimeRange structure
A time range that specifies when the observed unusual behavior in an anomaly started and ended. This is different from
AnomalyReportedTimeRange, which specifies the time range when DevOps Guru opens and then closes an anomaly. - AssociatedInsightId
-
- Type: string
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
- CausalAnomalyId
-
- Type: string
The ID of the causal anomaly that is associated with this reactive anomaly. The ID of a `CAUSAL` anomaly is always `NULL`.
- Description
-
- Type: string
A description of the reactive anomaly.
- Id
-
- Type: string
The ID of the reactive anomaly.
- Name
-
- Type: string
The name of the reactive anomaly.
- ResourceCollection
-
- Type: ResourceCollection structure
A collection of Amazon Web Services resources supported by DevOps Guru. 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.
- Severity
-
- Type: string
The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
- 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.
- Type
-
- Type: string
The type of the reactive anomaly. It can be one of the following types.
-
CAUSAL- the anomaly can cause a new insight. -
CONTEXTUAL- the anomaly contains additional information about an insight or its causal anomaly.
ReactiveInsight
Description
Information about a reactive insight. This object is returned by ListInsights.
Members
- Description
-
- Type: string
Describes the reactive insight.
- 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
A collection of Amazon Web Services resources supported by DevOps Guru. 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.
- Severity
-
- Type: string
The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
- SsmOpsItemId
-
- Type: string
The ID of the Amazon Web Services 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
- AssociatedResourceArns
-
- Type: Array of strings
The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.
- 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
A collection of Amazon Web Services resources supported by DevOps Guru. 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.
- ServiceCollection
-
- Type: ServiceCollection structure
A collection of the names of Amazon Web Services services.
- Severity
-
- Type: string
The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
- Status
-
- Type: string
The status of a reactive insight.
ReactiveOrganizationInsightSummary
Description
Information about a reactive insight. This object is returned by DescribeInsight.
Members
- AccountId
-
- Type: string
The ID of the Amazon Web Services account.
- Id
-
- Type: string
The ID of the insight 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 the insight summary.
- OrganizationalUnitId
-
- Type: string
The ID of the organizational unit.
- ResourceCollection
-
- Type: ResourceCollection structure
A collection of Amazon Web Services resources supported by DevOps Guru. 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.
- ServiceCollection
-
- Type: ServiceCollection structure
A collection of the names of Amazon Web Services services.
- Severity
-
- Type: string
An array of severity values used to search for insights. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
- Status
-
- Type: string
An array of status values used to search for insights.
Recommendation
Description
Recommendation information to help you remediate detected anomalous behavior that generated an insight.
Members
- Category
-
- Type: string
The category type of the recommendation.
- 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
- AnomalyId
-
- Type: string
The ID of an anomaly that generated the insight with this recommendation.
- 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. Resource types take the same form that is used by Amazon Web Services CloudFormation resource type identifiers,
service-provider::service-name::data-type-name. For example,AWS::RDS::DBCluster. For more information, see Amazon Web Services resource and property types reference in the Amazon Web Services CloudFormation User Guide.
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
CloudWatchMetricsDetailobjects 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
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
Namefield in anEventobject. - Resources
-
- Type: Array of RecommendationRelatedEventResource structures
A
ResourceCollectionobject that contains arrays of the names of Amazon Web Services CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
RecommendationRelatedEventResource
Description
Information about an Amazon Web Services resource that emitted and event that is related to a recommendation in an insight.
Members
ResourceCollection
Description
A collection of Amazon Web Services resources supported by DevOps Guru. 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.
Members
- CloudFormation
-
- Type: CloudFormationCollection structure
An array of the names of Amazon Web Services CloudFormation stacks. The stacks define Amazon Web Services resources that DevOps Guru analyzes. You can specify up to 500 Amazon Web Services CloudFormation stacks.
- Tags
-
- Type: Array of TagCollection structures
The Amazon Web Services tags that are used by resources in the resource collection.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
-
A tag key (for example,
CostCenter,Environment,Project, orSecret). Tag keys are case-sensitive. -
An optional field known as a tag value (for example,
111122223333,Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix
Devops-guru-. The tag key might beDevops-guru-deployment-applicationorDevops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key nameddevops-guru-rdsand a key namedDevOps-Guru-RDS. Possible key/value pairs in your application might beDevops-Guru-production-application/RDSorDevops-Guru-production-application/containers.
ResourceCollectionFilter
Description
Information about a filter used to specify which Amazon Web Services resources are analyzed for anomalous behavior by DevOps Guru.
Members
- CloudFormation
-
- Type: CloudFormationCollectionFilter structure
Information about Amazon Web Services CloudFormation stacks. You can use up to 500 stacks to specify which Amazon Web Services resources in your account to analyze. For more information, see Stacks in the Amazon Web Services CloudFormation User Guide.
- Tags
-
- Type: Array of TagCollectionFilter structures
The Amazon Web Services tags used to filter the resources in the resource collection.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
-
A tag key (for example,
CostCenter,Environment,Project, orSecret). Tag keys are case-sensitive. -
An optional field known as a tag value (for example,
111122223333,Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix
Devops-guru-. The tag key might beDevops-guru-deployment-applicationorDevops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key nameddevops-guru-rdsand a key namedDevOps-Guru-RDS. Possible key/value pairs in your application might beDevops-Guru-production-application/RDSorDevops-Guru-production-application/containers.
ResourceNotFoundException
Description
A requested resource could not be found
Members
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
A collection of Amazon Web Services resources supported by DevOps Guru. 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.
- ServiceCollection
-
- Type: ServiceCollection structure
A collection of the names of Amazon Web Services services.
- 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.
SearchOrganizationInsightsFilters
Description
Filters you can use to specify which events are returned when ListEvents is called.
Members
- ResourceCollection
-
- Type: ResourceCollection structure
A collection of Amazon Web Services resources supported by DevOps Guru. 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.
- ServiceCollection
-
- Type: ServiceCollection structure
A collection of the names of Amazon Web Services services.
- 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.
ServiceCollection
Description
A collection of the names of Amazon Web Services services.
Members
ServiceHealth
Description
Represents the health of an Amazon Web Services service.
Members
- Insight
-
- Type: ServiceInsightHealth structure
Represents the health of an Amazon Web Services service. This is a
ServiceInsightHealththat contains the number of open proactive and reactive insights for this service. - ServiceName
-
- Type: string
The name of the Amazon Web Services service.
ServiceInsightHealth
Description
Contains the number of open proactive and reactive insights in an analyzed Amazon Web Services service.
Members
ServiceIntegrationConfig
Description
Information about the integration of DevOps Guru with another Amazon Web Services service, such as Amazon Web Services Systems Manager.
Members
- OpsCenter
-
- Type: OpsCenterIntegration structure
Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager OpsCenter for each created insight.
ServiceQuotaExceededException
ServiceResourceCost
Description
An object that contains information about the estimated monthly cost to analyze an Amazon Web Services resource. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.
Members
- Cost
-
- Type: double
The total estimated monthly cost to analyze the active resources for this resource.
- Count
-
- Type: int
The number of active resources analyzed for this service to create a monthly cost estimate.
- State
-
- Type: string
The state of the resource. The resource is
ACTIVEif it produces metrics, events, or logs within an hour, otherwise it isINACTIVE. You pay for the number of active Amazon Web Services resource hours analyzed for each resource. Inactive resources are not charged. - Type
-
- Type: string
The type of the Amazon Web Services resource.
- UnitCost
-
- Type: double
The price per hour to analyze the resources in the service. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.
SnsChannelConfig
Description
Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.
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. DevOps Guru only supports standard SNS topics. For more information, see Permissions for cross account Amazon SNS topics.
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 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.
Members
StartTimeRange
Description
A time range used to specify when the behavior of an insight or anomaly started.
Members
TagCollection
Description
A collection of Amazon Web Services stags.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
-
A tag key (for example,
CostCenter,Environment,Project, orSecret). Tag keys are case-sensitive. -
An optional field known as a tag value (for example,
111122223333,Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be Devops-guru-deployment-application or Devops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
Members
- AppBoundaryKey
-
- Required: Yes
- Type: string
An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix
Devops-guru-. The tag key might beDevops-guru-deployment-applicationorDevops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key nameddevops-guru-rdsand a key namedDevOps-Guru-RDS. Possible key/value pairs in your application might beDevops-Guru-production-application/RDSorDevops-Guru-production-application/containers. - TagValues
-
- Required: Yes
- Type: Array of strings
The values in an Amazon Web Services tag collection.
The tag's value is an optional field used to associate a string with the tag key (for example,
111122223333,Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.
TagCollectionFilter
Description
A collection of Amazon Web Services tags used to filter insights. This is used to return insights generated from only resources that contain the tags in the tag collection.
Members
- AppBoundaryKey
-
- Required: Yes
- Type: string
An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix
Devops-guru-. The tag key might beDevops-guru-deployment-applicationorDevops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key nameddevops-guru-rdsand a key namedDevOps-Guru-RDS. Possible key/value pairs in your application might beDevops-Guru-production-application/RDSorDevops-Guru-production-application/containers. - TagValues
-
- Required: Yes
- Type: Array of strings
The values in an Amazon Web Services tag collection.
The tag's value is an optional field used to associate a string with the tag key (for example,
111122223333,Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.
TagCostEstimationResourceCollectionFilter
Description
Information about a collection of Amazon Web Services resources that are identified by an Amazon Web Services tag. This collection of resources is used to create a monthly cost estimate for DevOps Guru to analyze Amazon Web Services resources. The maximum number of tags you can specify for a cost estimate is one. The estimate created is for the cost to analyze the Amazon Web Services resources defined by the tag. For more information, see Stacks in the Amazon Web Services CloudFormation User Guide.
Members
- AppBoundaryKey
-
- Required: Yes
- Type: string
An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix
Devops-guru-. The tag key might beDevops-guru-deployment-applicationorDevops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key nameddevops-guru-rdsand a key namedDevOps-Guru-RDS. Possible key/value pairs in your application might beDevops-Guru-production-application/RDSorDevops-Guru-production-application/containers. - TagValues
-
- Required: Yes
- Type: Array of strings
The values in an Amazon Web Services tag collection.
The tag's value is an optional field used to associate a string with the tag key (for example,
111122223333,Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.
TagHealth
Description
Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services tag key.
Members
- AppBoundaryKey
-
- Type: string
An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix
Devops-guru-. The tag key might beDevops-guru-deployment-applicationorDevops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key nameddevops-guru-rdsand a key namedDevOps-Guru-RDS. Possible key/value pairs in your application might beDevops-Guru-production-application/RDSorDevops-Guru-production-application/containers. - Insight
-
- Type: InsightHealth structure
Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services tag, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.
- TagValue
-
- Type: string
The value in an Amazon Web Services tag.
The tag's value is an optional field used to associate a string with the tag key (for example,
111122223333,Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.
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.
TimestampMetricValuePair
Description
A pair that contains metric values at the respective timestamp.
Members
UpdateCloudFormationCollectionFilter
Description
Contains the names of Amazon Web Services CloudFormation stacks used to update a collection of stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
Members
UpdateResourceCollectionFilter
Description
Contains information used to update a collection of Amazon Web Services resources.
Members
- CloudFormation
-
- Type: UpdateCloudFormationCollectionFilter structure
A collection of Amazon Web Services CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
- Tags
-
- Type: Array of UpdateTagCollectionFilter structures
The updated Amazon Web Services tags used to filter the resources in the resource collection.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
-
A tag key (for example,
CostCenter,Environment,Project, orSecret). Tag keys are case-sensitive. -
An optional field known as a tag value (for example,
111122223333,Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix
Devops-guru-. The tag key might beDevops-guru-deployment-applicationorDevops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key nameddevops-guru-rdsand a key namedDevOps-Guru-RDS. Possible key/value pairs in your application might beDevops-Guru-production-application/RDSorDevops-Guru-production-application/containers.
UpdateServiceIntegrationConfig
Description
Information about updating the integration status of an Amazon Web Services service, such as Amazon Web Services Systems Manager, with DevOps Guru.
Members
- OpsCenter
-
- Type: OpsCenterIntegrationConfig structure
Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager OpsCenter for each created insight.
UpdateTagCollectionFilter
Description
A new collection of Amazon Web Services resources that are defined by an Amazon Web Services tag or tag key/value pair.
Members
- AppBoundaryKey
-
- Required: Yes
- Type: string
An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix
Devops-guru-. The tag key might beDevops-guru-deployment-applicationorDevops-guru-rds-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key nameddevops-guru-rdsand a key namedDevOps-Guru-RDS. Possible key/value pairs in your application might beDevops-Guru-production-application/RDSorDevops-Guru-production-application/containers. - TagValues
-
- Required: Yes
- Type: Array of strings
The values in an Amazon Web Services tag collection.
The tag's value is an optional field used to associate a string with the tag key (for example,
111122223333,Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.
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.