2022/10/20 - Amazon DevOps Guru - 4 updated api methods
Changes This release adds information about the resources DevOps Guru is analyzing.
{'AnalyzedResourceCount': 'long'}
Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your Amazon Web Services account. Use these numbers to gauge the health of operations in your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.describe_account_health()
dict
Response Syntax
{
'OpenReactiveInsights': 123,
'OpenProactiveInsights': 123,
'MetricsAnalyzed': 123,
'ResourceHours': 123,
'AnalyzedResourceCount': 123
}
Response Structure
(dict) --
OpenReactiveInsights (integer) --
An integer that specifies the number of open reactive insights in your Amazon Web Services account.
OpenProactiveInsights (integer) --
An integer that specifies the number of open proactive insights in your Amazon Web Services account.
MetricsAnalyzed (integer) --
An integer that specifies the number of metrics that have been analyzed in your Amazon Web Services account.
ResourceHours (integer) --
The number of Amazon DevOps Guru resource analysis hours billed to the current Amazon Web Services account in the last hour.
AnalyzedResourceCount (integer) --
Number of resources that DevOps Guru is monitoring in your Amazon Web Services account.
{'CloudFormation': {'AnalyzedResourceCount': 'long'},
'Service': {'AnalyzedResourceCount': 'long'},
'Tags': {'AnalyzedResourceCount': 'long'}}
Provides an overview of your system's health. If additional member accounts are part of your organization, you can filter those accounts using the AccountIds field.
See also: AWS API Documentation
Request Syntax
client.describe_organization_resource_collection_health(
OrganizationResourceCollectionType='AWS_CLOUD_FORMATION'|'AWS_SERVICE'|'AWS_ACCOUNT'|'AWS_TAGS',
AccountIds=[
'string',
],
OrganizationalUnitIds=[
'string',
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.
list
The ID of the Amazon Web Services account.
(string) --
list
The ID of the organizational unit.
(string) --
string
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
dict
Response Syntax
{
'CloudFormation': [
{
'StackName': 'string',
'Insight': {
'OpenProactiveInsights': 123,
'OpenReactiveInsights': 123,
'MeanTimeToRecoverInMilliseconds': 123
},
'AnalyzedResourceCount': 123
},
],
'Service': [
{
'ServiceName': 'API_GATEWAY'|'APPLICATION_ELB'|'AUTO_SCALING_GROUP'|'CLOUD_FRONT'|'DYNAMO_DB'|'EC2'|'ECS'|'EKS'|'ELASTIC_BEANSTALK'|'ELASTI_CACHE'|'ELB'|'ES'|'KINESIS'|'LAMBDA'|'NAT_GATEWAY'|'NETWORK_ELB'|'RDS'|'REDSHIFT'|'ROUTE_53'|'S3'|'SAGE_MAKER'|'SNS'|'SQS'|'STEP_FUNCTIONS'|'SWF',
'Insight': {
'OpenProactiveInsights': 123,
'OpenReactiveInsights': 123
},
'AnalyzedResourceCount': 123
},
],
'Account': [
{
'AccountId': 'string',
'Insight': {
'OpenProactiveInsights': 123,
'OpenReactiveInsights': 123
}
},
],
'NextToken': 'string',
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValue': 'string',
'Insight': {
'OpenProactiveInsights': 123,
'OpenReactiveInsights': 123,
'MeanTimeToRecoverInMilliseconds': 123
},
'AnalyzedResourceCount': 123
},
]
}
Response Structure
(dict) --
CloudFormation (list) --
The returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with the requested system health information.
(dict) --
Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services CloudFormation stack.
StackName (string) --
The name of the CloudFormation stack.
Insight (dict) --
Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services CloudFormation stack, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.
OpenProactiveInsights (integer) --
The number of open proactive insights.
OpenReactiveInsights (integer) --
The number of open reactive insights.
MeanTimeToRecoverInMilliseconds (integer) --
The Meant Time to Recover (MTTR) for the insight.
AnalyzedResourceCount (integer) --
Number of resources that DevOps Guru is monitoring in your account that are specified by an Amazon Web Services CloudFormation stack.
Service (list) --
An array of ServiceHealth objects that describes the health of the Amazon Web Services services associated with the resources in the collection.
(dict) --
Represents the health of an Amazon Web Services service.
ServiceName (string) --
The name of the Amazon Web Services service.
Insight (dict) --
Represents the health of an Amazon Web Services service. This is a ServiceInsightHealth that contains the number of open proactive and reactive insights for this service.
OpenProactiveInsights (integer) --
The number of open proactive insights in the Amazon Web Services service
OpenReactiveInsights (integer) --
The number of open reactive insights in the Amazon Web Services service
AnalyzedResourceCount (integer) --
Number of resources that DevOps Guru is monitoring in an analyzed Amazon Web Services service.
Account (list) --
The name of the organization's account.
(dict) --
Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your Amazon Web Services account. Use these numbers to gauge the health of operations in your Amazon Web Services account.
AccountId (string) --
The ID of the Amazon Web Services account.
Insight (dict) --
Information about the health of the Amazon Web Services resources in your account, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.
OpenProactiveInsights (integer) --
An integer that specifies the number of open proactive insights in your Amazon Web Services account.
OpenReactiveInsights (integer) --
An integer that specifies the number of open reactive insights in your Amazon Web Services account.
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
Tags (list) --
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
(dict) --
Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services tag key.
AppBoundaryKey (string) --
An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
TagValue (string) --
The value in an Amazon Web Services tag.
The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.
Insight (dict) --
Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services tag, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.
OpenProactiveInsights (integer) --
The number of open proactive insights.
OpenReactiveInsights (integer) --
The number of open reactive insights.
MeanTimeToRecoverInMilliseconds (integer) --
The Meant Time to Recover (MTTR) for the insight.
AnalyzedResourceCount (integer) --
Number of resources that DevOps Guru is monitoring in your account that are specified by an Amazon Web Services tag.
{'CloudFormation': {'AnalyzedResourceCount': 'long'},
'Service': {'AnalyzedResourceCount': 'long'},
'Tags': {'AnalyzedResourceCount': 'long'}}
Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in resource collections in your account. You specify the type of Amazon Web Services resources collection. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.
See also: AWS API Documentation
Request Syntax
client.describe_resource_collection_health(
ResourceCollectionType='AWS_CLOUD_FORMATION'|'AWS_SERVICE'|'AWS_TAGS',
NextToken='string'
)
string
[REQUIRED]
An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.
string
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
dict
Response Syntax
{
'CloudFormation': [
{
'StackName': 'string',
'Insight': {
'OpenProactiveInsights': 123,
'OpenReactiveInsights': 123,
'MeanTimeToRecoverInMilliseconds': 123
},
'AnalyzedResourceCount': 123
},
],
'Service': [
{
'ServiceName': 'API_GATEWAY'|'APPLICATION_ELB'|'AUTO_SCALING_GROUP'|'CLOUD_FRONT'|'DYNAMO_DB'|'EC2'|'ECS'|'EKS'|'ELASTIC_BEANSTALK'|'ELASTI_CACHE'|'ELB'|'ES'|'KINESIS'|'LAMBDA'|'NAT_GATEWAY'|'NETWORK_ELB'|'RDS'|'REDSHIFT'|'ROUTE_53'|'S3'|'SAGE_MAKER'|'SNS'|'SQS'|'STEP_FUNCTIONS'|'SWF',
'Insight': {
'OpenProactiveInsights': 123,
'OpenReactiveInsights': 123
},
'AnalyzedResourceCount': 123
},
],
'NextToken': 'string',
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValue': 'string',
'Insight': {
'OpenProactiveInsights': 123,
'OpenReactiveInsights': 123,
'MeanTimeToRecoverInMilliseconds': 123
},
'AnalyzedResourceCount': 123
},
]
}
Response Structure
(dict) --
CloudFormation (list) --
The returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with the requested system health information.
(dict) --
Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services CloudFormation stack.
StackName (string) --
The name of the CloudFormation stack.
Insight (dict) --
Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services CloudFormation stack, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.
OpenProactiveInsights (integer) --
The number of open proactive insights.
OpenReactiveInsights (integer) --
The number of open reactive insights.
MeanTimeToRecoverInMilliseconds (integer) --
The Meant Time to Recover (MTTR) for the insight.
AnalyzedResourceCount (integer) --
Number of resources that DevOps Guru is monitoring in your account that are specified by an Amazon Web Services CloudFormation stack.
Service (list) --
An array of ServiceHealth objects that describes the health of the Amazon Web Services services associated with the resources in the collection.
(dict) --
Represents the health of an Amazon Web Services service.
ServiceName (string) --
The name of the Amazon Web Services service.
Insight (dict) --
Represents the health of an Amazon Web Services service. This is a ServiceInsightHealth that contains the number of open proactive and reactive insights for this service.
OpenProactiveInsights (integer) --
The number of open proactive insights in the Amazon Web Services service
OpenReactiveInsights (integer) --
The number of open reactive insights in the Amazon Web Services service
AnalyzedResourceCount (integer) --
Number of resources that DevOps Guru is monitoring in an analyzed Amazon Web Services service.
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
(dict) --
Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services tag key.
AppBoundaryKey (string) --
An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
TagValue (string) --
The value in an Amazon Web Services tag.
The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.
Insight (dict) --
Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services tag, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.
OpenProactiveInsights (integer) --
The number of open proactive insights.
OpenReactiveInsights (integer) --
The number of open reactive insights.
MeanTimeToRecoverInMilliseconds (integer) --
The Meant Time to Recover (MTTR) for the insight.
AnalyzedResourceCount (integer) --
Number of resources that DevOps Guru is monitoring in your account that are specified by an Amazon Web Services tag.
{'Filters': {'ResourceTypeFilters': {'CLOUDFRONT_DISTRIBUTION',
'DYNAMODB_TABLE',
'EC2_NAT_GATEWAY',
'ECS_CLUSTER',
'ECS_SERVICE',
'EKS_CLUSTER',
'ELASTICACHE_CACHE_CLUSTER',
'ELASTICSEARCH_DOMAIN',
'ELASTIC_BEANSTALK_ENVIRONMENT',
'ELASTIC_LOAD_BALANCER_LOAD_BALANCER',
'ELASTIC_LOAD_BALANCING_V2_LOAD_BALANCER',
'ELASTIC_LOAD_BALANCING_V2_TARGET_GROUP',
'KINESIS_STREAM',
'LAMBDA_FUNCTION',
'OPEN_SEARCH_SERVICE_DOMAIN',
'RDS_DB_CLUSTER',
'RDS_DB_INSTANCE',
'REDSHIFT_CLUSTER',
'ROUTE53_HEALTH_CHECK',
'ROUTE53_HOSTED_ZONE',
'S3_BUCKET',
'SAGEMAKER_ENDPOINT',
'SNS_TOPIC',
'SQS_QUEUE',
'STEP_FUNCTIONS_ACTIVITY',
'STEP_FUNCTIONS_STATE_MACHINE'}}}
Response {'MonitoredResourceIdentifiers': {'LastUpdated': 'timestamp',
'ResourceCollection': {'CloudFormation': {'StackNames': ['string']},
'Tags': [{'AppBoundaryKey': 'string',
'TagValues': ['string']}]}}}
Returns the list of all log groups that are being monitored and tagged by DevOps Guru.
See also: AWS API Documentation
Request Syntax
client.list_monitored_resources(
Filters={
'ResourcePermission': 'FULL_PERMISSION'|'MISSING_PERMISSION',
'ResourceTypeFilters': [
'LOG_GROUPS'|'CLOUDFRONT_DISTRIBUTION'|'DYNAMODB_TABLE'|'EC2_NAT_GATEWAY'|'ECS_CLUSTER'|'ECS_SERVICE'|'EKS_CLUSTER'|'ELASTIC_BEANSTALK_ENVIRONMENT'|'ELASTIC_LOAD_BALANCER_LOAD_BALANCER'|'ELASTIC_LOAD_BALANCING_V2_LOAD_BALANCER'|'ELASTIC_LOAD_BALANCING_V2_TARGET_GROUP'|'ELASTICACHE_CACHE_CLUSTER'|'ELASTICSEARCH_DOMAIN'|'KINESIS_STREAM'|'LAMBDA_FUNCTION'|'OPEN_SEARCH_SERVICE_DOMAIN'|'RDS_DB_INSTANCE'|'RDS_DB_CLUSTER'|'REDSHIFT_CLUSTER'|'ROUTE53_HOSTED_ZONE'|'ROUTE53_HEALTH_CHECK'|'S3_BUCKET'|'SAGEMAKER_ENDPOINT'|'SNS_TOPIC'|'SQS_QUEUE'|'STEP_FUNCTIONS_ACTIVITY'|'STEP_FUNCTIONS_STATE_MACHINE',
]
},
MaxResults=123,
NextToken='string'
)
dict
Filters to determine which monitored resources you want to retrieve. You can filter by resource type or resource permission status.
ResourcePermission (string) -- [REQUIRED]
The permission status of a resource.
ResourceTypeFilters (list) -- [REQUIRED]
The type of resource that you wish to retrieve, such as log groups.
(string) --
integer
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
string
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
dict
Response Syntax
{
'MonitoredResourceIdentifiers': [
{
'MonitoredResourceName': 'string',
'Type': 'string',
'ResourcePermission': 'FULL_PERMISSION'|'MISSING_PERMISSION',
'LastUpdated': datetime(2015, 1, 1),
'ResourceCollection': {
'CloudFormation': {
'StackNames': [
'string',
]
},
'Tags': [
{
'AppBoundaryKey': 'string',
'TagValues': [
'string',
]
},
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
MonitoredResourceIdentifiers (list) --
Information about the resource that is being monitored, including the name of the resource, the type of resource, and whether or not permission is given to DevOps Guru to access that resource.
(dict) --
Information about the resource that is being monitored, including the name of the resource, the type of resource, and whether or not permission is given to DevOps Guru to access that resource.
MonitoredResourceName (string) --
The name of the resource being monitored.
Type (string) --
The type of resource being monitored.
ResourcePermission (string) --
The permission status of a resource.
LastUpdated (datetime) --
The time at which DevOps Guru last updated this resource.
ResourceCollection (dict) --
A collection of Amazon Web Services resources supported by DevOps Guru. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.
CloudFormation (dict) --
An array of the names of Amazon Web Services CloudFormation stacks. The stacks define Amazon Web Services resources that DevOps Guru analyzes. You can specify up to 500 Amazon Web Services CloudFormation stacks.
StackNames (list) --
An array of CloudFormation stack names.
(string) --
Tags (list) --
The Amazon Web Services tags that are used by resources in the resource collection.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
(dict) --
A collection of Amazon Web Services tags.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
AppBoundaryKey (string) --
An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
TagValues (list) --
The values in an Amazon Web Services tag collection.
The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.
(string) --
NextToken (string) --
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.