Class: Aws::Health::Types::OrganizationEvent

Inherits:

Struct

• Object
• Struct
• Aws::Health::Types::OrganizationEvent

Includes:

Structure

Defined in:

lib/aws-sdk-health/types.rb

Overview

Summary information about an event, returned by the

DescribeEventsForOrganization][1

operation.

[1]: docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The unique identifier for the event.

• #end_time ⇒ Time

  The date and time that the event ended.

• #event_scope_code ⇒ String

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

• #event_type_category ⇒ String

  A list of event type category codes.

• #event_type_code ⇒ String

  The unique identifier for the event type.

• #last_updated_time ⇒ Time

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

• #region ⇒ String

  The Amazon Web Services Region name of the event.

• #service ⇒ String

  The Amazon Web Services service that is affected by the event, such as EC2 and RDS.

• #start_time ⇒ Time

  The date and time that the event began.

• #status_code ⇒ String

  The most recent status of the event.

Instance Attribute Details

#arn ⇒ String

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)

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

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

#end_time ⇒ Time

The date and time that the event ended.

Returns:

• (Time)

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

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

#event_scope_code ⇒ String

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)

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

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

#event_type_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 1452

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

#event_type_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 1452

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

#last_updated_time ⇒ Time

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

Returns:

• (Time)

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

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

#region ⇒ String

The Amazon Web Services Region name of the event.

Returns:

• (String)

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

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

#service ⇒ String

The Amazon Web Services service that is affected by the event, such as EC2 and RDS.

Returns:

• (String)

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

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

#start_time ⇒ Time

The date and time that the event began.

Returns:

• (Time)

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

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

#status_code ⇒ String

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

Returns:

• (String)

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

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