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
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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 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 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`
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 |
# File 'lib/aws-sdk-health/types.rb', line 1447 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.
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 |
# File 'lib/aws-sdk-health/types.rb', line 1447 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 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.
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 |
# File 'lib/aws-sdk-health/types.rb', line 1447 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.
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 |
# File 'lib/aws-sdk-health/types.rb', line 1447 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`.
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 |
# File 'lib/aws-sdk-health/types.rb', line 1447 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.
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 |
# File 'lib/aws-sdk-health/types.rb', line 1447 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.
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 |
# File 'lib/aws-sdk-health/types.rb', line 1447 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 Service that is affected by the event, such as EC2 and RDS.
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 |
# File 'lib/aws-sdk-health/types.rb', line 1447 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.
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 |
# File 'lib/aws-sdk-health/types.rb', line 1447 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`.
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 |
# File 'lib/aws-sdk-health/types.rb', line 1447 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 |