DevOpsGuru / Client / describe_service_integration

describe_service_integration#

DevOpsGuru.Client.describe_service_integration()#

Returns the integration status of services that are integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon Web Services Systems Manager, which can be used to create an OpsItem for each generated insight.

See also: AWS API Documentation

Request Syntax

response = client.describe_service_integration()
Return type:

dict

Returns:

Response Syntax

{
    'ServiceIntegration': {
        'OpsCenter': {
            'OptInStatus': 'ENABLED'|'DISABLED'
        },
        'LogsAnomalyDetection': {
            'OptInStatus': 'ENABLED'|'DISABLED'
        },
        'KMSServerSideEncryption': {
            'KMSKeyId': 'string',
            'OptInStatus': 'ENABLED'|'DISABLED',
            'Type': 'CUSTOMER_MANAGED_KEY'|'AWS_OWNED_KMS_KEY'
        }
    }
}

Response Structure

  • (dict) –

    • ServiceIntegration (dict) –

      Information about the integration of DevOps Guru with another Amazon Web Services service, such as Amazon Web Services Systems Manager.

      • OpsCenter (dict) –

        Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager OpsCenter for each created insight.

        • OptInStatus (string) –

          Specifies if DevOps Guru is enabled to create an Amazon Web Services Systems Manager OpsItem for each created insight.

      • LogsAnomalyDetection (dict) –

        Information about whether DevOps Guru is configured to perform log anomaly detection on Amazon CloudWatch log groups.

        • OptInStatus (string) –

          Specifies if DevOps Guru is configured to perform log anomaly detection on CloudWatch log groups.

      • KMSServerSideEncryption (dict) –

        Information about whether DevOps Guru is configured to encrypt server-side data using KMS.

        • KMSKeyId (string) –

          Describes the specified KMS key.

          To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with “alias/”. If you specify a predefined Amazon Web Services alias (an Amazon Web Services alias with no key ID), Amazon Web Services KMS associates the alias with an Amazon Web Services managed key and returns its KeyId and Arn in the response. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

          For example:

          Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

          Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

          Alias name: alias/ExampleAlias

          Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

        • OptInStatus (string) –

          Specifies if DevOps Guru is enabled for customer managed keys.

        • Type (string) –

          The type of KMS key used. Customer managed keys are the KMS keys that you create. Amazon Web Services owned keys are keys that are owned and managed by DevOps Guru.

Exceptions

  • DevOpsGuru.Client.exceptions.AccessDeniedException

  • DevOpsGuru.Client.exceptions.InternalServerException

  • DevOpsGuru.Client.exceptions.ResourceNotFoundException

  • DevOpsGuru.Client.exceptions.ThrottlingException

  • DevOpsGuru.Client.exceptions.ValidationException