Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AWSHealth.Types.OrganizationEvent

Description

Synopsis

data OrganizationEvent = OrganizationEvent' {
- arn :: Maybe Text
- endTime :: Maybe POSIX
- eventScopeCode :: Maybe EventScopeCode
- eventTypeCategory :: Maybe EventTypeCategory
- eventTypeCode :: Maybe Text
- lastUpdatedTime :: Maybe POSIX
- region :: Maybe Text
- service :: Maybe Text
- startTime :: Maybe POSIX
- statusCode :: Maybe EventStatusCode
}
newOrganizationEvent :: OrganizationEvent
organizationEvent_arn :: Lens' OrganizationEvent (Maybe Text)
organizationEvent_endTime :: Lens' OrganizationEvent (Maybe UTCTime)
organizationEvent_eventScopeCode :: Lens' OrganizationEvent (Maybe EventScopeCode)
organizationEvent_eventTypeCategory :: Lens' OrganizationEvent (Maybe EventTypeCategory)
organizationEvent_eventTypeCode :: Lens' OrganizationEvent (Maybe Text)
organizationEvent_lastUpdatedTime :: Lens' OrganizationEvent (Maybe UTCTime)
organizationEvent_region :: Lens' OrganizationEvent (Maybe Text)
organizationEvent_service :: Lens' OrganizationEvent (Maybe Text)
organizationEvent_startTime :: Lens' OrganizationEvent (Maybe UTCTime)
organizationEvent_statusCode :: Lens' OrganizationEvent (Maybe EventStatusCode)

Documentation

data OrganizationEvent Source #

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

See: newOrganizationEvent smart constructor.

Constructors

OrganizationEvent'

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
```
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, such as EC2 and 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

Instances details

FromJSON OrganizationEvent Source #
Instance details Defined in Amazonka.AWSHealth.Types.OrganizationEvent Methods parseJSON :: Value -> Parser OrganizationEvent # parseJSONList :: Value -> Parser [OrganizationEvent] #
Generic OrganizationEvent Source #
Instance details Defined in Amazonka.AWSHealth.Types.OrganizationEvent Associated Types type Rep OrganizationEvent :: Type -> Type # Methods from :: OrganizationEvent -> Rep OrganizationEvent x # to :: Rep OrganizationEvent x -> OrganizationEvent #
Read OrganizationEvent Source #
Instance details Defined in Amazonka.AWSHealth.Types.OrganizationEvent Methods readsPrec :: Int -> ReadS OrganizationEvent # readList :: ReadS [OrganizationEvent] # readPrec :: ReadPrec OrganizationEvent # readListPrec :: ReadPrec [OrganizationEvent] #
Show OrganizationEvent Source #
Instance details Defined in Amazonka.AWSHealth.Types.OrganizationEvent Methods showsPrec :: Int -> OrganizationEvent -> ShowS # show :: OrganizationEvent -> String # showList :: [OrganizationEvent] -> ShowS #
NFData OrganizationEvent Source #
Instance details Defined in Amazonka.AWSHealth.Types.OrganizationEvent Methods rnf :: OrganizationEvent -> () #
Eq OrganizationEvent Source #
Instance details Defined in Amazonka.AWSHealth.Types.OrganizationEvent Methods (==) :: OrganizationEvent -> OrganizationEvent -> Bool # (/=) :: OrganizationEvent -> OrganizationEvent -> Bool #
Hashable OrganizationEvent Source #
Instance details Defined in Amazonka.AWSHealth.Types.OrganizationEvent Methods hashWithSalt :: Int -> OrganizationEvent -> Int # hash :: OrganizationEvent -> Int #
type Rep OrganizationEvent Source #
Instance details Defined in Amazonka.AWSHealth.Types.OrganizationEvent type Rep OrganizationEvent = D1 ('MetaData "OrganizationEvent" "Amazonka.AWSHealth.Types.OrganizationEvent" "amazonka-health-2.0-97kQZARXu4I8k4sVSmOp5K" 'False) (C1 ('MetaCons "OrganizationEvent'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") '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)))))))

newOrganizationEvent :: OrganizationEvent Source #

Create a value of OrganizationEvent 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:OrganizationEvent', organizationEvent_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:endTime:OrganizationEvent', organizationEvent_endTime - The date and time that the event ended.

$sel:eventScopeCode:OrganizationEvent', organizationEvent_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:OrganizationEvent', organizationEvent_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:OrganizationEvent', organizationEvent_eventTypeCode - The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

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

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

$sel:service:OrganizationEvent', organizationEvent_service - The Amazon Web Services service that is affected by the event, such as EC2 and RDS.

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

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

organizationEvent_arn :: Lens' OrganizationEvent (Maybe Text) Source #

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

organizationEvent_endTime :: Lens' OrganizationEvent (Maybe UTCTime) Source #

The date and time that the event ended.

organizationEvent_eventScopeCode :: Lens' OrganizationEvent (Maybe EventScopeCode) Source #

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.

organizationEvent_eventTypeCategory :: Lens' OrganizationEvent (Maybe EventTypeCategory) Source #

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

organizationEvent_eventTypeCode :: Lens' OrganizationEvent (Maybe Text) Source #

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

organizationEvent_lastUpdatedTime :: Lens' OrganizationEvent (Maybe UTCTime) Source #

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

organizationEvent_region :: Lens' OrganizationEvent (Maybe Text) Source #

The Amazon Web Services Region name of the event.

organizationEvent_service :: Lens' OrganizationEvent (Maybe Text) Source #

The Amazon Web Services service that is affected by the event, such as EC2 and RDS.

organizationEvent_startTime :: Lens' OrganizationEvent (Maybe UTCTime) Source #

The date and time that the event began.

organizationEvent_statusCode :: Lens' OrganizationEvent (Maybe EventStatusCode) Source #

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