PutNotificationConfiguration
Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.
This configuration overwrites any existing configuration.
For more information see Getting SNS Notifications When Your Auto Scaling Group Scales in the Auto Scaling User Guide.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- AutoScalingGroupName
-
The name of the Auto Scaling group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: Yes
- NotificationTypes.member.N
-
The type of event that will cause the notification to be sent. For details about notification types supported by Amazon EC2 Auto Scaling, see DescribeAutoScalingNotificationTypes.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: Yes
- TopicARN
-
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: Yes
Errors
For information about the errors that are common to all actions, see Common Errors.
- LimitExceeded
-
You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.
HTTP Status Code: 400
- ResourceContention
-
You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).
HTTP Status Code: 500
- ServiceLinkedRoleFailure
-
The service-linked role is not yet ready for use.
HTTP Status Code: 500
Example
Sample Request
https://autoscaling.amazonaws.com/?Action=PutNotificationConfiguration &AutoScalingGroupName=my-asg &TopicARN=arn:aws:us-east-1:123456789012:my-sns-topic &NotificationTypes.member.1=autoscaling:EC2_INSTANCE_LAUNCH &Version=2011-01-01 &AUTHPARAMS
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
