AutoScaling / Client / describe_notification_configurations

describe_notification_configurations

AutoScaling.Client.describe_notification_configurations(**kwargs)

Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.

See also: AWS API Documentation

Request Syntax

response = client.describe_notification_configurations(
    AutoScalingGroupNames=[
        'string',
    ],
    NextToken='string',
    MaxRecords=123
)
Parameters:

  • AutoScalingGroupNames (list) –

    The name of the Auto Scaling group.

    • (string) –

  • NextToken (string) – The token for the next set of items to return. (You received this token from a previous call.)

  • MaxRecords (integer) – The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

Return type:

dict

Returns:

Response Syntax

{
    'NotificationConfigurations': [
        {
            'AutoScalingGroupName': 'string',
            'TopicARN': 'string',
            'NotificationType': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • NotificationConfigurations (list) –

      The notification configurations.

      • (dict) –

        Describes a notification.

        • AutoScalingGroupName (string) –

          The name of the Auto Scaling group.

        • TopicARN (string) –

          The Amazon Resource Name (ARN) of the Amazon SNS topic.

        • NotificationType (string) –

          One of the following event notification types:

          • autoscaling:EC2_INSTANCE_LAUNCH

          • autoscaling:EC2_INSTANCE_LAUNCH_ERROR

          • autoscaling:EC2_INSTANCE_TERMINATE

          • autoscaling:EC2_INSTANCE_TERMINATE_ERROR

          • autoscaling:TEST_NOTIFICATION

    • NextToken (string) –

      A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

Exceptions

Examples

This example describes the notification configurations for the specified Auto Scaling group.

response = client.describe_notification_configurations(
    AutoScalingGroupNames=[
        'my-auto-scaling-group',
    ],
)

print(response)

Expected Output:

{
    'NotificationConfigurations': [
        {
            'AutoScalingGroupName': 'my-auto-scaling-group',
            'NotificationType': 'autoscaling:TEST_NOTIFICATION',
            'TopicARN': 'arn:aws:sns:us-west-2:123456789012:my-sns-topic-2',
        },
        {
            'AutoScalingGroupName': 'my-auto-scaling-group',
            'NotificationType': 'autoscaling:TEST_NOTIFICATION',
            'TopicARN': 'arn:aws:sns:us-west-2:123456789012:my-sns-topic',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}