2020/12/01 - Amazon DevOps Guru - 18 new api methods
Changes (New Service) Amazon DevOps Guru is available in public preview. It's a fully managed service that uses machine learning to analyze your operational solutions to help you find and troubleshoot issues.
See also: AWS API Documentation
Request Syntax
client.describe_service_integration()
dict
Response Syntax
{
'ServiceIntegration': {
'OpsCenter': {
'OptInStatus': 'ENABLED'|'DISABLED'
}
}
}
Response Structure
(dict) --
ServiceIntegration (dict) --
OpsCenter (dict) --
OptInStatus (string) --
See also: AWS API Documentation
Request Syntax
client.list_recommendations(
InsightId='string',
NextToken='string'
)
string
[REQUIRED]
string
dict
Response Syntax
{
'NextToken': 'string',
'Recommendations': [
{
'Description': 'string',
'Link': 'string',
'Name': 'string',
'Reason': 'string',
'RelatedAnomalies': [
{
'Resources': [
{
'Name': 'string',
'Type': 'string'
},
],
'SourceDetails': [
{
'CloudWatchMetrics': [
{
'MetricName': 'string',
'Namespace': 'string'
},
]
},
]
},
],
'RelatedEvents': [
{
'Name': 'string',
'Resources': [
{
'Name': 'string',
'Type': 'string'
},
]
},
]
},
]
}
Response Structure
(dict) --
NextToken (string) --
Recommendations (list) --
(dict) --
Description (string) --
Link (string) --
Name (string) --
Reason (string) --
RelatedAnomalies (list) --
(dict) --
Resources (list) --
(dict) --
Name (string) --
Type (string) --
SourceDetails (list) --
(dict) --
CloudWatchMetrics (list) --
(dict) --
MetricName (string) --
Namespace (string) --
RelatedEvents (list) --
(dict) --
Name (string) --
Resources (list) --
(dict) --
Name (string) --
Type (string) --
See also: AWS API Documentation
Request Syntax
client.describe_account_health()
dict
Response Syntax
{
'MetricsAnalyzed': 123,
'OpenProactiveInsights': 123,
'OpenReactiveInsights': 123
}
Response Structure
(dict) --
MetricsAnalyzed (integer) --
OpenProactiveInsights (integer) --
OpenReactiveInsights (integer) --
See also: AWS API Documentation
Request Syntax
client.describe_resource_collection_health(
NextToken='string',
ResourceCollectionType='string'
)
string
string
[REQUIRED]
dict
Response Syntax
{
'CloudFormation': [
{
'Insight': {
'MeanTimeToRecoverInMilliseconds': 123,
'OpenProactiveInsights': 123,
'OpenReactiveInsights': 123
},
'StackName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CloudFormation (list) --
(dict) --
Insight (dict) --
MeanTimeToRecoverInMilliseconds (integer) --
OpenProactiveInsights (integer) --
OpenReactiveInsights (integer) --
StackName (string) --
NextToken (string) --
See also: AWS API Documentation
Request Syntax
client.list_anomalies_for_insight(
InsightId='string',
MaxResults=123,
NextToken='string',
StartTimeRange={
'FromTime': datetime(2015, 1, 1),
'ToTime': datetime(2015, 1, 1)
}
)
string
[REQUIRED]
integer
string
dict
FromTime (datetime) --
ToTime (datetime) --
dict
Response Syntax
{
'NextToken': 'string',
'ProactiveAnomalies': [
{
'AnomalyTimeRange': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
},
'AssociatedInsightId': 'string',
'Id': 'string',
'Limit': 123.0,
'PredictionTimeRange': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'SourceDetails': {
'CloudWatchMetrics': [
{
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'MetricName': 'string',
'Namespace': 'string',
'Period': 123,
'Stat': 'Sum'|'Average'|'SampleCount'|'Minimum'|'Maximum'|'p99'|'p90'|'p50',
'Unit': 'string'
},
]
},
'Status': 'ONGOING'|'CLOSED',
'UpdateTime': datetime(2015, 1, 1)
},
],
'ReactiveAnomalies': [
{
'AnomalyTimeRange': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
},
'AssociatedInsightId': 'string',
'Id': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'SourceDetails': {
'CloudWatchMetrics': [
{
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'MetricName': 'string',
'Namespace': 'string',
'Period': 123,
'Stat': 'Sum'|'Average'|'SampleCount'|'Minimum'|'Maximum'|'p99'|'p90'|'p50',
'Unit': 'string'
},
]
},
'Status': 'ONGOING'|'CLOSED'
},
]
}
Response Structure
(dict) --
NextToken (string) --
ProactiveAnomalies (list) --
(dict) --
AnomalyTimeRange (dict) --
EndTime (datetime) --
StartTime (datetime) --
AssociatedInsightId (string) --
Id (string) --
Limit (float) --
PredictionTimeRange (dict) --
EndTime (datetime) --
StartTime (datetime) --
ResourceCollection (dict) --
CloudFormation (dict) --
StackNames (list) --
(string) --
Severity (string) --
SourceDetails (dict) --
CloudWatchMetrics (list) --
(dict) --
Dimensions (list) --
(dict) --
Name (string) --
Value (string) --
MetricName (string) --
Namespace (string) --
Period (integer) --
Stat (string) --
Unit (string) --
Status (string) --
UpdateTime (datetime) --
ReactiveAnomalies (list) --
(dict) --
AnomalyTimeRange (dict) --
EndTime (datetime) --
StartTime (datetime) --
AssociatedInsightId (string) --
Id (string) --
ResourceCollection (dict) --
CloudFormation (dict) --
StackNames (list) --
(string) --
Severity (string) --
SourceDetails (dict) --
CloudWatchMetrics (list) --
(dict) --
Dimensions (list) --
(dict) --
Name (string) --
Value (string) --
MetricName (string) --
Namespace (string) --
Period (integer) --
Stat (string) --
Unit (string) --
Status (string) --
See also: AWS API Documentation
Request Syntax
client.list_events(
Filters={
'DataSource': 'AWS_CLOUD_TRAIL'|'AWS_CODE_DEPLOY',
'EventClass': 'INFRASTRUCTURE'|'DEPLOYMENT'|'SECURITY_CHANGE'|'CONFIG_CHANGE'|'SCHEMA_CHANGE',
'EventSource': 'string',
'EventTimeRange': {
'FromTime': datetime(2015, 1, 1),
'ToTime': datetime(2015, 1, 1)
},
'InsightId': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
}
},
MaxResults=123,
NextToken='string'
)
dict
[REQUIRED]
DataSource (string) --
EventClass (string) --
EventSource (string) --
EventTimeRange (dict) --
FromTime (datetime) -- [REQUIRED]
ToTime (datetime) -- [REQUIRED]
InsightId (string) --
ResourceCollection (dict) --
CloudFormation (dict) --
StackNames (list) --
(string) --
integer
string
dict
Response Syntax
{
'Events': [
{
'DataSource': 'AWS_CLOUD_TRAIL'|'AWS_CODE_DEPLOY',
'EventClass': 'INFRASTRUCTURE'|'DEPLOYMENT'|'SECURITY_CHANGE'|'CONFIG_CHANGE'|'SCHEMA_CHANGE',
'EventSource': 'string',
'Id': 'string',
'Name': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'Resources': [
{
'Arn': 'string',
'Name': 'string',
'Type': 'string'
},
],
'Time': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Events (list) --
(dict) --
DataSource (string) --
EventClass (string) --
EventSource (string) --
Id (string) --
Name (string) --
ResourceCollection (dict) --
CloudFormation (dict) --
StackNames (list) --
(string) --
Resources (list) --
(dict) --
Arn (string) --
Name (string) --
Type (string) --
Time (datetime) --
NextToken (string) --
See also: AWS API Documentation
Request Syntax
client.put_feedback(
InsightFeedback={
'Feedback': 'VALID_COLLECTION'|'RECOMMENDATION_USEFUL'|'ALERT_TOO_SENSITIVE'|'DATA_NOISY_ANOMALY'|'DATA_INCORRECT',
'Id': 'string'
}
)
dict
Feedback (string) --
Id (string) --
dict
Response Syntax
{}
Response Structure
(dict) --
See also: AWS API Documentation
Request Syntax
client.add_notification_channel(
Config={
'Sns': {
'TopicArn': 'string'
}
}
)
dict
[REQUIRED]
Sns (dict) -- [REQUIRED]
TopicArn (string) --
dict
Response Syntax
{
'Id': 'string'
}
Response Structure
(dict) --
Id (string) --
See also: AWS API Documentation
Request Syntax
client.get_resource_collection(
NextToken='string',
ResourceCollectionType='string'
)
string
string
[REQUIRED]
dict
Response Syntax
{
'NextToken': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
}
}
Response Structure
(dict) --
NextToken (string) --
ResourceCollection (dict) --
CloudFormation (dict) --
StackNames (list) --
(string) --
See also: AWS API Documentation
Request Syntax
client.list_notification_channels(
NextToken='string'
)
string
dict
Response Syntax
{
'Channels': [
{
'Config': {
'Sns': {
'TopicArn': 'string'
}
},
'Id': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Channels (list) --
(dict) --
Config (dict) --
Sns (dict) --
TopicArn (string) --
Id (string) --
NextToken (string) --
See also: AWS API Documentation
Request Syntax
client.describe_insight(
Id='string'
)
string
[REQUIRED]
dict
Response Syntax
{
'ProactiveInsight': {
'Id': 'string',
'InsightTimeRange': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
},
'Name': 'string',
'PredictionTimeRange': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'SsmOpsItemId': 'string',
'Status': 'ONGOING'|'CLOSED'
},
'ReactiveInsight': {
'Id': 'string',
'InsightTimeRange': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
},
'Name': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'SsmOpsItemId': 'string',
'Status': 'ONGOING'|'CLOSED'
}
}
Response Structure
(dict) --
ProactiveInsight (dict) --
Id (string) --
InsightTimeRange (dict) --
EndTime (datetime) --
StartTime (datetime) --
Name (string) --
PredictionTimeRange (dict) --
EndTime (datetime) --
StartTime (datetime) --
ResourceCollection (dict) --
CloudFormation (dict) --
StackNames (list) --
(string) --
Severity (string) --
SsmOpsItemId (string) --
Status (string) --
ReactiveInsight (dict) --
Id (string) --
InsightTimeRange (dict) --
EndTime (datetime) --
StartTime (datetime) --
Name (string) --
ResourceCollection (dict) --
CloudFormation (dict) --
StackNames (list) --
(string) --
Severity (string) --
SsmOpsItemId (string) --
Status (string) --
See also: AWS API Documentation
Request Syntax
client.list_insights(
MaxResults=123,
NextToken='string',
StatusFilter={
'Any': {
'StartTimeRange': {
'FromTime': datetime(2015, 1, 1),
'ToTime': datetime(2015, 1, 1)
},
'Type': 'REACTIVE'|'PROACTIVE'
},
'Closed': {
'EndTimeRange': {
'FromTime': datetime(2015, 1, 1),
'ToTime': datetime(2015, 1, 1)
},
'Type': 'REACTIVE'|'PROACTIVE'
},
'Ongoing': {
'Type': 'REACTIVE'|'PROACTIVE'
}
}
)
integer
string
dict
[REQUIRED]
Any (dict) --
StartTimeRange (dict) -- [REQUIRED]
FromTime (datetime) --
ToTime (datetime) --
Type (string) -- [REQUIRED]
Closed (dict) --
EndTimeRange (dict) -- [REQUIRED]
FromTime (datetime) --
ToTime (datetime) --
Type (string) -- [REQUIRED]
Ongoing (dict) --
Type (string) -- [REQUIRED]
dict
Response Syntax
{
'NextToken': 'string',
'ProactiveInsights': [
{
'Id': 'string',
'InsightTimeRange': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
},
'Name': 'string',
'PredictionTimeRange': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED'
},
],
'ReactiveInsights': [
{
'Id': 'string',
'InsightTimeRange': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
},
'Name': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED'
},
]
}
Response Structure
(dict) --
NextToken (string) --
ProactiveInsights (list) --
(dict) --
Id (string) --
InsightTimeRange (dict) --
EndTime (datetime) --
StartTime (datetime) --
Name (string) --
PredictionTimeRange (dict) --
EndTime (datetime) --
StartTime (datetime) --
ResourceCollection (dict) --
CloudFormation (dict) --
StackNames (list) --
(string) --
Severity (string) --
Status (string) --
ReactiveInsights (list) --
(dict) --
Id (string) --
InsightTimeRange (dict) --
EndTime (datetime) --
StartTime (datetime) --
Name (string) --
ResourceCollection (dict) --
CloudFormation (dict) --
StackNames (list) --
(string) --
Severity (string) --
Status (string) --
See also: AWS API Documentation
Request Syntax
client.remove_notification_channel(
Id='string'
)
string
[REQUIRED]
dict
Response Syntax
{}
Response Structure
(dict) --
See also: AWS API Documentation
Request Syntax
client.search_insights(
Filters={
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'Severities': [
'LOW'|'MEDIUM'|'HIGH',
],
'Statuses': [
'ONGOING'|'CLOSED',
]
},
MaxResults=123,
NextToken='string',
StartTimeRange={
'FromTime': datetime(2015, 1, 1),
'ToTime': datetime(2015, 1, 1)
},
Type='REACTIVE'|'PROACTIVE'
)
dict
ResourceCollection (dict) --
CloudFormation (dict) --
StackNames (list) --
(string) --
Severities (list) --
(string) --
Statuses (list) --
(string) --
integer
string
dict
[REQUIRED]
FromTime (datetime) --
ToTime (datetime) --
string
[REQUIRED]
dict
Response Syntax
{
'NextToken': 'string',
'ProactiveInsights': [
{
'Id': 'string',
'InsightTimeRange': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
},
'Name': 'string',
'PredictionTimeRange': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED'
},
],
'ReactiveInsights': [
{
'Id': 'string',
'InsightTimeRange': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
},
'Name': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'Status': 'ONGOING'|'CLOSED'
},
]
}
Response Structure
(dict) --
NextToken (string) --
ProactiveInsights (list) --
(dict) --
Id (string) --
InsightTimeRange (dict) --
EndTime (datetime) --
StartTime (datetime) --
Name (string) --
PredictionTimeRange (dict) --
EndTime (datetime) --
StartTime (datetime) --
ResourceCollection (dict) --
CloudFormation (dict) --
StackNames (list) --
(string) --
Severity (string) --
Status (string) --
ReactiveInsights (list) --
(dict) --
Id (string) --
InsightTimeRange (dict) --
EndTime (datetime) --
StartTime (datetime) --
Name (string) --
ResourceCollection (dict) --
CloudFormation (dict) --
StackNames (list) --
(string) --
Severity (string) --
Status (string) --
See also: AWS API Documentation
Request Syntax
client.describe_anomaly(
Id='string'
)
string
[REQUIRED]
dict
Response Syntax
{
'ProactiveAnomaly': {
'AnomalyTimeRange': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
},
'AssociatedInsightId': 'string',
'Id': 'string',
'Limit': 123.0,
'PredictionTimeRange': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
},
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'SourceDetails': {
'CloudWatchMetrics': [
{
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'MetricName': 'string',
'Namespace': 'string',
'Period': 123,
'Stat': 'Sum'|'Average'|'SampleCount'|'Minimum'|'Maximum'|'p99'|'p90'|'p50',
'Unit': 'string'
},
]
},
'Status': 'ONGOING'|'CLOSED',
'UpdateTime': datetime(2015, 1, 1)
},
'ReactiveAnomaly': {
'AnomalyTimeRange': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
},
'AssociatedInsightId': 'string',
'Id': 'string',
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
}
},
'Severity': 'LOW'|'MEDIUM'|'HIGH',
'SourceDetails': {
'CloudWatchMetrics': [
{
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'MetricName': 'string',
'Namespace': 'string',
'Period': 123,
'Stat': 'Sum'|'Average'|'SampleCount'|'Minimum'|'Maximum'|'p99'|'p90'|'p50',
'Unit': 'string'
},
]
},
'Status': 'ONGOING'|'CLOSED'
}
}
Response Structure
(dict) --
ProactiveAnomaly (dict) --
AnomalyTimeRange (dict) --
EndTime (datetime) --
StartTime (datetime) --
AssociatedInsightId (string) --
Id (string) --
Limit (float) --
PredictionTimeRange (dict) --
EndTime (datetime) --
StartTime (datetime) --
ResourceCollection (dict) --
CloudFormation (dict) --
StackNames (list) --
(string) --
Severity (string) --
SourceDetails (dict) --
CloudWatchMetrics (list) --
(dict) --
Dimensions (list) --
(dict) --
Name (string) --
Value (string) --
MetricName (string) --
Namespace (string) --
Period (integer) --
Stat (string) --
Unit (string) --
Status (string) --
UpdateTime (datetime) --
ReactiveAnomaly (dict) --
AnomalyTimeRange (dict) --
EndTime (datetime) --
StartTime (datetime) --
AssociatedInsightId (string) --
Id (string) --
ResourceCollection (dict) --
CloudFormation (dict) --
StackNames (list) --
(string) --
Severity (string) --
SourceDetails (dict) --
CloudWatchMetrics (list) --
(dict) --
Dimensions (list) --
(dict) --
Name (string) --
Value (string) --
MetricName (string) --
Namespace (string) --
Period (integer) --
Stat (string) --
Unit (string) --
Status (string) --
See also: AWS API Documentation
Request Syntax
client.describe_account_overview(
FromTime=datetime(2015, 1, 1),
ToTime=datetime(2015, 1, 1)
)
datetime
[REQUIRED]
datetime
dict
Response Syntax
{
'MeanTimeToRecoverInMilliseconds': 123,
'ProactiveInsights': 123,
'ReactiveInsights': 123
}
Response Structure
(dict) --
MeanTimeToRecoverInMilliseconds (integer) --
ProactiveInsights (integer) --
ReactiveInsights (integer) --
See also: AWS API Documentation
Request Syntax
client.update_resource_collection(
Action='ADD'|'REMOVE',
ResourceCollection={
'CloudFormation': {
'StackNames': [
'string',
]
}
}
)
string
[REQUIRED]
dict
[REQUIRED]
CloudFormation (dict) --
StackNames (list) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
See also: AWS API Documentation
Request Syntax
client.update_service_integration(
ServiceIntegration={
'OpsCenter': {
'OptInStatus': 'ENABLED'|'DISABLED'
}
}
)
dict
[REQUIRED]
OpsCenter (dict) --
OptInStatus (string) --
dict
Response Syntax
{}
Response Structure
(dict) --