2021/11/12 - Amazon DevOps Guru - 5 new 5 updated api methods
Changes Add support for cross account APIs.
Returns a list of insights associated with the account or OU Id.
See also: AWS API Documentation
Request Syntax
client.list_organization_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,
AccountIds=[
'string',
],
OrganizationalUnitIds=[
'string',
],
NextToken='string'
)
dict
[REQUIRED]
A filter used by ListInsights to specify which insights to return.
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.
list
The ID of the Amazon Web Services account.
(string) --
list
The ID of the organizational unit.
(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
{
'ProactiveInsights': [
{
'Id': 'string',
'AccountId': 'string',
'OrganizationalUnitId': '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',
'AccountId': 'string',
'OrganizationalUnitId': '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) --
An integer that specifies the number of open proactive insights in your Amazon Web Services account.
(dict) --
Details about a proactive insight. This object is returned by DescribeInsight .
Id (string) --
The ID of the insight summary.
AccountId (string) --
The ID of the Amazon Web Services account.
OrganizationalUnitId (string) --
The ID of the organizational unit.
Name (string) --
The name of the insight summary.
Severity (string) --
An array of severity values used to search for insights.
Status (string) --
An array of status values used to search for insights.
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 Amazon Web Services resources supported by DevOps Guru. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
ServiceCollection (dict) --
A collection of the names of Amazon Web Services services.
ServiceNames (list) --
An array of strings that each specifies the name of an Amazon Web Services service.
(string) --
ReactiveInsights (list) --
An integer that specifies the number of open reactive insights in your Amazon Web Services account.
(dict) --
Information about a reactive insight. This object is returned by DescribeInsight .
Id (string) --
The ID of the insight summary.
AccountId (string) --
The ID of the Amazon Web Services account.
OrganizationalUnitId (string) --
The ID of the organizational unit.
Name (string) --
The name of the insight summary.
Severity (string) --
An array of severity values used to search for insights.
Status (string) --
An array of status values used to search for insights.
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 Amazon Web Services resources supported by DevOps Guru. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
ServiceCollection (dict) --
A collection of the names of Amazon Web Services services.
ServiceNames (list) --
An array of strings that each specifies the name of an Amazon Web Services 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.
Returns an overview of your organization's history based on the specified time range. The overview includes the total reactive and proactive insights.
See also: AWS API Documentation
Request Syntax
client.describe_organization_overview(
FromTime=datetime(2015, 1, 1),
ToTime=datetime(2015, 1, 1),
AccountIds=[
'string',
],
OrganizationalUnitIds=[
'string',
]
)
datetime
[REQUIRED]
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.
datetime
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.
list
The ID of the Amazon Web Services account.
(string) --
list
The ID of the organizational unit.
(string) --
dict
Response Syntax
{
'ReactiveInsights': 123,
'ProactiveInsights': 123
}
Response Structure
(dict) --
ReactiveInsights (integer) --
An integer that specifies the number of open reactive insights in your Amazon Web Services account.
ProactiveInsights (integer) --
An integer that specifies the number of open proactive insights in your Amazon Web Services account.
Returns active insights, predictive insights, and resource hours analyzed in last hour.
See also: AWS API Documentation
Request Syntax
client.describe_organization_health(
AccountIds=[
'string',
],
OrganizationalUnitIds=[
'string',
]
)
list
The ID of the Amazon Web Services account.
(string) --
list
The ID of the organizational unit.
(string) --
dict
Response Syntax
{
'OpenReactiveInsights': 123,
'OpenProactiveInsights': 123,
'MetricsAnalyzed': 123,
'ResourceHours': 123
}
Response Structure
(dict) --
OpenReactiveInsights (integer) --
An integer that specifies the number of open reactive insights in your Amazon Web Services account.
OpenProactiveInsights (integer) --
An integer that specifies the number of open proactive insights in your Amazon Web Services account.
MetricsAnalyzed (integer) --
An integer that specifies the number of metrics that have been analyzed in your organization.
ResourceHours (integer) --
The number of Amazon DevOps Guru resource analysis hours billed to the current Amazon Web Services account in the last hour.
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.
See also: AWS API Documentation
Request Syntax
client.search_organization_insights(
AccountIds=[
'string',
],
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'
)
list
[REQUIRED]
The ID of the Amazon Web Services account.
(string) --
dict
[REQUIRED]
A time range used to specify when the behavior of an insight or anomaly started.
FromTime (datetime) --
The start time of the time range.
ToTime (datetime) --
The end time of the time range.
dict
A SearchOrganizationInsightsFilters 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 Amazon Web Services resources supported by DevOps Guru. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
ServiceCollection (dict) --
A collection of the names of Amazon Web Services services.
ServiceNames (list) --
An array of strings that each specifies the name of an Amazon Web Services 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) --
An integer that specifies the number of open proactive insights in your Amazon Web Services account.
(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 Amazon Web Services resources supported by DevOps Guru. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
ServiceCollection (dict) --
A collection of the names of Amazon Web Services services.
ServiceNames (list) --
An array of strings that each specifies the name of an Amazon Web Services service.
(string) --
ReactiveInsights (list) --
An integer that specifies the number of open reactive insights in your Amazon Web Services account.
(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 Amazon Web Services resources supported by DevOps Guru. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
ServiceCollection (dict) --
A collection of the names of Amazon Web Services services.
ServiceNames (list) --
An array of strings that each specifies the name of an Amazon Web Services 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.
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.
See also: AWS API Documentation
Request Syntax
client.describe_organization_resource_collection_health(
OrganizationResourceCollectionType='AWS_CLOUD_FORMATION'|'AWS_SERVICE'|'AWS_ACCOUNT',
AccountIds=[
'string',
],
OrganizationalUnitIds=[
'string',
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
list
The ID of the Amazon Web Services account.
(string) --
list
The ID of the organizational unit.
(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.
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.
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
}
},
],
'Account': [
{
'AccountId': 'string',
'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 Amazon Web Services resources in your account that are specified by an Amazon Web Services CloudFormation stack.
StackName (string) --
The name of the CloudFormation stack.
Insight (dict) --
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.
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 Amazon Web Services services associated with the resources in the collection.
(dict) --
Represents the health of an Amazon Web Services service.
ServiceName (string) --
The name of the Amazon Web Services service.
Insight (dict) --
Represents the health of an Amazon Web Services 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 Amazon Web Services service
OpenReactiveInsights (integer) --
The number of open reactive insights in the Amazon Web Services service
Account (list) --
The name of the organization's account.
(dict) --
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.
AccountId (string) --
The ID of the Amazon Web Services account.
Insight (dict) --
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.
OpenProactiveInsights (integer) --
An integer that specifies the number of open proactive insights in your Amazon Web Services account.
OpenReactiveInsights (integer) --
An integer that specifies the number of open reactive insights in your Amazon Web Services account.
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.
{'AccountId': 'string'}
Response {'ProactiveAnomaly': {'SourceDetails': {'CloudWatchMetrics': {'MetricDataSummary': {'StatusCode': 'Complete '
'| '
'InternalError '
'| '
'PartialData',
'TimestampMetricValuePairList': [{'MetricValue': 'double',
'Timestamp': 'timestamp'}]}}}},
'ReactiveAnomaly': {'SourceDetails': {'CloudWatchMetrics': {'MetricDataSummary': {'StatusCode': 'Complete '
'| '
'InternalError '
'| '
'PartialData',
'TimestampMetricValuePairList': [{'MetricValue': 'double',
'Timestamp': 'timestamp'}]}}}}}
Returns details about an anomaly that you specify using its ID.
See also: AWS API Documentation
Request Syntax
client.describe_anomaly(
Id='string',
AccountId='string'
)
string
[REQUIRED]
The ID of the anomaly.
string
The ID of the member account.
dict
Response Syntax
{
'ProactiveAnomaly': {
'Id': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'UpdateTime': datetime(2015, 1, 1),
'AnomalyTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'AnomalyReportedTimeRange': {
'OpenTime': datetime(2015, 1, 1),
'CloseTime': datetime(2015, 1, 1)
},
'PredictionTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'SourceDetails': {
'CloudWatchMetrics': [
{
'MetricName': 'string',
'Namespace': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Stat': 'Sum'|'Average'|'SampleCount'|'Minimum'|'Maximum'|'p99'|'p90'|'p50',
'Unit': 'string',
'Period': 123,
'MetricDataSummary': {
'TimestampMetricValuePairList': [
{
'Timestamp': datetime(2015, 1, 1),
'MetricValue': 123.0
},
],
'StatusCode': 'Complete'|'InternalError'|'PartialData'
}
},
]
},
'AssociatedInsightId': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'Limit': 123.0
},
'ReactiveAnomaly': {
'Id': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'AnomalyTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'AnomalyReportedTimeRange': {
'OpenTime': datetime(2015, 1, 1),
'CloseTime': datetime(2015, 1, 1)
},
'SourceDetails': {
'CloudWatchMetrics': [
{
'MetricName': 'string',
'Namespace': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Stat': 'Sum'|'Average'|'SampleCount'|'Minimum'|'Maximum'|'p99'|'p90'|'p50',
'Unit': 'string',
'Period': 123,
'MetricDataSummary': {
'TimestampMetricValuePairList': [
{
'Timestamp': datetime(2015, 1, 1),
'MetricValue': 123.0
},
],
'StatusCode': 'Complete'|'InternalError'|'PartialData'
}
},
]
},
'AssociatedInsightId': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
}
}
}
Response Structure
(dict) --
ProactiveAnomaly (dict) --
A ReactiveAnomaly object that represents the requested anomaly.
Id (string) --
The ID of a proactive anomaly.
Severity (string) --
The severity of a proactive anomaly.
Status (string) --
The status of a proactive anomaly.
UpdateTime (datetime) --
The time of the anomaly's most recent update.
AnomalyTimeRange (dict) --
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.
StartTime (datetime) --
The time when the anomalous behavior started.
EndTime (datetime) --
The time when the anomalous behavior ended.
AnomalyReportedTimeRange (dict) --
A AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.
OpenTime (datetime) --
The time when an anomaly is opened.
CloseTime (datetime) --
The time when an anomaly is closed.
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.
SourceDetails (dict) --
Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.
CloudWatchMetrics (list) --
An array of CloudWatchMetricsDetail object that contains information about the analyzed metrics that displayed anomalous behavior.
(dict) --
Information about an Amazon CloudWatch metric.
MetricName (string) --
The name of the CloudWatch metric.
Namespace (string) --
The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.
Dimensions (list) --
An array of CloudWatch dimensions associated with
(dict) --
The dimension of a Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in your account for operational problems and anomalous behavior. A dimension is a name/value pair that is part of the identity of a metric. A metric can have up to 10 dimensions. For more information, see Dimensions in the Amazon CloudWatch User Guide .
Name (string) --
The name of the CloudWatch dimension.
Value (string) --
The value of the CloudWatch dimension.
Stat (string) --
The type of statistic associated with the CloudWatch metric. For more information, see Statistics in the Amazon CloudWatch User Guide .
Unit (string) --
The unit of measure used for the CloudWatch metric. For example, Bytes , Seconds , Count , and Percent .
Period (integer) --
The length of time associated with the CloudWatch metric in number of seconds.
MetricDataSummary (dict) --
This object returns anomaly metric data.
TimestampMetricValuePairList (list) --
This is a list of cloudwatch metric values at given timestamp.
(dict) --
A pair that contains metric values at the respective timestamp.
Timestamp (datetime) --
A Timestamp that specifies the time the event occurred.
MetricValue (float) --
Value of the anomalous metric data point at respective Timestamp.
StatusCode (string) --
This is enum of the status showing whether the metric value pair list has Partial or Complete data or there was an error.
AssociatedInsightId (string) --
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
ResourceCollection (dict) --
A collection of Amazon Web Services resources supported by DevOps Guru. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Limit (float) --
A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly.
ReactiveAnomaly (dict) --
A ProactiveAnomaly object that represents the requested anomaly.
Id (string) --
The ID of the reactive anomaly.
Severity (string) --
The severity of the anomaly.
Status (string) --
The status of the anomaly.
AnomalyTimeRange (dict) --
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.
StartTime (datetime) --
The time when the anomalous behavior started.
EndTime (datetime) --
The time when the anomalous behavior ended.
AnomalyReportedTimeRange (dict) --
A AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.
OpenTime (datetime) --
The time when an anomaly is opened.
CloseTime (datetime) --
The time when an anomaly is closed.
SourceDetails (dict) --
Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.
CloudWatchMetrics (list) --
An array of CloudWatchMetricsDetail object that contains information about the analyzed metrics that displayed anomalous behavior.
(dict) --
Information about an Amazon CloudWatch metric.
MetricName (string) --
The name of the CloudWatch metric.
Namespace (string) --
The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.
Dimensions (list) --
An array of CloudWatch dimensions associated with
(dict) --
The dimension of a Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in your account for operational problems and anomalous behavior. A dimension is a name/value pair that is part of the identity of a metric. A metric can have up to 10 dimensions. For more information, see Dimensions in the Amazon CloudWatch User Guide .
Name (string) --
The name of the CloudWatch dimension.
Value (string) --
The value of the CloudWatch dimension.
Stat (string) --
The type of statistic associated with the CloudWatch metric. For more information, see Statistics in the Amazon CloudWatch User Guide .
Unit (string) --
The unit of measure used for the CloudWatch metric. For example, Bytes , Seconds , Count , and Percent .
Period (integer) --
The length of time associated with the CloudWatch metric in number of seconds.
MetricDataSummary (dict) --
This object returns anomaly metric data.
TimestampMetricValuePairList (list) --
This is a list of cloudwatch metric values at given timestamp.
(dict) --
A pair that contains metric values at the respective timestamp.
Timestamp (datetime) --
A Timestamp that specifies the time the event occurred.
MetricValue (float) --
Value of the anomalous metric data point at respective Timestamp.
StatusCode (string) --
This is enum of the status showing whether the metric value pair list has Partial or Complete data or there was an error.
AssociatedInsightId (string) --
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
ResourceCollection (dict) --
A collection of Amazon Web Services resources supported by DevOps Guru. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
{'AccountId': 'string'}
Returns details about an insight that you specify using its ID.
See also: AWS API Documentation
Request Syntax
client.describe_insight(
Id='string',
AccountId='string'
)
string
[REQUIRED]
The ID of the insight.
string
The ID of the member account in the organization.
dict
Response Syntax
{
'ProactiveInsight': {
'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',
]
}
},
'SsmOpsItemId': 'string'
},
'ReactiveInsight': {
'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',
]
}
},
'SsmOpsItemId': 'string'
}
}
Response Structure
(dict) --
ProactiveInsight (dict) --
A ProactiveInsight object that represents the requested insight.
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 Amazon Web Services resources supported by DevOps Guru. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
SsmOpsItemId (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.
ReactiveInsight (dict) --
A ReactiveInsight object that represents the requested insight.
Id (string) --
The ID of a reactive insight.
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 Amazon Web Services resources supported by DevOps Guru. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
SsmOpsItemId (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.
{'AccountId': 'string'}
Response {'ProactiveAnomalies': {'SourceDetails': {'CloudWatchMetrics': {'MetricDataSummary': {'StatusCode': 'Complete '
'| '
'InternalError '
'| '
'PartialData',
'TimestampMetricValuePairList': [{'MetricValue': 'double',
'Timestamp': 'timestamp'}]}}}},
'ReactiveAnomalies': {'SourceDetails': {'CloudWatchMetrics': {'MetricDataSummary': {'StatusCode': 'Complete '
'| '
'InternalError '
'| '
'PartialData',
'TimestampMetricValuePairList': [{'MetricValue': 'double',
'Timestamp': 'timestamp'}]}}}}}
Returns a list of the anomalies that belong to an insight that you specify using its ID.
See also: AWS API Documentation
Request Syntax
client.list_anomalies_for_insight(
InsightId='string',
StartTimeRange={
'FromTime': datetime(2015, 1, 1),
'ToTime': datetime(2015, 1, 1)
},
MaxResults=123,
NextToken='string',
AccountId='string'
)
string
[REQUIRED]
The ID of the insight. The returned anomalies belong to this insight.
dict
A time range used to specify when the requested anomalies started. All returned anomalies started during this time range.
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.
string
The ID of the Amazon Web Services account.
dict
Response Syntax
{
'ProactiveAnomalies': [
{
'Id': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'UpdateTime': datetime(2015, 1, 1),
'AnomalyTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'AnomalyReportedTimeRange': {
'OpenTime': datetime(2015, 1, 1),
'CloseTime': datetime(2015, 1, 1)
},
'PredictionTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'SourceDetails': {
'CloudWatchMetrics': [
{
'MetricName': 'string',
'Namespace': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Stat': 'Sum'|'Average'|'SampleCount'|'Minimum'|'Maximum'|'p99'|'p90'|'p50',
'Unit': 'string',
'Period': 123,
'MetricDataSummary': {
'TimestampMetricValuePairList': [
{
'Timestamp': datetime(2015, 1, 1),
'MetricValue': 123.0
},
],
'StatusCode': 'Complete'|'InternalError'|'PartialData'
}
},
]
},
'AssociatedInsightId': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'Limit': 123.0
},
],
'ReactiveAnomalies': [
{
'Id': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED',
'AnomalyTimeRange': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'AnomalyReportedTimeRange': {
'OpenTime': datetime(2015, 1, 1),
'CloseTime': datetime(2015, 1, 1)
},
'SourceDetails': {
'CloudWatchMetrics': [
{
'MetricName': 'string',
'Namespace': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Stat': 'Sum'|'Average'|'SampleCount'|'Minimum'|'Maximum'|'p99'|'p90'|'p50',
'Unit': 'string',
'Period': 123,
'MetricDataSummary': {
'TimestampMetricValuePairList': [
{
'Timestamp': datetime(2015, 1, 1),
'MetricValue': 123.0
},
],
'StatusCode': 'Complete'|'InternalError'|'PartialData'
}
},
]
},
'AssociatedInsightId': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProactiveAnomalies (list) --
An array of ProactiveAnomalySummary objects that represent the requested anomalies
(dict) --
Details about a proactive anomaly. This object is returned by DescribeAnomaly.
Id (string) --
The ID of the anomaly.
Severity (string) --
The severity of the anomaly.
Status (string) --
The status of the anomaly.
UpdateTime (datetime) --
The time of the anomaly's most recent update.
AnomalyTimeRange (dict) --
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.
StartTime (datetime) --
The time when the anomalous behavior started.
EndTime (datetime) --
The time when the anomalous behavior ended.
AnomalyReportedTimeRange (dict) --
A AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.
OpenTime (datetime) --
The time when an anomaly is opened.
CloseTime (datetime) --
The time when an anomaly is closed.
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.
SourceDetails (dict) --
Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.
CloudWatchMetrics (list) --
An array of CloudWatchMetricsDetail object that contains information about the analyzed metrics that displayed anomalous behavior.
(dict) --
Information about an Amazon CloudWatch metric.
MetricName (string) --
The name of the CloudWatch metric.
Namespace (string) --
The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.
Dimensions (list) --
An array of CloudWatch dimensions associated with
(dict) --
The dimension of a Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in your account for operational problems and anomalous behavior. A dimension is a name/value pair that is part of the identity of a metric. A metric can have up to 10 dimensions. For more information, see Dimensions in the Amazon CloudWatch User Guide .
Name (string) --
The name of the CloudWatch dimension.
Value (string) --
The value of the CloudWatch dimension.
Stat (string) --
The type of statistic associated with the CloudWatch metric. For more information, see Statistics in the Amazon CloudWatch User Guide .
Unit (string) --
The unit of measure used for the CloudWatch metric. For example, Bytes , Seconds , Count , and Percent .
Period (integer) --
The length of time associated with the CloudWatch metric in number of seconds.
MetricDataSummary (dict) --
This object returns anomaly metric data.
TimestampMetricValuePairList (list) --
This is a list of cloudwatch metric values at given timestamp.
(dict) --
A pair that contains metric values at the respective timestamp.
Timestamp (datetime) --
A Timestamp that specifies the time the event occurred.
MetricValue (float) --
Value of the anomalous metric data point at respective Timestamp.
StatusCode (string) --
This is enum of the status showing whether the metric value pair list has Partial or Complete data or there was an error.
AssociatedInsightId (string) --
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
ResourceCollection (dict) --
A collection of Amazon Web Services resources supported by DevOps Guru. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Limit (float) --
A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly.
ReactiveAnomalies (list) --
An array of ReactiveAnomalySummary objects that represent the requested anomalies
(dict) --
Details about a reactive anomaly. This object is returned by DescribeAnomaly.
Id (string) --
The ID of the reactive anomaly.
Severity (string) --
The severity of the reactive anomaly.
Status (string) --
The status of the reactive anomaly.
AnomalyTimeRange (dict) --
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.
StartTime (datetime) --
The time when the anomalous behavior started.
EndTime (datetime) --
The time when the anomalous behavior ended.
AnomalyReportedTimeRange (dict) --
A AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.
OpenTime (datetime) --
The time when an anomaly is opened.
CloseTime (datetime) --
The time when an anomaly is closed.
SourceDetails (dict) --
Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.
CloudWatchMetrics (list) --
An array of CloudWatchMetricsDetail object that contains information about the analyzed metrics that displayed anomalous behavior.
(dict) --
Information about an Amazon CloudWatch metric.
MetricName (string) --
The name of the CloudWatch metric.
Namespace (string) --
The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.
Dimensions (list) --
An array of CloudWatch dimensions associated with
(dict) --
The dimension of a Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in your account for operational problems and anomalous behavior. A dimension is a name/value pair that is part of the identity of a metric. A metric can have up to 10 dimensions. For more information, see Dimensions in the Amazon CloudWatch User Guide .
Name (string) --
The name of the CloudWatch dimension.
Value (string) --
The value of the CloudWatch dimension.
Stat (string) --
The type of statistic associated with the CloudWatch metric. For more information, see Statistics in the Amazon CloudWatch User Guide .
Unit (string) --
The unit of measure used for the CloudWatch metric. For example, Bytes , Seconds , Count , and Percent .
Period (integer) --
The length of time associated with the CloudWatch metric in number of seconds.
MetricDataSummary (dict) --
This object returns anomaly metric data.
TimestampMetricValuePairList (list) --
This is a list of cloudwatch metric values at given timestamp.
(dict) --
A pair that contains metric values at the respective timestamp.
Timestamp (datetime) --
A Timestamp that specifies the time the event occurred.
MetricValue (float) --
Value of the anomalous metric data point at respective Timestamp.
StatusCode (string) --
This is enum of the status showing whether the metric value pair list has Partial or Complete data or there was an error.
AssociatedInsightId (string) --
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
ResourceCollection (dict) --
A collection of Amazon Web Services resources supported by DevOps Guru. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
CloudFormation (dict) --
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.
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.
{'AccountId': 'string'}
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.
See also: AWS API Documentation
Request Syntax
client.list_events(
Filters={
'InsightId': 'string',
'EventTimeRange': {
'FromTime': datetime(2015, 1, 1),
'ToTime': datetime(2015, 1, 1)
},
'EventClass': 'INFRASTRUCTURE'|'DEPLOYMENT'|'SECURITY_CHANGE'|'CONFIG_CHANGE'|'SCHEMA_CHANGE',
'EventSource': 'string',
'DataSource': 'AWS_CLOUD_TRAIL'|'AWS_CODE_DEPLOY',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
}
},
MaxResults=123,
NextToken='string',
AccountId='string'
)
dict
[REQUIRED]
A ListEventsFilters object used to specify which events to return.
InsightId (string) --
An ID of an insight that is related to the events you want to filter for.
EventTimeRange (dict) --
A time range during which you want the filtered events to have occurred.
FromTime (datetime) -- [REQUIRED]
The time when the event started.
ToTime (datetime) -- [REQUIRED]
The time when the event ended.
EventClass (string) --
The class of the events you want to filter for, such as an infrastructure change, a deployment, or a schema change.
EventSource (string) --
The Amazon Web Services source that emitted the events you want to filter for.
DataSource (string) --
The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY , of the events you want returned.
ResourceCollection (dict) --
A collection of Amazon Web Services resources supported by DevOps Guru. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(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
The ID of the Amazon Web Services account.
dict
Response Syntax
{
'Events': [
{
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'Id': 'string',
'Time': datetime(2015, 1, 1),
'EventSource': 'string',
'Name': 'string',
'DataSource': 'AWS_CLOUD_TRAIL'|'AWS_CODE_DEPLOY',
'EventClass': 'INFRASTRUCTURE'|'DEPLOYMENT'|'SECURITY_CHANGE'|'CONFIG_CHANGE'|'SCHEMA_CHANGE',
'Resources': [
{
'Type': 'string',
'Name': 'string',
'Arn': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Events (list) --
A list of the requested events.
(dict) --
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.
ResourceCollection (dict) --
A collection of Amazon Web Services resources supported by DevOps Guru. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze only the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
CloudFormation (dict) --
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.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Id (string) --
The ID of the event.
Time (datetime) --
A Timestamp that specifies the time the event occurred.
EventSource (string) --
The Amazon Web Services source that emitted the event.
Name (string) --
The name of the event.
DataSource (string) --
The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY , where DevOps Guru analysis found the event.
EventClass (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.
Resources (list) --
An EventResource object that contains information about the resource that emitted the event.
(dict) --
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.
Type (string) --
The type of resource that emitted an event.
Name (string) --
The name of the resource that emitted an event.
Arn (string) --
The Amazon Resource Name (ARN) of the resource that emitted an event.
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.
{'AccountId': 'string'}
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',
AccountId='string'
)
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.
string
The ID of the Amazon Web Services account.
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 Amazon Web Services CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.
(dict) --
Information about an Amazon Web Services 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.