Class: Aws::SSM::Types::NotificationConfig

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass NotificationConfig data as a hash:

{
  notification_arn: "NotificationArn",
  notification_events: ["All"], # accepts All, InProgress, Success, TimedOut, Cancelled, Failed
  notification_type: "Command", # accepts Command, Invocation
}

Configurations for sending notifications.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#notification_arn ⇒ String

An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.

Returns:

  • (String) 


9670
9671
9672
9673
9674
9675
 
# File 'lib/aws-sdk-ssm/types.rb', line 9670

class NotificationConfig < Struct.new(
  :notification_arn,
  :notification_events,
  :notification_type)
  include Aws::Structure
end

#notification_events ⇒ Array<String>

The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see

Configuring Amazon SNS Notifications for Run Command][1

in the

*AWS Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/rc-sns-notifications.html

Returns:

  • (Array<String>) 


9670
9671
9672
9673
9674
9675
 
# File 'lib/aws-sdk-ssm/types.rb', line 9670

class NotificationConfig < Struct.new(
  :notification_arn,
  :notification_events,
  :notification_type)
  include Aws::Structure
end

#notification_type ⇒ String

Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.

Returns:

  • (String) 


9670
9671
9672
9673
9674
9675
 
# File 'lib/aws-sdk-ssm/types.rb', line 9670

class NotificationConfig < Struct.new(
  :notification_arn,
  :notification_events,
  :notification_type)
  include Aws::Structure
end