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

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

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

Overview

Summary information about an AWS Health event.

AWS Health events can be public or account-specific:

  • Public events might be service events that are not specific to an AWS account. For example, if there is an issue with an AWS Region, AWS 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 AWS 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, AWS 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.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

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.

#availability_zone ⇒ String

The AWS Availability Zone of the event. For example, us-east-1a.

Returns:

  • (String) —

    The AWS Availability Zone of the event.

#end_time ⇒ Time

The date and time that the event ended.

Returns:

  • (Time) —

    The date and time that the event ended.

#event_scope_code ⇒ String

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_category ⇒ String

The category of the event. Possible values are issue, scheduledChange, and accountNotification.

Possible values:

  • issue
  • accountNotification
  • scheduledChange
  • investigation

Returns:

  • (String) —

    The category of the event.

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

    The unique identifier for the event type.

#last_updated_time ⇒ Time

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

Returns:

  • (Time) —

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

#region ⇒ String

The AWS region name of the event.

Returns:

  • (String) —

    The AWS region name of the event.

#service ⇒ String

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_time ⇒ Time

The date and time that the event began.

Returns:

  • (Time) —

    The date and time that the event began.

#status_code ⇒ String

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.