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

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

Overview

Summary information about an event, returned by the DescribeEventsForOrganization operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

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)


2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 2008

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,
  :actionability,
  :personas)
  SENSITIVE = []
  include Aws::Structure
end

#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)


2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 2008

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,
  :actionability,
  :personas)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The date and time that the event ended.

Returns:

  • (Time)


2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 2008

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,
  :actionability,
  :personas)
  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)


2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 2008

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,
  :actionability,
  :personas)
  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)


2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 2008

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,
  :actionability,
  :personas)
  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)


2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 2008

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,
  :actionability,
  :personas)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_time ⇒ Time

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

Returns:

  • (Time)


2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 2008

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,
  :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>)


2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 2008

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,
  :actionability,
  :personas)
  SENSITIVE = []
  include Aws::Structure
end

#region ⇒ String

The Amazon Web Services Region name of the event.

Returns:

  • (String)


2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 2008

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,
  :actionability,
  :personas)
  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)


2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 2008

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,
  :actionability,
  :personas)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The date and time that the event began.

Returns:

  • (Time)


2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 2008

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,
  :actionability,
  :personas)
  SENSITIVE = []
  include Aws::Structure
end

#status_code ⇒ String

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

Returns:

  • (String)


2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
# File 'gems/aws-sdk-health/lib/aws-sdk-health/types.rb', line 2008

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,
  :actionability,
  :personas)
  SENSITIVE = []
  include Aws::Structure
end