2021/05/04 - Amazon DevOps Guru - 2 new5 updated api methods
Changes Added GetCostEstimation and StartCostEstimation to get the monthly resource usage cost and added ability to view resource health by AWS service name and to search insights be AWS service name.
Starts the creation of an estimate of the monthly cost to analyze your AWS resources.
See also: AWS API Documentation
Request Syntax
client.start_cost_estimation(
ResourceCollection={
'CloudFormation': {
'StackNames': [
'string',
]
}
},
ClientToken='string'
)
dict
[REQUIRED]
The collection of AWS resources used to create a monthly DevOps Guru cost estimate.
CloudFormation (dict) --
An object that specifies the CloudFormation stack that defines the AWS resources used to create a monthly estimate for DevOps Guru.
StackNames (list) --
An array of CloudFormation stack names. Its size is fixed at 1 item.
(string) --
string
The idempotency token used to identify each cost estimate request.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns an estimate of the monthly cost for DevOps Guru to analyze your AWS resources. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.
See also: AWS API Documentation
Request Syntax
client.get_cost_estimation(
NextToken='string'
)
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.
dict
Response Syntax
{
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'Status': 'ONGOING'|'COMPLETED',
'Costs': [
{
'Type': 'string',
'State': 'ACTIVE'|'INACTIVE',
'Count': 123,
'UnitCost': 123.0,
'Cost': 123.0
},
],
'TimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'TotalCost': 123.0,
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceCollection (dict) --
The collection of the AWS resources used to create your monthly DevOps Guru cost estimate.
CloudFormation (dict) --
An object that specifies the CloudFormation stack that defines the AWS resources used to create a monthly estimate for DevOps Guru.
StackNames (list) --
An array of CloudFormation stack names. Its size is fixed at 1 item.
(string) --
Status (string) --
The status of creating this cost estimate. If it's still in progress, the status ONGOING is returned. If it is finished, the status COMPLETED is returned.
Costs (list) --
An array of ResourceCost objects that each contains details about the monthly cost estimate to analyze one of your AWS resources.
(dict) --
An object that contains information about the estimated monthly cost to analyze an AWS resource. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.
Type (string) --
The type of the AWS resource.
State (string) --
The state of the resource. The resource is ACTIVE if it produces metrics, events, or logs within an hour, otherwise it is INACTIVE. You pay for the number of active AWS resource hours analyzed for each resource. Inactive resources are not charged.
Count (integer) --
The number of active resources analyzed for this service to create a monthly cost estimate.
UnitCost (float) --
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.
Cost (float) --
The total estimated monthly cost to analyze the active resources for this resource.
TimeRange (dict) --
The start and end time of the cost estimation.
StartTime (datetime) --
The start time of the cost estimation.
EndTime (datetime) --
The end time of the cost estimation.
TotalCost (float) --
The estimated monthly cost to analyze the AWS resources. This value is the sum of the estimated costs to analyze each resource in the Costs object in this response.
NextToken (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.
{'ResourceCollectionType': {'AWS_SERVICE'}}
Response {'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'}]}
Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in resource collections in your account. You specify the type of AWS resources collection. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
See also: AWS API Documentation
Request Syntax
client.describe_resource_collection_health(
ResourceCollectionType='AWS_CLOUD_FORMATION'|'AWS_SERVICE',
NextToken='string'
)
string
[REQUIRED]
An AWS resource collection type. This type specifies how analyzed AWS resources are defined. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
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.
dict
Response Syntax
{
'CloudFormation': [
{
'StackName': 'string',
'Insight': {
'OpenProactiveInsights': 123,
'OpenReactiveInsights': 123,
'MeanTimeToRecoverInMilliseconds': 123
}
},
],
'Service': [
{
'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',
'Insight': {
'OpenProactiveInsights': 123,
'OpenReactiveInsights': 123
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CloudFormation (list) --
The returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with the requested system health information.
(dict) --
Information about the health of AWS resources in your account that are specified by an AWS CloudFormation stack.
StackName (string) --
The name of the CloudFormation stack.
Insight (dict) --
Information about the health of the AWS resources in your account that are specified by an AWS CloudFormation stack, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.
OpenProactiveInsights (integer) --
The number of open proactive insights.
OpenReactiveInsights (integer) --
The number of open reactive insights.
MeanTimeToRecoverInMilliseconds (integer) --
The Meant Time to Recover (MTTR) for the insight.
Service (list) --
An array of ServiceHealth objects that describes the health of the AWS services associated with the resources in the collection.
(dict) --
Represents the health of an AWS service.
ServiceName (string) --
The name of the AWS service.
Insight (dict) --
Represents the health of an AWS service. This is a ServiceInsightHealth that contains the number of open proactive and reactive insights for this service.
OpenProactiveInsights (integer) --
The number of open proactive insights in the AWS service
OpenReactiveInsights (integer) --
The number of open reactive insights in the AWS service
NextToken (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.
{'ResourceCollectionType': {'AWS_SERVICE'}}
Returns lists AWS resources that are of the specified resource collection type. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
See also: AWS API Documentation
Request Syntax
client.get_resource_collection(
ResourceCollectionType='AWS_CLOUD_FORMATION'|'AWS_SERVICE',
NextToken='string'
)
string
[REQUIRED]
The type of AWS resource collections to return. The one valid value is CLOUD_FORMATION for AWS CloudFormation stacks.
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.
dict
Response Syntax
{
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceCollection (dict) --
The requested list of AWS resource collections. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
CloudFormation (dict) --
Information about AWS CloudFormation stacks. You can use up to 500 stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
NextToken (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': {'ServiceCollection': {'ServiceNames': ['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']}},
'ReactiveInsights': {'ServiceCollection': {'ServiceNames': ['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']}}}
Returns a list of insights in your AWS account. You can specify which insights are returned by their start time and status ( ONGOING, CLOSED, or ANY).
See also: AWS API Documentation
Request Syntax
client.list_insights(
StatusFilter={
'Ongoing': {
'Type': 'REACTIVE'|'PROACTIVE'
},
'Closed': {
'Type': 'REACTIVE'|'PROACTIVE',
'EndTimeRange': {
'FromTime': datetime(2015, 1, 1),
'ToTime': datetime(2015, 1, 1)
}
},
'Any': {
'Type': 'REACTIVE'|'PROACTIVE',
'StartTimeRange': {
'FromTime': datetime(2015, 1, 1),
'ToTime': datetime(2015, 1, 1)
}
}
},
MaxResults=123,
NextToken='string'
)
dict
[REQUIRED]
A filter used to filter the returned insights by their status. You can specify one status filter.
Ongoing (dict) --
A ListInsightsAnyStatusFilter that specifies ongoing insights that are either REACTIVE or PROACTIVE.
Type (string) -- [REQUIRED]
Use to filter for either REACTIVE or PROACTIVE insights.
Closed (dict) --
A ListInsightsClosedStatusFilter that specifies closed insights that are either REACTIVE or PROACTIVE.
Type (string) -- [REQUIRED]
Use to filter for either REACTIVE or PROACTIVE insights.
EndTimeRange (dict) -- [REQUIRED]
A time range used to specify when the behavior of the filtered insights ended.
FromTime (datetime) --
The earliest end time in the time range.
ToTime (datetime) --
The latest end time in the time range.
Any (dict) --
A ListInsightsAnyStatusFilter that specifies insights of any status that are either REACTIVE or PROACTIVE.
Type (string) -- [REQUIRED]
Use to filter for either REACTIVE or PROACTIVE insights.
StartTimeRange (dict) -- [REQUIRED]
A time range used to specify when the behavior of the filtered insights started.
FromTime (datetime) --
The start time of the time range.
ToTime (datetime) --
The end time of the time range.
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
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.
dict
Response Syntax
{
'ProactiveInsights': [
{
'Id': 'string',
'Name': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'InsightTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'PredictionTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'ServiceCollection': {
'ServiceNames': [
'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',
]
}
},
],
'ReactiveInsights': [
{
'Id': 'string',
'Name': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'InsightTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'ServiceCollection': {
'ServiceNames': [
'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',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProactiveInsights (list) --
The returned list of proactive insights.
(dict) --
Details about a proactive insight. This object is returned by DescribeInsight.
Id (string) --
The ID of the proactive insight.
Name (string) --
The name of the proactive insight.
Severity (string) --
The severity of the proactive insight.
Status (string) --
The status of the proactive insight.
InsightTimeRange (dict) --
A time ranged that specifies when the observed behavior in an insight started and ended.
StartTime (datetime) --
The time when the behavior described in an insight started.
EndTime (datetime) --
The time when the behavior described in an insight ended.
PredictionTimeRange (dict) --
The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.
StartTime (datetime) --
The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.
EndTime (datetime) --
The time when the behavior in a proactive insight is expected to end.
ResourceCollection (dict) --
A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
CloudFormation (dict) --
An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
ServiceCollection (dict) --
A collection of the names of AWS services.
ServiceNames (list) --
An array of strings that each specifies the name of an AWS service.
(string) --
ReactiveInsights (list) --
The returned list of reactive insights.
(dict) --
Information about a reactive insight. This object is returned by DescribeInsight.
Id (string) --
The ID of a reactive summary.
Name (string) --
The name of a reactive insight.
Severity (string) --
The severity of a reactive insight.
Status (string) --
The status of a reactive insight.
InsightTimeRange (dict) --
A time ranged that specifies when the observed behavior in an insight started and ended.
StartTime (datetime) --
The time when the behavior described in an insight started.
EndTime (datetime) --
The time when the behavior described in an insight ended.
ResourceCollection (dict) --
A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
CloudFormation (dict) --
An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
ServiceCollection (dict) --
A collection of the names of AWS services.
ServiceNames (list) --
An array of strings that each specifies the name of an AWS service.
(string) --
NextToken (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.
{'Locale': 'DE_DE | EN_US | EN_GB | ES_ES | FR_FR | IT_IT | JA_JP | KO_KR | '
'PT_BR | ZH_CN | ZH_TW'}
Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.
See also: AWS API Documentation
Request Syntax
client.list_recommendations(
InsightId='string',
NextToken='string',
Locale='DE_DE'|'EN_US'|'EN_GB'|'ES_ES'|'FR_FR'|'IT_IT'|'JA_JP'|'KO_KR'|'PT_BR'|'ZH_CN'|'ZH_TW'
)
string
[REQUIRED]
The ID of the requested insight.
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.
string
A locale that specifies the language to use for recommendations.
dict
Response Syntax
{
'Recommendations': [
{
'Description': 'string',
'Link': 'string',
'Name': 'string',
'Reason': 'string',
'RelatedEvents': [
{
'Name': 'string',
'Resources': [
{
'Name': 'string',
'Type': 'string'
},
]
},
],
'RelatedAnomalies': [
{
'Resources': [
{
'Name': 'string',
'Type': 'string'
},
],
'SourceDetails': [
{
'CloudWatchMetrics': [
{
'MetricName': 'string',
'Namespace': 'string'
},
]
},
]
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Recommendations (list) --
An array of the requested recommendations.
(dict) --
Recommendation information to help you remediate detected anomalous behavior that generated an insight.
Description (string) --
A description of the problem.
Link (string) --
A hyperlink to information to help you address the problem.
Name (string) --
The name of the recommendation.
Reason (string) --
The reason DevOps Guru flagged the anomalous behavior as a problem.
RelatedEvents (list) --
Events that are related to the problem. Use these events to learn more about what's happening and to help address the issue.
(dict) --
Information about an event that is related to a recommendation.
Name (string) --
The name of the event. This corresponds to the Name field in an Event object.
Resources (list) --
A ResourceCollection object that contains arrays of the names of AWS CloudFormation stacks. You can specify up to 500 AWS CloudFormation stacks.
(dict) --
Information about an AWS resource that emitted and event that is related to a recommendation in an insight.
Name (string) --
The name of the resource that emitted the event. This corresponds to the Name field in an EventResource object.
Type (string) --
The type of the resource that emitted the event. This corresponds to the Type field in an EventResource object.
RelatedAnomalies (list) --
Anomalies that are related to the problem. Use these Anomalies to learn more about what's happening and to help address the issue.
(dict) --
Information about an anomaly that is related to a recommendation.
Resources (list) --
An array of objects that represent resources in which DevOps Guru detected anomalous behavior. Each object contains the name and type of the resource.
(dict) --
Information about a resource in which DevOps Guru detected anomalous behavior.
Name (string) --
The name of the resource.
Type (string) --
The type of the resource.
SourceDetails (list) --
Information about where the anomalous behavior related the recommendation was found. For example, details in Amazon CloudWatch metrics.
(dict) --
Contains an array of RecommendationRelatedCloudWatchMetricsSourceDetail objects that contain the name and namespace of an Amazon CloudWatch metric.
CloudWatchMetrics (list) --
An array of CloudWatchMetricsDetail objects that contains information about the analyzed metrics that displayed anomalous behavior.
(dict) --
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.
MetricName (string) --
The name of the CloudWatch metric.
Namespace (string) --
The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.
NextToken (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.
{'Filters': {'ServiceCollection': {'ServiceNames': ['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']}}}
Response {'ProactiveInsights': {'ServiceCollection': {'ServiceNames': ['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']}},
'ReactiveInsights': {'ServiceCollection': {'ServiceNames': ['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']}}}
Returns a list of insights in your AWS account. You can specify which insights are returned by their start time, one or more statuses ( ONGOING, CLOSED, and CLOSED), one or more severities ( LOW, MEDIUM, and HIGH), and type ( REACTIVE or PROACTIVE).
Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search.
See also: AWS API Documentation
Request Syntax
client.search_insights(
StartTimeRange={
'FromTime': datetime(2015, 1, 1),
'ToTime': datetime(2015, 1, 1)
},
Filters={
'Severities': [
'LOW'|'MEDIUM'|'HIGH',
],
'Statuses': [
'ONGOING'|'CLOSED',
],
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'ServiceCollection': {
'ServiceNames': [
'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',
]
}
},
MaxResults=123,
NextToken='string',
Type='REACTIVE'|'PROACTIVE'
)
dict
[REQUIRED]
The start of the time range passed in. Returned insights occurred after this time.
FromTime (datetime) --
The start time of the time range.
ToTime (datetime) --
The end time of the time range.
dict
A SearchInsightsFilters object that is used to set the severity and status filters on your insight search.
Severities (list) --
An array of severity values used to search for insights.
(string) --
Statuses (list) --
An array of status values used to search for insights.
(string) --
ResourceCollection (dict) --
A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
CloudFormation (dict) --
An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
ServiceCollection (dict) --
A collection of the names of AWS services.
ServiceNames (list) --
An array of strings that each specifies the name of an AWS service.
(string) --
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
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.
string
[REQUIRED]
The type of insights you are searching for ( REACTIVE or PROACTIVE).
dict
Response Syntax
{
'ProactiveInsights': [
{
'Id': 'string',
'Name': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'InsightTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'PredictionTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'ServiceCollection': {
'ServiceNames': [
'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',
]
}
},
],
'ReactiveInsights': [
{
'Id': 'string',
'Name': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'InsightTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'ServiceCollection': {
'ServiceNames': [
'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',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProactiveInsights (list) --
The returned proactive insights.
(dict) --
Details about a proactive insight. This object is returned by DescribeInsight.
Id (string) --
The ID of the proactive insight.
Name (string) --
The name of the proactive insight.
Severity (string) --
The severity of the proactive insight.
Status (string) --
The status of the proactive insight.
InsightTimeRange (dict) --
A time ranged that specifies when the observed behavior in an insight started and ended.
StartTime (datetime) --
The time when the behavior described in an insight started.
EndTime (datetime) --
The time when the behavior described in an insight ended.
PredictionTimeRange (dict) --
The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.
StartTime (datetime) --
The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.
EndTime (datetime) --
The time when the behavior in a proactive insight is expected to end.
ResourceCollection (dict) --
A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
CloudFormation (dict) --
An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
ServiceCollection (dict) --
A collection of the names of AWS services.
ServiceNames (list) --
An array of strings that each specifies the name of an AWS service.
(string) --
ReactiveInsights (list) --
The returned reactive insights.
(dict) --
Information about a reactive insight. This object is returned by DescribeInsight.
Id (string) --
The ID of a reactive summary.
Name (string) --
The name of a reactive insight.
Severity (string) --
The severity of a reactive insight.
Status (string) --
The status of a reactive insight.
InsightTimeRange (dict) --
A time ranged that specifies when the observed behavior in an insight started and ended.
StartTime (datetime) --
The time when the behavior described in an insight started.
EndTime (datetime) --
The time when the behavior described in an insight ended.
ResourceCollection (dict) --
A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
CloudFormation (dict) --
An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
ServiceCollection (dict) --
A collection of the names of AWS services.
ServiceNames (list) --
An array of strings that each specifies the name of an AWS service.
(string) --
NextToken (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.