DevOpsGuru / Client / describe_organization_resource_collection_health

describe_organization_resource_collection_health#

DevOpsGuru.Client.describe_organization_resource_collection_health(**kwargs)#

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

response = client.describe_organization_resource_collection_health(
    OrganizationResourceCollectionType='AWS_CLOUD_FORMATION'|'AWS_SERVICE'|'AWS_ACCOUNT'|'AWS_TAGS',
    AccountIds=[
        'string',
    ],
    OrganizationalUnitIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)
Parameters:

  • OrganizationResourceCollectionType (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.

  • AccountIds (list) –

    The ID of the Amazon Web Services account.

    • (string) –

  • OrganizationalUnitIds (list) –

    The ID of the organizational unit.

    • (string) –

  • NextToken (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.

  • MaxResults (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.

Return type:

dict

Returns:

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.

      Warning

      The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

      • (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.

          Warning

          The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

        • 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.

Exceptions