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 |
- Service Configuration
- Errors
- EntityStatusCode
- EventAggregateField
- EventScopeCode
- EventStatusCode
- EventTypeCategory
- AffectedEntity
- DateTimeRange
- EntityAggregate
- EntityFilter
- Event
- EventAccountFilter
- EventAggregate
- EventDescription
- EventDetails
- EventDetailsErrorItem
- EventFilter
- EventType
- EventTypeFilter
- OrganizationAffectedEntitiesErrorItem
- OrganizationEvent
- OrganizationEventDetails
- OrganizationEventDetailsErrorItem
- OrganizationEventFilter
Synopsis
- defaultService :: Service
- _ConcurrentModificationException :: AsError a => Fold a ServiceError
- _InvalidPaginationToken :: AsError a => Fold a ServiceError
- _UnsupportedLocale :: AsError a => Fold a ServiceError
- newtype EntityStatusCode where
- EntityStatusCode' { }
- pattern EntityStatusCode_IMPAIRED :: EntityStatusCode
- pattern EntityStatusCode_UNIMPAIRED :: EntityStatusCode
- pattern EntityStatusCode_UNKNOWN :: EntityStatusCode
- newtype EventAggregateField where
- newtype EventScopeCode where
- EventScopeCode' { }
- pattern EventScopeCode_ACCOUNT_SPECIFIC :: EventScopeCode
- pattern EventScopeCode_NONE :: EventScopeCode
- pattern EventScopeCode_PUBLIC :: EventScopeCode
- newtype EventStatusCode where
- EventStatusCode' { }
- pattern EventStatusCode_Closed :: EventStatusCode
- pattern EventStatusCode_Open :: EventStatusCode
- pattern EventStatusCode_Upcoming :: EventStatusCode
- newtype EventTypeCategory where
- data AffectedEntity = AffectedEntity' {}
- newAffectedEntity :: AffectedEntity
- affectedEntity_awsAccountId :: Lens' AffectedEntity (Maybe Text)
- affectedEntity_entityArn :: Lens' AffectedEntity (Maybe Text)
- affectedEntity_entityUrl :: Lens' AffectedEntity (Maybe Text)
- affectedEntity_entityValue :: Lens' AffectedEntity (Maybe Text)
- affectedEntity_eventArn :: Lens' AffectedEntity (Maybe Text)
- affectedEntity_lastUpdatedTime :: Lens' AffectedEntity (Maybe UTCTime)
- affectedEntity_statusCode :: Lens' AffectedEntity (Maybe EntityStatusCode)
- affectedEntity_tags :: Lens' AffectedEntity (Maybe (HashMap Text Text))
- data DateTimeRange = DateTimeRange' {}
- newDateTimeRange :: DateTimeRange
- dateTimeRange_from :: Lens' DateTimeRange (Maybe UTCTime)
- dateTimeRange_to :: Lens' DateTimeRange (Maybe UTCTime)
- data EntityAggregate = EntityAggregate' {}
- newEntityAggregate :: EntityAggregate
- entityAggregate_count :: Lens' EntityAggregate (Maybe Int)
- entityAggregate_eventArn :: Lens' EntityAggregate (Maybe Text)
- data EntityFilter = EntityFilter' {
- entityArns :: Maybe (NonEmpty Text)
- entityValues :: Maybe (NonEmpty Text)
- lastUpdatedTimes :: Maybe (NonEmpty DateTimeRange)
- statusCodes :: Maybe (NonEmpty EntityStatusCode)
- tags :: Maybe [HashMap Text Text]
- eventArns :: NonEmpty Text
- newEntityFilter :: NonEmpty Text -> EntityFilter
- entityFilter_entityArns :: Lens' EntityFilter (Maybe (NonEmpty Text))
- entityFilter_entityValues :: Lens' EntityFilter (Maybe (NonEmpty Text))
- entityFilter_lastUpdatedTimes :: Lens' EntityFilter (Maybe (NonEmpty DateTimeRange))
- entityFilter_statusCodes :: Lens' EntityFilter (Maybe (NonEmpty EntityStatusCode))
- entityFilter_tags :: Lens' EntityFilter (Maybe [HashMap Text Text])
- entityFilter_eventArns :: Lens' EntityFilter (NonEmpty Text)
- data Event = Event' {
- arn :: Maybe Text
- availabilityZone :: 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
- newEvent :: Event
- event_arn :: Lens' Event (Maybe Text)
- event_availabilityZone :: Lens' Event (Maybe Text)
- event_endTime :: Lens' Event (Maybe UTCTime)
- event_eventScopeCode :: Lens' Event (Maybe EventScopeCode)
- event_eventTypeCategory :: Lens' Event (Maybe EventTypeCategory)
- event_eventTypeCode :: Lens' Event (Maybe Text)
- event_lastUpdatedTime :: Lens' Event (Maybe UTCTime)
- event_region :: Lens' Event (Maybe Text)
- event_service :: Lens' Event (Maybe Text)
- event_startTime :: Lens' Event (Maybe UTCTime)
- event_statusCode :: Lens' Event (Maybe EventStatusCode)
- data EventAccountFilter = EventAccountFilter' {
- awsAccountId :: Maybe Text
- eventArn :: Text
- newEventAccountFilter :: Text -> EventAccountFilter
- eventAccountFilter_awsAccountId :: Lens' EventAccountFilter (Maybe Text)
- eventAccountFilter_eventArn :: Lens' EventAccountFilter Text
- data EventAggregate = EventAggregate' {}
- newEventAggregate :: EventAggregate
- eventAggregate_aggregateValue :: Lens' EventAggregate (Maybe Text)
- eventAggregate_count :: Lens' EventAggregate (Maybe Int)
- data EventDescription = EventDescription' {}
- newEventDescription :: EventDescription
- eventDescription_latestDescription :: Lens' EventDescription (Maybe Text)
- data EventDetails = EventDetails' {}
- newEventDetails :: EventDetails
- eventDetails_event :: Lens' EventDetails (Maybe Event)
- eventDetails_eventDescription :: Lens' EventDetails (Maybe EventDescription)
- eventDetails_eventMetadata :: Lens' EventDetails (Maybe (HashMap Text Text))
- data EventDetailsErrorItem = EventDetailsErrorItem' {}
- newEventDetailsErrorItem :: EventDetailsErrorItem
- eventDetailsErrorItem_errorMessage :: Lens' EventDetailsErrorItem (Maybe Text)
- eventDetailsErrorItem_errorName :: Lens' EventDetailsErrorItem (Maybe Text)
- eventDetailsErrorItem_eventArn :: Lens' EventDetailsErrorItem (Maybe Text)
- data EventFilter = EventFilter' {
- availabilityZones :: Maybe [Text]
- endTimes :: Maybe (NonEmpty DateTimeRange)
- entityArns :: Maybe (NonEmpty Text)
- entityValues :: Maybe (NonEmpty Text)
- eventArns :: Maybe (NonEmpty Text)
- eventStatusCodes :: Maybe (NonEmpty EventStatusCode)
- eventTypeCategories :: Maybe (NonEmpty EventTypeCategory)
- eventTypeCodes :: Maybe (NonEmpty Text)
- lastUpdatedTimes :: Maybe (NonEmpty DateTimeRange)
- regions :: Maybe (NonEmpty Text)
- services :: Maybe (NonEmpty Text)
- startTimes :: Maybe (NonEmpty DateTimeRange)
- tags :: Maybe [HashMap Text Text]
- newEventFilter :: EventFilter
- eventFilter_availabilityZones :: Lens' EventFilter (Maybe [Text])
- eventFilter_endTimes :: Lens' EventFilter (Maybe (NonEmpty DateTimeRange))
- eventFilter_entityArns :: Lens' EventFilter (Maybe (NonEmpty Text))
- eventFilter_entityValues :: Lens' EventFilter (Maybe (NonEmpty Text))
- eventFilter_eventArns :: Lens' EventFilter (Maybe (NonEmpty Text))
- eventFilter_eventStatusCodes :: Lens' EventFilter (Maybe (NonEmpty EventStatusCode))
- eventFilter_eventTypeCategories :: Lens' EventFilter (Maybe (NonEmpty EventTypeCategory))
- eventFilter_eventTypeCodes :: Lens' EventFilter (Maybe (NonEmpty Text))
- eventFilter_lastUpdatedTimes :: Lens' EventFilter (Maybe (NonEmpty DateTimeRange))
- eventFilter_regions :: Lens' EventFilter (Maybe (NonEmpty Text))
- eventFilter_services :: Lens' EventFilter (Maybe (NonEmpty Text))
- eventFilter_startTimes :: Lens' EventFilter (Maybe (NonEmpty DateTimeRange))
- eventFilter_tags :: Lens' EventFilter (Maybe [HashMap Text Text])
- data EventType = EventType' {}
- newEventType :: EventType
- eventType_category :: Lens' EventType (Maybe EventTypeCategory)
- eventType_code :: Lens' EventType (Maybe Text)
- eventType_service :: Lens' EventType (Maybe Text)
- data EventTypeFilter = EventTypeFilter' {}
- newEventTypeFilter :: EventTypeFilter
- eventTypeFilter_eventTypeCategories :: Lens' EventTypeFilter (Maybe (NonEmpty EventTypeCategory))
- eventTypeFilter_eventTypeCodes :: Lens' EventTypeFilter (Maybe (NonEmpty Text))
- eventTypeFilter_services :: Lens' EventTypeFilter (Maybe (NonEmpty Text))
- data OrganizationAffectedEntitiesErrorItem = OrganizationAffectedEntitiesErrorItem' {}
- newOrganizationAffectedEntitiesErrorItem :: OrganizationAffectedEntitiesErrorItem
- organizationAffectedEntitiesErrorItem_awsAccountId :: Lens' OrganizationAffectedEntitiesErrorItem (Maybe Text)
- organizationAffectedEntitiesErrorItem_errorMessage :: Lens' OrganizationAffectedEntitiesErrorItem (Maybe Text)
- organizationAffectedEntitiesErrorItem_errorName :: Lens' OrganizationAffectedEntitiesErrorItem (Maybe Text)
- organizationAffectedEntitiesErrorItem_eventArn :: Lens' OrganizationAffectedEntitiesErrorItem (Maybe Text)
- data OrganizationEvent = OrganizationEvent' {}
- 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)
- data OrganizationEventDetails = OrganizationEventDetails' {}
- newOrganizationEventDetails :: OrganizationEventDetails
- organizationEventDetails_awsAccountId :: Lens' OrganizationEventDetails (Maybe Text)
- organizationEventDetails_event :: Lens' OrganizationEventDetails (Maybe Event)
- organizationEventDetails_eventDescription :: Lens' OrganizationEventDetails (Maybe EventDescription)
- organizationEventDetails_eventMetadata :: Lens' OrganizationEventDetails (Maybe (HashMap Text Text))
- data OrganizationEventDetailsErrorItem = OrganizationEventDetailsErrorItem' {}
- newOrganizationEventDetailsErrorItem :: OrganizationEventDetailsErrorItem
- organizationEventDetailsErrorItem_awsAccountId :: Lens' OrganizationEventDetailsErrorItem (Maybe Text)
- organizationEventDetailsErrorItem_errorMessage :: Lens' OrganizationEventDetailsErrorItem (Maybe Text)
- organizationEventDetailsErrorItem_errorName :: Lens' OrganizationEventDetailsErrorItem (Maybe Text)
- organizationEventDetailsErrorItem_eventArn :: Lens' OrganizationEventDetailsErrorItem (Maybe Text)
- data OrganizationEventFilter = OrganizationEventFilter' {
- awsAccountIds :: Maybe (NonEmpty Text)
- endTime :: Maybe DateTimeRange
- entityArns :: Maybe (NonEmpty Text)
- entityValues :: Maybe (NonEmpty Text)
- eventStatusCodes :: Maybe (NonEmpty EventStatusCode)
- eventTypeCategories :: Maybe (NonEmpty EventTypeCategory)
- eventTypeCodes :: Maybe (NonEmpty Text)
- lastUpdatedTime :: Maybe DateTimeRange
- regions :: Maybe (NonEmpty Text)
- services :: Maybe (NonEmpty Text)
- startTime :: Maybe DateTimeRange
- newOrganizationEventFilter :: OrganizationEventFilter
- organizationEventFilter_awsAccountIds :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text))
- organizationEventFilter_endTime :: Lens' OrganizationEventFilter (Maybe DateTimeRange)
- organizationEventFilter_entityArns :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text))
- organizationEventFilter_entityValues :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text))
- organizationEventFilter_eventStatusCodes :: Lens' OrganizationEventFilter (Maybe (NonEmpty EventStatusCode))
- organizationEventFilter_eventTypeCategories :: Lens' OrganizationEventFilter (Maybe (NonEmpty EventTypeCategory))
- organizationEventFilter_eventTypeCodes :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text))
- organizationEventFilter_lastUpdatedTime :: Lens' OrganizationEventFilter (Maybe DateTimeRange)
- organizationEventFilter_regions :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text))
- organizationEventFilter_services :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text))
- organizationEventFilter_startTime :: Lens' OrganizationEventFilter (Maybe DateTimeRange)
Service Configuration
defaultService :: Service Source #
API version 2016-08-04
of the Amazon Health APIs and Notifications SDK configuration.
Errors
_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #
EnableHealthServiceAccessForOrganization is already in progress. Wait for the action to complete before trying again. To get the current status, use the DescribeHealthServiceStatusForOrganization operation.
_InvalidPaginationToken :: AsError a => Fold a ServiceError Source #
The specified pagination token (nextToken
) is not valid.
_UnsupportedLocale :: AsError a => Fold a ServiceError Source #
The specified locale is not supported.
EntityStatusCode
newtype EntityStatusCode Source #
pattern EntityStatusCode_IMPAIRED :: EntityStatusCode | |
pattern EntityStatusCode_UNIMPAIRED :: EntityStatusCode | |
pattern EntityStatusCode_UNKNOWN :: EntityStatusCode |
Instances
EventAggregateField
newtype EventAggregateField Source #
Instances
EventScopeCode
newtype EventScopeCode Source #
pattern EventScopeCode_ACCOUNT_SPECIFIC :: EventScopeCode | |
pattern EventScopeCode_NONE :: EventScopeCode | |
pattern EventScopeCode_PUBLIC :: EventScopeCode |
Instances
EventStatusCode
newtype EventStatusCode Source #
pattern EventStatusCode_Closed :: EventStatusCode | |
pattern EventStatusCode_Open :: EventStatusCode | |
pattern EventStatusCode_Upcoming :: EventStatusCode |
Instances
EventTypeCategory
newtype EventTypeCategory Source #
pattern EventTypeCategory_AccountNotification :: EventTypeCategory | |
pattern EventTypeCategory_Investigation :: EventTypeCategory | |
pattern EventTypeCategory_Issue :: EventTypeCategory | |
pattern EventTypeCategory_ScheduledChange :: EventTypeCategory |
Instances
AffectedEntity
data AffectedEntity Source #
Information about an entity that is affected by a Health event.
See: newAffectedEntity
smart constructor.
AffectedEntity' | |
|
Instances
newAffectedEntity :: AffectedEntity Source #
Create a value of AffectedEntity
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:awsAccountId:AffectedEntity'
, affectedEntity_awsAccountId
- The 12-digit Amazon Web Services account number that contains the
affected entity.
$sel:entityArn:AffectedEntity'
, affectedEntity_entityArn
- The unique identifier for the entity. Format:
arn:aws:health:
entity-region
:
aws-account
:entity/
entity-id
.
Example:
arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K
$sel:entityUrl:AffectedEntity'
, affectedEntity_entityUrl
- The URL of the affected entity.
$sel:entityValue:AffectedEntity'
, affectedEntity_entityValue
- The ID of the affected entity.
$sel:eventArn:AffectedEntity'
, affectedEntity_eventArn
- 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:lastUpdatedTime:AffectedEntity'
, affectedEntity_lastUpdatedTime
- The most recent time that the entity was updated.
$sel:statusCode:AffectedEntity'
, affectedEntity_statusCode
- The most recent status of the entity affected by the event. The possible
values are IMPAIRED
, UNIMPAIRED
, and UNKNOWN
.
$sel:tags:AffectedEntity'
, affectedEntity_tags
- A map of entity tags attached to the affected entity.
Currently, the tags
property isn't supported.
affectedEntity_awsAccountId :: Lens' AffectedEntity (Maybe Text) Source #
The 12-digit Amazon Web Services account number that contains the affected entity.
affectedEntity_entityArn :: Lens' AffectedEntity (Maybe Text) Source #
The unique identifier for the entity. Format:
arn:aws:health:
entity-region
:
aws-account
:entity/
entity-id
.
Example:
arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K
affectedEntity_entityUrl :: Lens' AffectedEntity (Maybe Text) Source #
The URL of the affected entity.
affectedEntity_entityValue :: Lens' AffectedEntity (Maybe Text) Source #
The ID of the affected entity.
affectedEntity_eventArn :: Lens' AffectedEntity (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
affectedEntity_lastUpdatedTime :: Lens' AffectedEntity (Maybe UTCTime) Source #
The most recent time that the entity was updated.
affectedEntity_statusCode :: Lens' AffectedEntity (Maybe EntityStatusCode) Source #
The most recent status of the entity affected by the event. The possible
values are IMPAIRED
, UNIMPAIRED
, and UNKNOWN
.
affectedEntity_tags :: Lens' AffectedEntity (Maybe (HashMap Text Text)) Source #
A map of entity tags attached to the affected entity.
Currently, the tags
property isn't supported.
DateTimeRange
data DateTimeRange Source #
A range of dates and times that is used by the
EventFilter
and
EntityFilter
objects. If from
is set and to
is set: match items where the
timestamp (startTime
, endTime
, or lastUpdatedTime
) is between
from
and to
inclusive. If from
is set and to
is not set: match
items where the timestamp value is equal to or after from
. If from
is not set and to
is set: match items where the timestamp value is
equal to or before to
.
See: newDateTimeRange
smart constructor.
Instances
newDateTimeRange :: DateTimeRange Source #
Create a value of DateTimeRange
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:from:DateTimeRange'
, dateTimeRange_from
- The starting date and time of a time range.
$sel:to:DateTimeRange'
, dateTimeRange_to
- The ending date and time of a time range.
dateTimeRange_from :: Lens' DateTimeRange (Maybe UTCTime) Source #
The starting date and time of a time range.
dateTimeRange_to :: Lens' DateTimeRange (Maybe UTCTime) Source #
The ending date and time of a time range.
EntityAggregate
data EntityAggregate Source #
The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.
See: newEntityAggregate
smart constructor.
EntityAggregate' | |
|
Instances
newEntityAggregate :: EntityAggregate Source #
Create a value of EntityAggregate
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:count:EntityAggregate'
, entityAggregate_count
- The number of entities that match the criteria for the specified events.
$sel:eventArn:EntityAggregate'
, entityAggregate_eventArn
- 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
entityAggregate_count :: Lens' EntityAggregate (Maybe Int) Source #
The number of entities that match the criteria for the specified events.
entityAggregate_eventArn :: Lens' EntityAggregate (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
EntityFilter
data EntityFilter Source #
The values to use to filter results from the DescribeAffectedEntities operation.
See: newEntityFilter
smart constructor.
EntityFilter' | |
|
Instances
Create a value of EntityFilter
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:entityArns:EntityFilter'
, entityFilter_entityArns
- A list of entity ARNs (unique identifiers).
$sel:entityValues:EntityFilter'
, entityFilter_entityValues
- A list of IDs for affected entities.
$sel:lastUpdatedTimes:EntityFilter'
, entityFilter_lastUpdatedTimes
- A list of the most recent dates and times that the entity was updated.
$sel:statusCodes:EntityFilter'
, entityFilter_statusCodes
- A list of entity status codes (IMPAIRED
, UNIMPAIRED
, or UNKNOWN
).
$sel:tags:EntityFilter'
, entityFilter_tags
- A map of entity tags attached to the affected entity.
Currently, the tags
property isn't supported.
$sel:eventArns:EntityFilter'
, entityFilter_eventArns
- A list of event ARNs (unique identifiers). For example:
"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
entityFilter_entityArns :: Lens' EntityFilter (Maybe (NonEmpty Text)) Source #
A list of entity ARNs (unique identifiers).
entityFilter_entityValues :: Lens' EntityFilter (Maybe (NonEmpty Text)) Source #
A list of IDs for affected entities.
entityFilter_lastUpdatedTimes :: Lens' EntityFilter (Maybe (NonEmpty DateTimeRange)) Source #
A list of the most recent dates and times that the entity was updated.
entityFilter_statusCodes :: Lens' EntityFilter (Maybe (NonEmpty EntityStatusCode)) Source #
A list of entity status codes (IMPAIRED
, UNIMPAIRED
, or UNKNOWN
).
entityFilter_tags :: Lens' EntityFilter (Maybe [HashMap Text Text]) Source #
A map of entity tags attached to the affected entity.
Currently, the tags
property isn't supported.
entityFilter_eventArns :: Lens' EntityFilter (NonEmpty Text) Source #
A list of event ARNs (unique identifiers). For example:
"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
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.
Event' | |
|
Instances
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 isPUBLIC
, then theaffectedAccounts
value is always empty. - If the
eventScopeCode
value isACCOUNT_SPECIFIC
, then theaffectedAccounts
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 isNONE
, then theeventArn
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) 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
event_availabilityZone :: Lens' Event (Maybe Text) Source #
The Amazon Web Services Availability Zone of the event. For example, us-east-1a.
event_eventScopeCode :: Lens' Event (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 isPUBLIC
, then theaffectedAccounts
value is always empty. - If the
eventScopeCode
value isACCOUNT_SPECIFIC
, then theaffectedAccounts
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 isNONE
, then theeventArn
that you specified in the request is invalid or doesn't exist.
event_eventTypeCategory :: Lens' Event (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.
event_eventTypeCode :: Lens' Event (Maybe Text) Source #
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) Source #
The most recent date and time that the event was updated.
event_service :: Lens' Event (Maybe Text) Source #
The Amazon Web Services service that is affected by the event. For
example, EC2
, RDS
.
event_statusCode :: Lens' Event (Maybe EventStatusCode) Source #
The most recent status of the event. Possible values are open
,
closed
, and upcoming
.
EventAccountFilter
data EventAccountFilter Source #
The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations.
See: newEventAccountFilter
smart constructor.
EventAccountFilter' | |
|
Instances
newEventAccountFilter Source #
Create a value of EventAccountFilter
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:awsAccountId:EventAccountFilter'
, eventAccountFilter_awsAccountId
- The 12-digit Amazon Web Services account numbers that contains the
affected entities.
$sel:eventArn:EventAccountFilter'
, eventAccountFilter_eventArn
- 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
eventAccountFilter_awsAccountId :: Lens' EventAccountFilter (Maybe Text) Source #
The 12-digit Amazon Web Services account numbers that contains the affected entities.
eventAccountFilter_eventArn :: Lens' EventAccountFilter 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
EventAggregate
data EventAggregate Source #
The number of events of each issue type. Returned by the DescribeEventAggregates operation.
See: newEventAggregate
smart constructor.
Instances
newEventAggregate :: EventAggregate Source #
Create a value of EventAggregate
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:aggregateValue:EventAggregate'
, eventAggregate_aggregateValue
- The issue type for the associated count.
$sel:count:EventAggregate'
, eventAggregate_count
- The number of events of the associated issue type.
eventAggregate_aggregateValue :: Lens' EventAggregate (Maybe Text) Source #
The issue type for the associated count.
eventAggregate_count :: Lens' EventAggregate (Maybe Int) Source #
The number of events of the associated issue type.
EventDescription
data EventDescription Source #
The detailed description of the event. Included in the information returned by the DescribeEventDetails operation.
See: newEventDescription
smart constructor.
EventDescription' | |
|
Instances
newEventDescription :: EventDescription Source #
Create a value of EventDescription
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:latestDescription:EventDescription'
, eventDescription_latestDescription
- The most recent description of the event.
eventDescription_latestDescription :: Lens' EventDescription (Maybe Text) Source #
The most recent description of the event.
EventDetails
data EventDetails Source #
Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by the DescribeEventDetails operation.
See: newEventDetails
smart constructor.
EventDetails' | |
|
Instances
newEventDetails :: EventDetails Source #
Create a value of EventDetails
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:event:EventDetails'
, eventDetails_event
- Summary information about the event.
$sel:eventDescription:EventDetails'
, eventDetails_eventDescription
- The most recent description of the event.
$sel:eventMetadata:EventDetails'
, eventDetails_eventMetadata
- Additional metadata about the event.
eventDetails_event :: Lens' EventDetails (Maybe Event) Source #
Summary information about the event.
eventDetails_eventDescription :: Lens' EventDetails (Maybe EventDescription) Source #
The most recent description of the event.
eventDetails_eventMetadata :: Lens' EventDetails (Maybe (HashMap Text Text)) Source #
Additional metadata about the event.
EventDetailsErrorItem
data EventDetailsErrorItem Source #
Error information returned when a DescribeEventDetails operation can't find a specified event.
See: newEventDetailsErrorItem
smart constructor.
EventDetailsErrorItem' | |
|
Instances
newEventDetailsErrorItem :: EventDetailsErrorItem Source #
Create a value of EventDetailsErrorItem
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:errorMessage:EventDetailsErrorItem'
, eventDetailsErrorItem_errorMessage
- A message that describes the error.
$sel:errorName:EventDetailsErrorItem'
, eventDetailsErrorItem_errorName
- The name of the error.
$sel:eventArn:EventDetailsErrorItem'
, eventDetailsErrorItem_eventArn
- 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
eventDetailsErrorItem_errorMessage :: Lens' EventDetailsErrorItem (Maybe Text) Source #
A message that describes the error.
eventDetailsErrorItem_errorName :: Lens' EventDetailsErrorItem (Maybe Text) Source #
The name of the error.
eventDetailsErrorItem_eventArn :: Lens' EventDetailsErrorItem (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
EventFilter
data EventFilter Source #
The values to use to filter results from the DescribeEvents and DescribeEventAggregates operations.
See: newEventFilter
smart constructor.
EventFilter' | |
|
Instances
newEventFilter :: EventFilter Source #
Create a value of EventFilter
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:availabilityZones:EventFilter'
, eventFilter_availabilityZones
- A list of Amazon Web Services Availability Zones.
$sel:endTimes:EventFilter'
, eventFilter_endTimes
- A list of dates and times that the event ended.
$sel:entityArns:EventFilter'
, eventFilter_entityArns
- A list of entity ARNs (unique identifiers).
$sel:entityValues:EventFilter'
, eventFilter_entityValues
- A list of entity identifiers, such as EC2 instance IDs (i-34ab692e
) or
EBS volumes (vol-426ab23e
).
$sel:eventArns:EventFilter'
, eventFilter_eventArns
- A list of event ARNs (unique identifiers). For example:
"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
$sel:eventStatusCodes:EventFilter'
, eventFilter_eventStatusCodes
- A list of event status codes.
$sel:eventTypeCategories:EventFilter'
, eventFilter_eventTypeCategories
- 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:eventTypeCodes:EventFilter'
, eventFilter_eventTypeCodes
- A list of unique identifiers for event types. For example,
"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
$sel:lastUpdatedTimes:EventFilter'
, eventFilter_lastUpdatedTimes
- A list of dates and times that the event was last updated.
$sel:regions:EventFilter'
, eventFilter_regions
- A list of Amazon Web Services Regions.
$sel:services:EventFilter'
, eventFilter_services
- The Amazon Web Services services associated with the event. For example,
EC2
, RDS
.
$sel:startTimes:EventFilter'
, eventFilter_startTimes
- A list of dates and times that the event began.
$sel:tags:EventFilter'
, eventFilter_tags
- A map of entity tags attached to the affected entity.
Currently, the tags
property isn't supported.
eventFilter_availabilityZones :: Lens' EventFilter (Maybe [Text]) Source #
A list of Amazon Web Services Availability Zones.
eventFilter_endTimes :: Lens' EventFilter (Maybe (NonEmpty DateTimeRange)) Source #
A list of dates and times that the event ended.
eventFilter_entityArns :: Lens' EventFilter (Maybe (NonEmpty Text)) Source #
A list of entity ARNs (unique identifiers).
eventFilter_entityValues :: Lens' EventFilter (Maybe (NonEmpty Text)) Source #
A list of entity identifiers, such as EC2 instance IDs (i-34ab692e
) or
EBS volumes (vol-426ab23e
).
eventFilter_eventArns :: Lens' EventFilter (Maybe (NonEmpty Text)) Source #
A list of event ARNs (unique identifiers). For example:
"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
eventFilter_eventStatusCodes :: Lens' EventFilter (Maybe (NonEmpty EventStatusCode)) Source #
A list of event status codes.
eventFilter_eventTypeCategories :: Lens' EventFilter (Maybe (NonEmpty 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.
eventFilter_eventTypeCodes :: Lens' EventFilter (Maybe (NonEmpty Text)) Source #
A list of unique identifiers for event types. For example,
"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
eventFilter_lastUpdatedTimes :: Lens' EventFilter (Maybe (NonEmpty DateTimeRange)) Source #
A list of dates and times that the event was last updated.
eventFilter_regions :: Lens' EventFilter (Maybe (NonEmpty Text)) Source #
A list of Amazon Web Services Regions.
eventFilter_services :: Lens' EventFilter (Maybe (NonEmpty Text)) Source #
The Amazon Web Services services associated with the event. For example,
EC2
, RDS
.
eventFilter_startTimes :: Lens' EventFilter (Maybe (NonEmpty DateTimeRange)) Source #
A list of dates and times that the event began.
eventFilter_tags :: Lens' EventFilter (Maybe [HashMap Text Text]) Source #
A map of entity tags attached to the affected entity.
Currently, the tags
property isn't supported.
EventType
Contains the metadata about a type of event that is reported by Health.
The EventType
shows the category, service, and the event type code of
the event. For example, an issue
might be the category, EC2
the
service, and AWS_EC2_SYSTEM_MAINTENANCE_EVENT
the event type code.
You can use the DescribeEventTypes API operation to return this information about an event.
You can also use the Amazon CloudWatch Events console to create a rule so that you can get notified or take action when Health delivers a specific event to your Amazon Web Services account. For more information, see Monitor for Health events with Amazon CloudWatch Events in the Health User Guide.
See: newEventType
smart constructor.
EventType' | |
|
Instances
FromJSON EventType Source # | |
Generic EventType Source # | |
Read EventType Source # | |
Show EventType Source # | |
NFData EventType Source # | |
Defined in Amazonka.AWSHealth.Types.EventType | |
Eq EventType Source # | |
Hashable EventType Source # | |
Defined in Amazonka.AWSHealth.Types.EventType | |
type Rep EventType Source # | |
Defined in Amazonka.AWSHealth.Types.EventType type Rep EventType = D1 ('MetaData "EventType" "Amazonka.AWSHealth.Types.EventType" "amazonka-health-2.0-97kQZARXu4I8k4sVSmOp5K" 'False) (C1 ('MetaCons "EventType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "category") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventTypeCategory)) :*: (S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "service") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) |
newEventType :: EventType Source #
Create a value of EventType
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:category:EventType'
, eventType_category
- 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:code:EventType'
, eventType_code
- The unique identifier for the event type. The format is
AWS_
SERVICE
_
DESCRIPTION
; for example,
AWS_EC2_SYSTEM_MAINTENANCE_EVENT
.
$sel:service:EventType'
, eventType_service
- The Amazon Web Services service that is affected by the event. For
example, EC2
, RDS
.
eventType_category :: Lens' EventType (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.
eventType_code :: Lens' EventType (Maybe Text) Source #
The unique identifier for the event type. The format is
AWS_
SERVICE
_
DESCRIPTION
; for example,
AWS_EC2_SYSTEM_MAINTENANCE_EVENT
.
eventType_service :: Lens' EventType (Maybe Text) Source #
The Amazon Web Services service that is affected by the event. For
example, EC2
, RDS
.
EventTypeFilter
data EventTypeFilter Source #
The values to use to filter results from the DescribeEventTypes operation.
See: newEventTypeFilter
smart constructor.
EventTypeFilter' | |
|
Instances
newEventTypeFilter :: EventTypeFilter Source #
Create a value of EventTypeFilter
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:eventTypeCategories:EventTypeFilter'
, eventTypeFilter_eventTypeCategories
- 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:eventTypeCodes:EventTypeFilter'
, eventTypeFilter_eventTypeCodes
- A list of event type codes.
$sel:services:EventTypeFilter'
, eventTypeFilter_services
- The Amazon Web Services services associated with the event. For example,
EC2
, RDS
.
eventTypeFilter_eventTypeCategories :: Lens' EventTypeFilter (Maybe (NonEmpty 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.
eventTypeFilter_eventTypeCodes :: Lens' EventTypeFilter (Maybe (NonEmpty Text)) Source #
A list of event type codes.
eventTypeFilter_services :: Lens' EventTypeFilter (Maybe (NonEmpty Text)) Source #
The Amazon Web Services services associated with the event. For example,
EC2
, RDS
.
OrganizationAffectedEntitiesErrorItem
data OrganizationAffectedEntitiesErrorItem Source #
Error information returned when a DescribeAffectedEntitiesForOrganization operation can't find or process a specific entity.
See: newOrganizationAffectedEntitiesErrorItem
smart constructor.
OrganizationAffectedEntitiesErrorItem' | |
|
Instances
newOrganizationAffectedEntitiesErrorItem :: OrganizationAffectedEntitiesErrorItem Source #
Create a value of OrganizationAffectedEntitiesErrorItem
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:awsAccountId:OrganizationAffectedEntitiesErrorItem'
, organizationAffectedEntitiesErrorItem_awsAccountId
- The 12-digit Amazon Web Services account numbers that contains the
affected entities.
$sel:errorMessage:OrganizationAffectedEntitiesErrorItem'
, organizationAffectedEntitiesErrorItem_errorMessage
- The unique identifier for the event type. The format is
AWS_SERVICE_DESCRIPTION
. For example,
AWS_EC2_SYSTEM_MAINTENANCE_EVENT
.
$sel:errorName:OrganizationAffectedEntitiesErrorItem'
, organizationAffectedEntitiesErrorItem_errorName
- The name of the error.
$sel:eventArn:OrganizationAffectedEntitiesErrorItem'
, organizationAffectedEntitiesErrorItem_eventArn
- 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
organizationAffectedEntitiesErrorItem_awsAccountId :: Lens' OrganizationAffectedEntitiesErrorItem (Maybe Text) Source #
The 12-digit Amazon Web Services account numbers that contains the affected entities.
organizationAffectedEntitiesErrorItem_errorMessage :: Lens' OrganizationAffectedEntitiesErrorItem (Maybe Text) Source #
The unique identifier for the event type. The format is
AWS_SERVICE_DESCRIPTION
. For example,
AWS_EC2_SYSTEM_MAINTENANCE_EVENT
.
organizationAffectedEntitiesErrorItem_errorName :: Lens' OrganizationAffectedEntitiesErrorItem (Maybe Text) Source #
The name of the error.
organizationAffectedEntitiesErrorItem_eventArn :: Lens' OrganizationAffectedEntitiesErrorItem (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
data OrganizationEvent Source #
Summary information about an event, returned by the DescribeEventsForOrganization operation.
See: newOrganizationEvent
smart constructor.
OrganizationEvent' | |
|
Instances
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 isPUBLIC
, then theaffectedAccounts
value is always empty. - If the
eventScopeCode
value isACCOUNT_SPECIFIC
, then theaffectedAccounts
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 isNONE
, then theeventArn
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 isPUBLIC
, then theaffectedAccounts
value is always empty. - If the
eventScopeCode
value isACCOUNT_SPECIFIC
, then theaffectedAccounts
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 isNONE
, then theeventArn
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
.
OrganizationEventDetails
data OrganizationEventDetails Source #
Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by the DescribeEventDetailsForOrganization operation.
See: newOrganizationEventDetails
smart constructor.
OrganizationEventDetails' | |
|
Instances
newOrganizationEventDetails :: OrganizationEventDetails Source #
Create a value of OrganizationEventDetails
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:awsAccountId:OrganizationEventDetails'
, organizationEventDetails_awsAccountId
- The 12-digit Amazon Web Services account numbers that contains the
affected entities.
$sel:event:OrganizationEventDetails'
, organizationEventDetails_event
- Undocumented member.
$sel:eventDescription:OrganizationEventDetails'
, organizationEventDetails_eventDescription
- Undocumented member.
$sel:eventMetadata:OrganizationEventDetails'
, organizationEventDetails_eventMetadata
- Additional metadata about the event.
organizationEventDetails_awsAccountId :: Lens' OrganizationEventDetails (Maybe Text) Source #
The 12-digit Amazon Web Services account numbers that contains the affected entities.
organizationEventDetails_event :: Lens' OrganizationEventDetails (Maybe Event) Source #
Undocumented member.
organizationEventDetails_eventDescription :: Lens' OrganizationEventDetails (Maybe EventDescription) Source #
Undocumented member.
organizationEventDetails_eventMetadata :: Lens' OrganizationEventDetails (Maybe (HashMap Text Text)) Source #
Additional metadata about the event.
OrganizationEventDetailsErrorItem
data OrganizationEventDetailsErrorItem Source #
Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.
See: newOrganizationEventDetailsErrorItem
smart constructor.
OrganizationEventDetailsErrorItem' | |
|
Instances
newOrganizationEventDetailsErrorItem :: OrganizationEventDetailsErrorItem Source #
Create a value of OrganizationEventDetailsErrorItem
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:awsAccountId:OrganizationEventDetailsErrorItem'
, organizationEventDetailsErrorItem_awsAccountId
- Error information returned when a
DescribeEventDetailsForOrganization
operation can't find a specified event.
$sel:errorMessage:OrganizationEventDetailsErrorItem'
, organizationEventDetailsErrorItem_errorMessage
- A message that describes the error.
If you call the DescribeEventDetailsForOrganization
operation and
receive one of the following errors, follow the recommendations in the
message:
- We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an Amazon Web Services account ID in the request.
- We couldn't find an account specific event for the specified Amazon Web Services account. To find an event that is public, you must enter a null value for the Amazon Web Services account ID in the request.
- Your Amazon Web Services account doesn't include the Amazon Web Services Support plan required to use the Health API. You must have either a Business, Enterprise On-Ramp, or Enterprise Support plan.
$sel:errorName:OrganizationEventDetailsErrorItem'
, organizationEventDetailsErrorItem_errorName
- The name of the error.
$sel:eventArn:OrganizationEventDetailsErrorItem'
, organizationEventDetailsErrorItem_eventArn
- 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
organizationEventDetailsErrorItem_awsAccountId :: Lens' OrganizationEventDetailsErrorItem (Maybe Text) Source #
Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.
organizationEventDetailsErrorItem_errorMessage :: Lens' OrganizationEventDetailsErrorItem (Maybe Text) Source #
A message that describes the error.
If you call the DescribeEventDetailsForOrganization
operation and
receive one of the following errors, follow the recommendations in the
message:
- We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an Amazon Web Services account ID in the request.
- We couldn't find an account specific event for the specified Amazon Web Services account. To find an event that is public, you must enter a null value for the Amazon Web Services account ID in the request.
- Your Amazon Web Services account doesn't include the Amazon Web Services Support plan required to use the Health API. You must have either a Business, Enterprise On-Ramp, or Enterprise Support plan.
organizationEventDetailsErrorItem_errorName :: Lens' OrganizationEventDetailsErrorItem (Maybe Text) Source #
The name of the error.
organizationEventDetailsErrorItem_eventArn :: Lens' OrganizationEventDetailsErrorItem (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
OrganizationEventFilter
data OrganizationEventFilter Source #
The values to filter results from the DescribeEventsForOrganization operation.
See: newOrganizationEventFilter
smart constructor.
OrganizationEventFilter' | |
|
Instances
newOrganizationEventFilter :: OrganizationEventFilter Source #
Create a value of OrganizationEventFilter
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:awsAccountIds:OrganizationEventFilter'
, organizationEventFilter_awsAccountIds
- A list of 12-digit Amazon Web Services account numbers that contains the
affected entities.
$sel:endTime:OrganizationEventFilter'
, organizationEventFilter_endTime
- Undocumented member.
$sel:entityArns:OrganizationEventFilter'
, organizationEventFilter_entityArns
- A list of entity ARNs (unique identifiers).
$sel:entityValues:OrganizationEventFilter'
, organizationEventFilter_entityValues
- A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or
EBS volumes (vol-426ab23e).
$sel:eventStatusCodes:OrganizationEventFilter'
, organizationEventFilter_eventStatusCodes
- A list of event status codes.
$sel:eventTypeCategories:OrganizationEventFilter'
, organizationEventFilter_eventTypeCategories
- 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:eventTypeCodes:OrganizationEventFilter'
, organizationEventFilter_eventTypeCodes
- A list of unique identifiers for event types. For example,
"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
$sel:lastUpdatedTime:OrganizationEventFilter'
, organizationEventFilter_lastUpdatedTime
- Undocumented member.
$sel:regions:OrganizationEventFilter'
, organizationEventFilter_regions
- A list of Amazon Web Services Regions.
$sel:services:OrganizationEventFilter'
, organizationEventFilter_services
- The Amazon Web Services services associated with the event. For example,
EC2
, RDS
.
$sel:startTime:OrganizationEventFilter'
, organizationEventFilter_startTime
- Undocumented member.
organizationEventFilter_awsAccountIds :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text)) Source #
A list of 12-digit Amazon Web Services account numbers that contains the affected entities.
organizationEventFilter_endTime :: Lens' OrganizationEventFilter (Maybe DateTimeRange) Source #
Undocumented member.
organizationEventFilter_entityArns :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text)) Source #
A list of entity ARNs (unique identifiers).
organizationEventFilter_entityValues :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text)) Source #
A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).
organizationEventFilter_eventStatusCodes :: Lens' OrganizationEventFilter (Maybe (NonEmpty EventStatusCode)) Source #
A list of event status codes.
organizationEventFilter_eventTypeCategories :: Lens' OrganizationEventFilter (Maybe (NonEmpty 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.
organizationEventFilter_eventTypeCodes :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text)) Source #
A list of unique identifiers for event types. For example,
"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
organizationEventFilter_lastUpdatedTime :: Lens' OrganizationEventFilter (Maybe DateTimeRange) Source #
Undocumented member.
organizationEventFilter_regions :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text)) Source #
A list of Amazon Web Services Regions.
organizationEventFilter_services :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text)) Source #
The Amazon Web Services services associated with the event. For example,
EC2
, RDS
.
organizationEventFilter_startTime :: Lens' OrganizationEventFilter (Maybe DateTimeRange) Source #
Undocumented member.