DevOpsGuru

Table of Contents

Client

class DevOpsGuru.Client

A low-level client representing Amazon DevOps Guru

import boto3

client = boto3.client('devops-guru')

These are the available methods:

add_notification_channel(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.add_notification_channel(
    Config={
        'Sns': {
            'TopicArn': 'string'
        }
    }
)
Parameters
Config (dict) --

[REQUIRED]

  • Sns (dict) -- [REQUIRED]
    • TopicArn (string) --
Return type
dict
Returns
Response Syntax
{
    'Id': 'string'
}

Response Structure

  • (dict) --
    • Id (string) --

Exceptions

  • DevOpsGuru.Client.exceptions.ValidationException
  • DevOpsGuru.Client.exceptions.InternalServerException
  • DevOpsGuru.Client.exceptions.ServiceQuotaExceededException
  • DevOpsGuru.Client.exceptions.AccessDeniedException
  • DevOpsGuru.Client.exceptions.ResourceNotFoundException
  • DevOpsGuru.Client.exceptions.ThrottlingException
  • DevOpsGuru.Client.exceptions.ConflictException
can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
describe_account_health()

See also: AWS API Documentation

Request Syntax

response = client.describe_account_health()
Return type
dict
Returns
Response Syntax
{
    'MetricsAnalyzed': 123,
    'OpenProactiveInsights': 123,
    'OpenReactiveInsights': 123
}

Response Structure

  • (dict) --
    • MetricsAnalyzed (integer) --
    • OpenProactiveInsights (integer) --
    • OpenReactiveInsights (integer) --

Exceptions

  • DevOpsGuru.Client.exceptions.ThrottlingException
  • DevOpsGuru.Client.exceptions.ValidationException
  • DevOpsGuru.Client.exceptions.InternalServerException
  • DevOpsGuru.Client.exceptions.AccessDeniedException
describe_account_overview(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.describe_account_overview(
    FromTime=datetime(2015, 1, 1),
    ToTime=datetime(2015, 1, 1)
)
Parameters
  • FromTime (datetime) -- [REQUIRED]
  • ToTime (datetime) --
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • MeanTimeToRecoverInMilliseconds (integer) --
    • ProactiveInsights (integer) --
    • ReactiveInsights (integer) --

Exceptions

  • DevOpsGuru.Client.exceptions.ThrottlingException
  • DevOpsGuru.Client.exceptions.ValidationException
  • DevOpsGuru.Client.exceptions.InternalServerException
  • DevOpsGuru.Client.exceptions.AccessDeniedException
describe_anomaly(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.describe_anomaly(
    Id='string'
)
Parameters
Id (string) -- [REQUIRED]
Return type
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) --

Exceptions

  • DevOpsGuru.Client.exceptions.ResourceNotFoundException
  • DevOpsGuru.Client.exceptions.ThrottlingException
  • DevOpsGuru.Client.exceptions.ValidationException
  • DevOpsGuru.Client.exceptions.InternalServerException
  • DevOpsGuru.Client.exceptions.AccessDeniedException
describe_insight(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.describe_insight(
    Id='string'
)
Parameters
Id (string) -- [REQUIRED]
Return type
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) --

Exceptions

  • DevOpsGuru.Client.exceptions.ResourceNotFoundException
  • DevOpsGuru.Client.exceptions.ThrottlingException
  • DevOpsGuru.Client.exceptions.ValidationException
  • DevOpsGuru.Client.exceptions.InternalServerException
  • DevOpsGuru.Client.exceptions.AccessDeniedException
describe_resource_collection_health(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.describe_resource_collection_health(
    NextToken='string',
    ResourceCollectionType='string'
)
Parameters
  • NextToken (string) --
  • ResourceCollectionType (string) -- [REQUIRED]
Return type

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

Exceptions

  • DevOpsGuru.Client.exceptions.ThrottlingException
  • DevOpsGuru.Client.exceptions.ValidationException
  • DevOpsGuru.Client.exceptions.InternalServerException
  • DevOpsGuru.Client.exceptions.AccessDeniedException
describe_service_integration()

See also: AWS API Documentation

Request Syntax

response = client.describe_service_integration()
Return type
dict
Returns
Response Syntax
{
    'ServiceIntegration': {
        'OpsCenter': {
            'OptInStatus': 'ENABLED'|'DISABLED'
        }
    }
}

Response Structure

  • (dict) --
    • ServiceIntegration (dict) --
      • OpsCenter (dict) --
        • OptInStatus (string) --

Exceptions

  • DevOpsGuru.Client.exceptions.ThrottlingException
  • DevOpsGuru.Client.exceptions.ValidationException
  • DevOpsGuru.Client.exceptions.InternalServerException
  • DevOpsGuru.Client.exceptions.AccessDeniedException
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_resource_collection(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.get_resource_collection(
    NextToken='string',
    ResourceCollectionType='string'
)
Parameters
  • NextToken (string) --
  • ResourceCollectionType (string) -- [REQUIRED]
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • NextToken (string) --
    • ResourceCollection (dict) --
      • CloudFormation (dict) --
        • StackNames (list) --
          • (string) --

Exceptions

  • DevOpsGuru.Client.exceptions.ResourceNotFoundException
  • DevOpsGuru.Client.exceptions.ThrottlingException
  • DevOpsGuru.Client.exceptions.ValidationException
  • DevOpsGuru.Client.exceptions.InternalServerException
  • DevOpsGuru.Client.exceptions.AccessDeniedException
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_anomalies_for_insight(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.list_anomalies_for_insight(
    InsightId='string',
    MaxResults=123,
    NextToken='string',
    StartTimeRange={
        'FromTime': datetime(2015, 1, 1),
        'ToTime': datetime(2015, 1, 1)
    }
)
Parameters
  • InsightId (string) -- [REQUIRED]
  • MaxResults (integer) --
  • NextToken (string) --
  • StartTimeRange (dict) --
    • FromTime (datetime) --
    • ToTime (datetime) --
Return type

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

Exceptions

  • DevOpsGuru.Client.exceptions.ResourceNotFoundException
  • DevOpsGuru.Client.exceptions.ThrottlingException
  • DevOpsGuru.Client.exceptions.ValidationException
  • DevOpsGuru.Client.exceptions.InternalServerException
  • DevOpsGuru.Client.exceptions.AccessDeniedException
list_events(**kwargs)

See also: AWS API Documentation

Request Syntax

response = 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'
)
Parameters
  • Filters (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) --
  • MaxResults (integer) --
  • NextToken (string) --
Return type

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

Exceptions

  • DevOpsGuru.Client.exceptions.ResourceNotFoundException
  • DevOpsGuru.Client.exceptions.ThrottlingException
  • DevOpsGuru.Client.exceptions.ValidationException
  • DevOpsGuru.Client.exceptions.InternalServerException
  • DevOpsGuru.Client.exceptions.AccessDeniedException
list_insights(**kwargs)

See also: AWS API Documentation

Request Syntax

response = 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'
        }
    }
)
Parameters
  • MaxResults (integer) --
  • NextToken (string) --
  • StatusFilter (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]
Return type

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

Exceptions

  • DevOpsGuru.Client.exceptions.ThrottlingException
  • DevOpsGuru.Client.exceptions.ValidationException
  • DevOpsGuru.Client.exceptions.InternalServerException
  • DevOpsGuru.Client.exceptions.AccessDeniedException
list_notification_channels(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.list_notification_channels(
    NextToken='string'
)
Parameters
NextToken (string) --
Return type
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) --

Exceptions

  • DevOpsGuru.Client.exceptions.ThrottlingException
  • DevOpsGuru.Client.exceptions.ValidationException
  • DevOpsGuru.Client.exceptions.InternalServerException
  • DevOpsGuru.Client.exceptions.AccessDeniedException
list_recommendations(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.list_recommendations(
    InsightId='string',
    NextToken='string'
)
Parameters
  • InsightId (string) -- [REQUIRED]
  • NextToken (string) --
Return type

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

Exceptions

  • DevOpsGuru.Client.exceptions.ResourceNotFoundException
  • DevOpsGuru.Client.exceptions.ThrottlingException
  • DevOpsGuru.Client.exceptions.ValidationException
  • DevOpsGuru.Client.exceptions.InternalServerException
  • DevOpsGuru.Client.exceptions.AccessDeniedException
put_feedback(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.put_feedback(
    InsightFeedback={
        'Feedback': 'VALID_COLLECTION'|'RECOMMENDATION_USEFUL'|'ALERT_TOO_SENSITIVE'|'DATA_NOISY_ANOMALY'|'DATA_INCORRECT',
        'Id': 'string'
    }
)
Parameters
InsightFeedback (dict) --
  • Feedback (string) --
  • Id (string) --
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • DevOpsGuru.Client.exceptions.ValidationException
  • DevOpsGuru.Client.exceptions.InternalServerException
  • DevOpsGuru.Client.exceptions.AccessDeniedException
  • DevOpsGuru.Client.exceptions.ResourceNotFoundException
  • DevOpsGuru.Client.exceptions.ThrottlingException
  • DevOpsGuru.Client.exceptions.ConflictException
remove_notification_channel(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.remove_notification_channel(
    Id='string'
)
Parameters
Id (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • DevOpsGuru.Client.exceptions.ValidationException
  • DevOpsGuru.Client.exceptions.InternalServerException
  • DevOpsGuru.Client.exceptions.AccessDeniedException
  • DevOpsGuru.Client.exceptions.ResourceNotFoundException
  • DevOpsGuru.Client.exceptions.ThrottlingException
  • DevOpsGuru.Client.exceptions.ConflictException
search_insights(**kwargs)

See also: AWS API Documentation

Request Syntax

response = 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'
)
Parameters
  • Filters (dict) --
    • ResourceCollection (dict) --
      • CloudFormation (dict) --
        • StackNames (list) --
          • (string) --
    • Severities (list) --
      • (string) --
    • Statuses (list) --
      • (string) --
  • MaxResults (integer) --
  • NextToken (string) --
  • StartTimeRange (dict) --

    [REQUIRED]

    • FromTime (datetime) --
    • ToTime (datetime) --
  • Type (string) -- [REQUIRED]
Return type

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

Exceptions

  • DevOpsGuru.Client.exceptions.ThrottlingException
  • DevOpsGuru.Client.exceptions.ValidationException
  • DevOpsGuru.Client.exceptions.InternalServerException
  • DevOpsGuru.Client.exceptions.AccessDeniedException
update_resource_collection(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.update_resource_collection(
    Action='ADD'|'REMOVE',
    ResourceCollection={
        'CloudFormation': {
            'StackNames': [
                'string',
            ]
        }
    }
)
Parameters
  • Action (string) -- [REQUIRED]
  • ResourceCollection (dict) --

    [REQUIRED]

    • CloudFormation (dict) --
      • StackNames (list) --
        • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • DevOpsGuru.Client.exceptions.ThrottlingException
  • DevOpsGuru.Client.exceptions.ValidationException
  • DevOpsGuru.Client.exceptions.InternalServerException
  • DevOpsGuru.Client.exceptions.ConflictException
  • DevOpsGuru.Client.exceptions.AccessDeniedException
update_service_integration(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.update_service_integration(
    ServiceIntegration={
        'OpsCenter': {
            'OptInStatus': 'ENABLED'|'DISABLED'
        }
    }
)
Parameters
ServiceIntegration (dict) --

[REQUIRED]

  • OpsCenter (dict) --
    • OptInStatus (string) --
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • DevOpsGuru.Client.exceptions.ThrottlingException
  • DevOpsGuru.Client.exceptions.ValidationException
  • DevOpsGuru.Client.exceptions.InternalServerException
  • DevOpsGuru.Client.exceptions.ConflictException
  • DevOpsGuru.Client.exceptions.AccessDeniedException

Paginators

The available paginators are:

class DevOpsGuru.Paginator.DescribeResourceCollectionHealth
paginator = client.get_paginator('describe_resource_collection_health')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DevOpsGuru.Client.describe_resource_collection_health().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ResourceCollectionType='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ResourceCollectionType (string) -- [REQUIRED]
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'CloudFormation': [
        {
            'Insight': {
                'MeanTimeToRecoverInMilliseconds': 123,
                'OpenProactiveInsights': 123,
                'OpenReactiveInsights': 123
            },
            'StackName': 'string'
        },
    ],

}

Response Structure

  • (dict) --
    • CloudFormation (list) --
      • (dict) --
        • Insight (dict) --
          • MeanTimeToRecoverInMilliseconds (integer) --
          • OpenProactiveInsights (integer) --
          • OpenReactiveInsights (integer) --
        • StackName (string) --

class DevOpsGuru.Paginator.GetResourceCollection
paginator = client.get_paginator('get_resource_collection')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DevOpsGuru.Client.get_resource_collection().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ResourceCollectionType='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ResourceCollectionType (string) -- [REQUIRED]
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • ResourceCollection (dict) --
      • CloudFormation (dict) --
        • StackNames (list) --
          • (string) --

class DevOpsGuru.Paginator.ListAnomaliesForInsight
paginator = client.get_paginator('list_anomalies_for_insight')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DevOpsGuru.Client.list_anomalies_for_insight().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InsightId='string',
    StartTimeRange={
        'FromTime': datetime(2015, 1, 1),
        'ToTime': datetime(2015, 1, 1)
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InsightId (string) -- [REQUIRED]
  • StartTimeRange (dict) --
    • FromTime (datetime) --
    • ToTime (datetime) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    '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) --
    • 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) --

class DevOpsGuru.Paginator.ListEvents
paginator = client.get_paginator('list_events')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DevOpsGuru.Client.list_events().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    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',
                ]
            }
        }
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Filters (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) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

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)
        },
    ],

}

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

class DevOpsGuru.Paginator.ListInsights
paginator = client.get_paginator('list_insights')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DevOpsGuru.Client.list_insights().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    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'
        }
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • StatusFilter (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]
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    '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) --
    • 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) --

class DevOpsGuru.Paginator.ListNotificationChannels
paginator = client.get_paginator('list_notification_channels')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DevOpsGuru.Client.list_notification_channels().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Channels': [
        {
            'Config': {
                'Sns': {
                    'TopicArn': 'string'
                }
            },
            'Id': 'string'
        },
    ],

}

Response Structure

  • (dict) --
    • Channels (list) --
      • (dict) --
        • Config (dict) --
          • Sns (dict) --
            • TopicArn (string) --
        • Id (string) --
class DevOpsGuru.Paginator.ListRecommendations
paginator = client.get_paginator('list_recommendations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DevOpsGuru.Client.list_recommendations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InsightId='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • InsightId (string) -- [REQUIRED]
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    '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) --
    • 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) --

class DevOpsGuru.Paginator.SearchInsights
paginator = client.get_paginator('search_insights')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DevOpsGuru.Client.search_insights().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters={
        'ResourceCollection': {
            'CloudFormation': {
                'StackNames': [
                    'string',
                ]
            }
        },
        'Severities': [
            'LOW'|'MEDIUM'|'HIGH',
        ],
        'Statuses': [
            'ONGOING'|'CLOSED',
        ]
    },
    StartTimeRange={
        'FromTime': datetime(2015, 1, 1),
        'ToTime': datetime(2015, 1, 1)
    },
    Type='REACTIVE'|'PROACTIVE',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Filters (dict) --
    • ResourceCollection (dict) --
      • CloudFormation (dict) --
        • StackNames (list) --
          • (string) --
    • Severities (list) --
      • (string) --
    • Statuses (list) --
      • (string) --
  • StartTimeRange (dict) --

    [REQUIRED]

    • FromTime (datetime) --
    • ToTime (datetime) --
  • Type (string) -- [REQUIRED]
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    '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) --
    • 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) --