Amazon DevOps Guru

{'Config': {'Filters': {'MessageTypes': ['NEW_INSIGHT | CLOSED_INSIGHT | '
                                         'NEW_ASSOCIATION | SEVERITY_UPGRADED '
                                         '| NEW_RECOMMENDATION'],
                        'Severities': ['LOW | MEDIUM | HIGH']}}}

Adds a notification channel to DevOps Guru. A notification channel is used to notify you about important DevOps Guru events, such as when an insight is generated.

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for cross account Amazon SNS topics.

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.

If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics.

See also: AWS API Documentation

Request Syntax

client.add_notification_channel(
    Config={
        'Sns': {
            'TopicArn': 'string'
        },
        'Filters': {
            'Severities': [
                'LOW'|'MEDIUM'|'HIGH',
            ],
            'MessageTypes': [
                'NEW_INSIGHT'|'CLOSED_INSIGHT'|'NEW_ASSOCIATION'|'SEVERITY_UPGRADED'|'NEW_RECOMMENDATION',
            ]
        }
    }
)

type Config:

dict

param Config:

[REQUIRED]

A NotificationChannelConfig object that specifies what type of notification channel to add. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).

• Sns (dict) -- [REQUIRED]

  Information about a notification channel configured in DevOps Guru to send notifications when insights are created.

  If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for cross account Amazon SNS topics.

  If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.

  If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics.

  • TopicArn (string) --

    The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.

• Filters (dict) --

  The filter configurations for the Amazon SNS notification topic you use with DevOps Guru. If you do not provide filter configurations, the default configurations are to receive notifications for all message types of High or Medium severity.

  • Severities (list) --

    The severity levels that you want to receive notifications for. For example, you can choose to receive notifications only for insights with HIGH and MEDIUM severity levels. For more information, see Understanding insight severities.

    • (string) --

  • MessageTypes (list) --

    The events that you want to receive notifications for. For example, you can choose to receive notifications only when the severity level is upgraded or a new insight is created.

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'Id': 'string'
}

Response Structure

• (dict) --

  • Id (string) --

    The ID of the added notification channel.

{'Channels': {'Config': {'Filters': {'MessageTypes': ['NEW_INSIGHT | '
                                                      'CLOSED_INSIGHT | '
                                                      'NEW_ASSOCIATION | '
                                                      'SEVERITY_UPGRADED | '
                                                      'NEW_RECOMMENDATION'],
                                     'Severities': ['LOW | MEDIUM | HIGH']}}}}

Returns a list of notification channels configured for DevOps Guru. Each notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).

See also: AWS API Documentation

Request Syntax

client.list_notification_channels(
    NextToken='string'
)

type NextToken:

string

param NextToken:

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.

rtype:

dict

returns:

Response Syntax

{
    'Channels': [
        {
            'Id': 'string',
            'Config': {
                'Sns': {
                    'TopicArn': 'string'
                },
                'Filters': {
                    'Severities': [
                        'LOW'|'MEDIUM'|'HIGH',
                    ],
                    'MessageTypes': [
                        'NEW_INSIGHT'|'CLOSED_INSIGHT'|'NEW_ASSOCIATION'|'SEVERITY_UPGRADED'|'NEW_RECOMMENDATION',
                    ]
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Channels (list) --

    An array that contains the requested notification channels.

    • (dict) --

      Information about a notification channel. A notification channel is used to notify you when DevOps Guru creates an insight. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).

      If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for cross account Amazon SNS topics.

      If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.

      If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics.

      • Id (string) --

        The ID of a notification channel.

      • Config (dict) --

        A NotificationChannelConfig object that contains information about configured notification channels.

        • Sns (dict) --

          Information about a notification channel configured in DevOps Guru to send notifications when insights are created.

          If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for cross account Amazon SNS topics.

          If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.

          If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics.

          • TopicArn (string) --

            The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.

        • Filters (dict) --

          The filter configurations for the Amazon SNS notification topic you use with DevOps Guru. If you do not provide filter configurations, the default configurations are to receive notifications for all message types of High or Medium severity.

          • Severities (list) --

            The severity levels that you want to receive notifications for. For example, you can choose to receive notifications only for insights with HIGH and MEDIUM severity levels. For more information, see Understanding insight severities.

            • (string) --

          • MessageTypes (list) --

            The events that you want to receive notifications for. For example, you can choose to receive notifications only when the severity level is upgraded or a new insight is created.

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