Class: Aws::Health::Types::Event

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-health/lib/aws-sdk-health/types.rb

Overview

Summary information about an Health event.

Health events can be public or account-specific:

  • Public events might be service events that are not specific to an Amazon Web Services account. For example, if there is an issue with an Amazon Web Services Region, Health provides information about the event, even if you don't use services or resources in that Region.

  • Account-specific events are specific to either your Amazon Web Services account or an account in your organization. For example, if there's an issue with Amazon Elastic Compute Cloud in a Region that you use, Health provides information about the event and the affected resources in the account.

You can determine if an event is public or account-specific by using the eventScopeCode parameter. For more information, see eventScopeCode.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.

For example, an event ARN might look like the following:

arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

Returns:

  • (String)


1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1072

class Event < Struct.new(
  :arn,
  :service,
  :event_type_code,
  :event_type_category,
  :region,
  :availability_zone,
  :start_time,
  :end_time,
  :last_updated_time,
  :status_code,
  :event_scope_code)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zoneString

The Amazon Web Services Availability Zone of the event. For example, us-east-1a.

Returns:

  • (String)


1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1072

class Event < Struct.new(
  :arn,
  :service,
  :event_type_code,
  :event_type_category,
  :region,
  :availability_zone,
  :start_time,
  :end_time,
  :last_updated_time,
  :status_code,
  :event_scope_code)
  SENSITIVE = []
  include Aws::Structure
end

#end_timeTime

The date and time that the event ended.

Returns:

  • (Time)


1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1072

class Event < Struct.new(
  :arn,
  :service,
  :event_type_code,
  :event_type_category,
  :region,
  :availability_zone,
  :start_time,
  :end_time,
  :last_updated_time,
  :status_code,
  :event_scope_code)
  SENSITIVE = []
  include Aws::Structure
end

#event_scope_codeString

This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.

  • If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty.

  • If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response.

  • If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.

Returns:

  • (String)


1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1072

class Event < Struct.new(
  :arn,
  :service,
  :event_type_code,
  :event_type_category,
  :region,
  :availability_zone,
  :start_time,
  :end_time,
  :last_updated_time,
  :status_code,
  :event_scope_code)
  SENSITIVE = []
  include Aws::Structure
end

#event_type_categoryString

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)


1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1072

class Event < Struct.new(
  :arn,
  :service,
  :event_type_code,
  :event_type_category,
  :region,
  :availability_zone,
  :start_time,
  :end_time,
  :last_updated_time,
  :status_code,
  :event_scope_code)
  SENSITIVE = []
  include Aws::Structure
end

#event_type_codeString

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

Returns:

  • (String)


1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1072

class Event < Struct.new(
  :arn,
  :service,
  :event_type_code,
  :event_type_category,
  :region,
  :availability_zone,
  :start_time,
  :end_time,
  :last_updated_time,
  :status_code,
  :event_scope_code)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_timeTime

The most recent date and time that the event was updated.

Returns:

  • (Time)


1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1072

class Event < Struct.new(
  :arn,
  :service,
  :event_type_code,
  :event_type_category,
  :region,
  :availability_zone,
  :start_time,
  :end_time,
  :last_updated_time,
  :status_code,
  :event_scope_code)
  SENSITIVE = []
  include Aws::Structure
end

#regionString

The Amazon Web Services Region name of the event.

Returns:

  • (String)


1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1072

class Event < Struct.new(
  :arn,
  :service,
  :event_type_code,
  :event_type_category,
  :region,
  :availability_zone,
  :start_time,
  :end_time,
  :last_updated_time,
  :status_code,
  :event_scope_code)
  SENSITIVE = []
  include Aws::Structure
end

#serviceString

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

Returns:

  • (String)


1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1072

class Event < Struct.new(
  :arn,
  :service,
  :event_type_code,
  :event_type_category,
  :region,
  :availability_zone,
  :start_time,
  :end_time,
  :last_updated_time,
  :status_code,
  :event_scope_code)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

The date and time that the event began.

Returns:

  • (Time)


1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1072

class Event < Struct.new(
  :arn,
  :service,
  :event_type_code,
  :event_type_category,
  :region,
  :availability_zone,
  :start_time,
  :end_time,
  :last_updated_time,
  :status_code,
  :event_scope_code)
  SENSITIVE = []
  include Aws::Structure
end

#status_codeString

The most recent status of the event. Possible values are open, closed, and upcoming.

Returns:

  • (String)


1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 1072

class Event < Struct.new(
  :arn,
  :service,
  :event_type_code,
  :event_type_category,
  :region,
  :availability_zone,
  :start_time,
  :end_time,
  :last_updated_time,
  :status_code,
  :event_scope_code)
  SENSITIVE = []
  include Aws::Structure
end