Amazon DevOps Guru

2020/12/01 - Amazon DevOps Guru - 18 new api methods

Changes  Update devops-guru client to latest version

SearchInsights (new) Link ¶

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'
)
type Filters:

dict

param Filters:
  • ResourceCollection (dict) --

    • CloudFormation (dict) --

      • StackNames (list) --

        • (string) --

  • Severities (list) --

    • (string) --

  • Statuses (list) --

    • (string) --

type MaxResults:

integer

param MaxResults:

type NextToken:

string

param NextToken:

type StartTimeRange:

dict

param StartTimeRange:

[REQUIRED]

  • FromTime (datetime) --

  • ToTime (datetime) --

type Type:

string

param Type:

[REQUIRED]

rtype:

dict

returns:

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

DescribeAccountOverview (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.describe_account_overview(
    FromTime=datetime(2015, 1, 1),
    ToTime=datetime(2015, 1, 1)
)
type FromTime:

datetime

param FromTime:

[REQUIRED]

type ToTime:

datetime

param ToTime:

rtype:

dict

returns:

Response Syntax

{
    'MeanTimeToRecoverInMilliseconds': 123,
    'ProactiveInsights': 123,
    'ReactiveInsights': 123
}

Response Structure

  • (dict) --

    • MeanTimeToRecoverInMilliseconds (integer) --

    • ProactiveInsights (integer) --

    • ReactiveInsights (integer) --

ListEvents (new) Link ¶

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'
)
type Filters:

dict

param Filters:

[REQUIRED]

  • DataSource (string) --

  • EventClass (string) --

  • EventSource (string) --

  • EventTimeRange (dict) --

    • FromTime (datetime) -- [REQUIRED]

    • ToTime (datetime) -- [REQUIRED]

  • InsightId (string) --

  • ResourceCollection (dict) --

    • CloudFormation (dict) --

      • StackNames (list) --

        • (string) --

type MaxResults:

integer

param MaxResults:

type NextToken:

string

param NextToken:

rtype:

dict

returns:

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

DescribeInsight (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.describe_insight(
    Id='string'
)
type Id:

string

param Id:

[REQUIRED]

rtype:

dict

returns:

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

DescribeServiceIntegration (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.describe_service_integration()
rtype:

dict

returns:

Response Syntax

{
    'ServiceIntegration': {
        'OpsCenter': {
            'OptInStatus': 'ENABLED'|'DISABLED'
        }
    }
}

Response Structure

  • (dict) --

    • ServiceIntegration (dict) --

      • OpsCenter (dict) --

        • OptInStatus (string) --

DescribeResourceCollectionHealth (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.describe_resource_collection_health(
    NextToken='string',
    ResourceCollectionType='string'
)
type NextToken:

string

param NextToken:

type ResourceCollectionType:

string

param ResourceCollectionType:

[REQUIRED]

rtype:

dict

returns:

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

UpdateServiceIntegration (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.update_service_integration(
    ServiceIntegration={
        'OpsCenter': {
            'OptInStatus': 'ENABLED'|'DISABLED'
        }
    }
)
type ServiceIntegration:

dict

param ServiceIntegration:

[REQUIRED]

  • OpsCenter (dict) --

    • OptInStatus (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

UpdateResourceCollection (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.update_resource_collection(
    Action='ADD'|'REMOVE',
    ResourceCollection={
        'CloudFormation': {
            'StackNames': [
                'string',
            ]
        }
    }
)
type Action:

string

param Action:

[REQUIRED]

type ResourceCollection:

dict

param ResourceCollection:

[REQUIRED]

  • CloudFormation (dict) --

    • StackNames (list) --

      • (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

ListNotificationChannels (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.list_notification_channels(
    NextToken='string'
)
type NextToken:

string

param NextToken:

rtype:

dict

returns:

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

DescribeAccountHealth (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.describe_account_health()
rtype:

dict

returns:

Response Syntax

{
    'MetricsAnalyzed': 123,
    'OpenProactiveInsights': 123,
    'OpenReactiveInsights': 123
}

Response Structure

  • (dict) --

    • MetricsAnalyzed (integer) --

    • OpenProactiveInsights (integer) --

    • OpenReactiveInsights (integer) --

ListAnomaliesForInsight (new) Link ¶

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)
    }
)
type InsightId:

string

param InsightId:

[REQUIRED]

type MaxResults:

integer

param MaxResults:

type NextToken:

string

param NextToken:

type StartTimeRange:

dict

param StartTimeRange:
  • FromTime (datetime) --

  • ToTime (datetime) --

rtype:

dict

returns:

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

DescribeAnomaly (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.describe_anomaly(
    Id='string'
)
type Id:

string

param Id:

[REQUIRED]

rtype:

dict

returns:

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

RemoveNotificationChannel (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.remove_notification_channel(
    Id='string'
)
type Id:

string

param Id:

[REQUIRED]

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

GetResourceCollection (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.get_resource_collection(
    NextToken='string',
    ResourceCollectionType='string'
)
type NextToken:

string

param NextToken:

type ResourceCollectionType:

string

param ResourceCollectionType:

[REQUIRED]

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'ResourceCollection': {
        'CloudFormation': {
            'StackNames': [
                'string',
            ]
        }
    }
}

Response Structure

  • (dict) --

    • NextToken (string) --

    • ResourceCollection (dict) --

      • CloudFormation (dict) --

        • StackNames (list) --

          • (string) --

ListRecommendations (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.list_recommendations(
    InsightId='string',
    NextToken='string'
)
type InsightId:

string

param InsightId:

[REQUIRED]

type NextToken:

string

param NextToken:

rtype:

dict

returns:

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

ListInsights (new) Link ¶

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'
        }
    }
)
type MaxResults:

integer

param MaxResults:

type NextToken:

string

param NextToken:

type StatusFilter:

dict

param StatusFilter:

[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]

rtype:

dict

returns:

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

AddNotificationChannel (new) Link ¶

See also: AWS API Documentation

Request Syntax

client.add_notification_channel(
    Config={
        'Sns': {
            'TopicArn': 'string'
        }
    }
)
type Config:

dict

param Config:

[REQUIRED]

  • Sns (dict) -- [REQUIRED]

    • TopicArn (string) --

rtype:

dict

returns:

Response Syntax

{
    'Id': 'string'
}

Response Structure

  • (dict) --

    • Id (string) --

PutFeedback (new) Link ¶

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'
    }
)
type InsightFeedback:

dict

param InsightFeedback:
  • Feedback (string) --

  • Id (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --