Class: Aws::Health::Types::EventType

Inherits:

Struct

• Object
• Struct
• Aws::Health::Types::EventType

Includes:

Structure

Defined in:

lib/aws-sdk-health/types.rb

Overview

Contains the metadata about a type of event that is reported by Health. The ‘EventType` shows the category, service, and the event type code of the event. For example, an `issue` might be the category, `EC2` the service, and `AWS_EC2_SYSTEM_MAINTENANCE_EVENT` the event type code.

You can use the [DescribeEventTypes] API operation to return this information about an event.

You can also use the Amazon CloudWatch Events console to create a rule so that you can get notified or take action when Health delivers a specific event to your Amazon Web Services account. For more information, see [Monitor for Health events with Amazon CloudWatch Events] in the *Health User Guide*.

[1]: docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html [2]: docs.aws.amazon.com/health/latest/ug/cloudwatch-events-health.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #actionability ⇒ String

  The actionability classification of the event.

• #category ⇒ String

  A list of event type category codes.

• #code ⇒ String

  The unique identifier for the event type.

• #personas ⇒ Array<String>

  A list of persona classifications that indicate the target audience for the event.

• #service ⇒ String

  The Amazon Web Services service that is affected by the event.

Instance Attribute Details

#actionability ⇒ String

The actionability classification of the event. Possible values are ‘ACTION_REQUIRED`, `ACTION_MAY_BE_REQUIRED` and `INFORMATIONAL`. Events with `ACTION_REQUIRED` actionability require customer action to resolve or mitigate the event. Events with `ACTION_MAY_BE_REQUIRED` actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required. Events with `INFORMATIONAL` actionability are provided for awareness and do not require immediate action.

Returns:

• (String)

# File 'lib/aws-sdk-health/types.rb', line 1296

class EventType < Struct.new(
  :service,
  :code,
  :category,
  :actionability,
  :personas)
  SENSITIVE = []
  include Aws::Structure
end

#category ⇒ String

A list of event type category codes. Possible values are ‘issue`, `accountNotification`, or `scheduledChange`. Currently, the `investigation` value isn’t supported at this time.

Returns:

• (String)

# File 'lib/aws-sdk-health/types.rb', line 1296

class EventType < Struct.new(
  :service,
  :code,
  :category,
  :actionability,
  :personas)
  SENSITIVE = []
  include Aws::Structure
end

#code ⇒ String

The unique identifier for the event type. The format is ‘AWS_SERVICE_DESCRIPTION `; for example, `AWS_EC2_SYSTEM_MAINTENANCE_EVENT`.

Returns:

• (String)

# File 'lib/aws-sdk-health/types.rb', line 1296

class EventType < Struct.new(
  :service,
  :code,
  :category,
  :actionability,
  :personas)
  SENSITIVE = []
  include Aws::Structure
end

#personas ⇒ Array<String>

A list of persona classifications that indicate the target audience for the event. Possible values are ‘OPERATIONS`, `SECURITY`, and `BILLING`. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-health/types.rb', line 1296

class EventType < Struct.new(
  :service,
  :code,
  :category,
  :actionability,
  :personas)
  SENSITIVE = []
  include Aws::Structure
end

#service ⇒ String

The Amazon Web Services service that is affected by the event. For example, ‘EC2`, `RDS`.

Returns:

• (String)

# File 'lib/aws-sdk-health/types.rb', line 1296

class EventType < Struct.new(
  :service,
  :code,
  :category,
  :actionability,
  :personas)
  SENSITIVE = []
  include Aws::Structure
end