AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

Returns:

  • (String)

    The unique identifier for the event.

#end_timeTime

The date and time that the event ended.

Returns:

  • (Time)

    The date and time that the event ended.

#event_scope_codeString

This parameter specifies if the AWS Health event is a public AWS 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 AWS accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have AWS 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.

    Possible values:

    • PUBLIC
    • ACCOUNT_SPECIFIC
    • NONE

Returns:

  • (String)

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

#event_type_categoryString

The category of the event type.

Possible values:

  • issue
  • accountNotification
  • scheduledChange
  • investigation

Returns:

  • (String)

    The category of the event type.

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

    The unique identifier for the event type.

#last_updated_timeTime

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

Returns:

  • (Time)

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

#regionString

The AWS Region name of the event.

Returns:

  • (String)

    The AWS Region name of the event.

#serviceString

The AWS service that is affected by the event. For example, EC2, RDS.

Returns:

  • (String)

    The AWS service that is affected by the event.

#start_timeTime

The date and time that the event began.

Returns:

  • (Time)

    The date and time that the event began.

#status_codeString

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

Possible values:

  • open
  • closed
  • upcoming

Returns:

  • (String)

    The most recent status of the event.