Amazonka.AWSHealth.Types.Event

Documentation

data Event

Summary information about an Health event.

Health events can be public or account-specific:

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

See: newEvent smart constructor.

Constructors

Event'

Fields

• arn :: Maybe Text

  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

• availabilityZone :: Maybe Text

  The Amazon Web Services Availability Zone of the event. For example, us-east-1a.

• endTime :: Maybe POSIX

  The date and time that the event ended.

• eventScopeCode :: Maybe EventScopeCode

  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.
• eventTypeCategory :: Maybe EventTypeCategory

  A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

• eventTypeCode :: Maybe Text

  The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

• lastUpdatedTime :: Maybe POSIX

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

• region :: Maybe Text

  The Amazon Web Services Region name of the event.

• service :: Maybe Text

  The Amazon Web Services service that is affected by the event. For example, EC2, RDS.

• startTime :: Maybe POSIX

  The date and time that the event began.

• statusCode :: Maybe EventStatusCode

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

Instances

FromJSON Event

Defined in Amazonka.AWSHealth.Types.Event

Methods

parseJSON :: Value -> Parser Event

parseJSONList :: Value -> Parser [Event]

Generic Event

Defined in Amazonka.AWSHealth.Types.Event

Associated Types

type Rep Event :: Type -> Type

Methods

from :: Event -> Rep Event x

to :: Rep Event x -> Event

Read Event

Defined in Amazonka.AWSHealth.Types.Event

Methods

readsPrec :: Int -> ReadS Event

readList :: ReadS [Event]

readPrec :: ReadPrec Event

readListPrec :: ReadPrec [Event]

Show Event

Defined in Amazonka.AWSHealth.Types.Event

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

NFData Event

Defined in Amazonka.AWSHealth.Types.Event

Methods

rnf :: Event -> ()

Eq Event

Defined in Amazonka.AWSHealth.Types.Event

Methods

(==) :: Event -> Event -> Bool

(/=) :: Event -> Event -> Bool

Hashable Event

Defined in Amazonka.AWSHealth.Types.Event

Methods

hashWithSalt :: Int -> Event -> Int

hash :: Event -> Int

type Rep Event

Defined in Amazonka.AWSHealth.Types.Event

type Rep Event = D1 ('MetaData "Event" "Amazonka.AWSHealth.Types.Event" "amazonka-health-2.0-97kQZARXu4I8k4sVSmOp5K" 'False) (C1 ('MetaCons "Event'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "eventScopeCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventScopeCode)) :*: S1 ('MetaSel ('Just "eventTypeCategory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventTypeCategory))))) :*: ((S1 ('MetaSel ('Just "eventTypeCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "lastUpdatedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "service") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventStatusCode)))))))

newEvent :: Event

Create a value of Event with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:Event', event_arn - 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

$sel:availabilityZone:Event', event_availabilityZone - The Amazon Web Services Availability Zone of the event. For example, us-east-1a.

$sel:endTime:Event', event_endTime - The date and time that the event ended.

$sel:eventScopeCode:Event', event_eventScopeCode - 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.

$sel:eventTypeCategory:Event', event_eventTypeCategory - A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

$sel:eventTypeCode:Event', event_eventTypeCode - The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

$sel:lastUpdatedTime:Event', event_lastUpdatedTime - The most recent date and time that the event was updated.

$sel:region:Event', event_region - The Amazon Web Services Region name of the event.

$sel:service:Event', event_service - The Amazon Web Services service that is affected by the event. For example, EC2, RDS.

$sel:startTime:Event', event_startTime - The date and time that the event began.

$sel:statusCode:Event', event_statusCode - The most recent status of the event. Possible values are open, closed, and upcoming.

event_arn :: Lens' Event (Maybe Text)

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

event_availabilityZone :: Lens' Event (Maybe Text)

The Amazon Web Services Availability Zone of the event. For example, us-east-1a.

event_endTime :: Lens' Event (Maybe UTCTime)

The date and time that the event ended.

event_eventScopeCode :: Lens' Event (Maybe EventScopeCode)

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.

event_eventTypeCategory :: Lens' Event (Maybe EventTypeCategory)

A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

event_eventTypeCode :: Lens' Event (Maybe Text)

The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

event_lastUpdatedTime :: Lens' Event (Maybe UTCTime)

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

event_region :: Lens' Event (Maybe Text)

The Amazon Web Services Region name of the event.

event_service :: Lens' Event (Maybe Text)

The Amazon Web Services service that is affected by the event. For example, EC2, RDS.

event_startTime :: Lens' Event (Maybe UTCTime)

The date and time that the event began.

event_statusCode :: Lens' Event (Maybe EventStatusCode)

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