Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- 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
- _InvalidPaginationToken :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedLocale :: AsError a => Getting (First ServiceError) 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_lastUpdatedTime :: Lens' AffectedEntity (Maybe UTCTime)
- affectedEntity_entityValue :: Lens' AffectedEntity (Maybe Text)
- affectedEntity_entityUrl :: Lens' AffectedEntity (Maybe Text)
- affectedEntity_awsAccountId :: Lens' AffectedEntity (Maybe Text)
- affectedEntity_eventArn :: Lens' AffectedEntity (Maybe Text)
- affectedEntity_entityArn :: Lens' AffectedEntity (Maybe Text)
- affectedEntity_tags :: Lens' AffectedEntity (Maybe (HashMap Text Text))
- affectedEntity_statusCode :: Lens' AffectedEntity (Maybe EntityStatusCode)
- data DateTimeRange = DateTimeRange' {}
- newDateTimeRange :: DateTimeRange
- dateTimeRange_to :: Lens' DateTimeRange (Maybe UTCTime)
- dateTimeRange_from :: Lens' DateTimeRange (Maybe UTCTime)
- data EntityAggregate = EntityAggregate' {}
- newEntityAggregate :: EntityAggregate
- entityAggregate_count :: Lens' EntityAggregate (Maybe Int)
- entityAggregate_eventArn :: Lens' EntityAggregate (Maybe Text)
- data EntityFilter = EntityFilter' {
- statusCodes :: Maybe (NonEmpty EntityStatusCode)
- entityArns :: Maybe (NonEmpty Text)
- entityValues :: Maybe (NonEmpty Text)
- tags :: Maybe [HashMap Text Text]
- lastUpdatedTimes :: Maybe (NonEmpty DateTimeRange)
- eventArns :: NonEmpty Text
- newEntityFilter :: NonEmpty Text -> EntityFilter
- entityFilter_statusCodes :: Lens' EntityFilter (Maybe (NonEmpty EntityStatusCode))
- entityFilter_entityArns :: Lens' EntityFilter (Maybe (NonEmpty Text))
- entityFilter_entityValues :: Lens' EntityFilter (Maybe (NonEmpty Text))
- entityFilter_tags :: Lens' EntityFilter (Maybe [HashMap Text Text])
- entityFilter_lastUpdatedTimes :: Lens' EntityFilter (Maybe (NonEmpty DateTimeRange))
- entityFilter_eventArns :: Lens' EntityFilter (NonEmpty Text)
- data Event = Event' {
- lastUpdatedTime :: Maybe POSIX
- arn :: Maybe Text
- service :: Maybe Text
- startTime :: Maybe POSIX
- eventScopeCode :: Maybe EventScopeCode
- eventTypeCode :: Maybe Text
- eventTypeCategory :: Maybe EventTypeCategory
- availabilityZone :: Maybe Text
- endTime :: Maybe POSIX
- region :: Maybe Text
- statusCode :: Maybe EventStatusCode
- newEvent :: Event
- event_lastUpdatedTime :: Lens' Event (Maybe UTCTime)
- event_arn :: Lens' Event (Maybe Text)
- event_service :: Lens' Event (Maybe Text)
- event_startTime :: Lens' Event (Maybe UTCTime)
- event_eventScopeCode :: Lens' Event (Maybe EventScopeCode)
- event_eventTypeCode :: Lens' Event (Maybe Text)
- event_eventTypeCategory :: Lens' Event (Maybe EventTypeCategory)
- event_availabilityZone :: Lens' Event (Maybe Text)
- event_endTime :: Lens' Event (Maybe UTCTime)
- event_region :: Lens' Event (Maybe Text)
- 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_count :: Lens' EventAggregate (Maybe Int)
- eventAggregate_aggregateValue :: Lens' EventAggregate (Maybe Text)
- 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_eventArn :: Lens' EventDetailsErrorItem (Maybe Text)
- eventDetailsErrorItem_errorName :: Lens' EventDetailsErrorItem (Maybe Text)
- eventDetailsErrorItem_errorMessage :: Lens' EventDetailsErrorItem (Maybe Text)
- data EventFilter = EventFilter' {
- eventArns :: Maybe (NonEmpty Text)
- eventTypeCategories :: Maybe (NonEmpty EventTypeCategory)
- eventTypeCodes :: Maybe (NonEmpty Text)
- regions :: Maybe (NonEmpty Text)
- eventStatusCodes :: Maybe (NonEmpty EventStatusCode)
- endTimes :: Maybe (NonEmpty DateTimeRange)
- availabilityZones :: Maybe [Text]
- entityArns :: Maybe (NonEmpty Text)
- entityValues :: Maybe (NonEmpty Text)
- startTimes :: Maybe (NonEmpty DateTimeRange)
- services :: Maybe (NonEmpty Text)
- tags :: Maybe [HashMap Text Text]
- lastUpdatedTimes :: Maybe (NonEmpty DateTimeRange)
- newEventFilter :: EventFilter
- eventFilter_eventArns :: Lens' EventFilter (Maybe (NonEmpty Text))
- eventFilter_eventTypeCategories :: Lens' EventFilter (Maybe (NonEmpty EventTypeCategory))
- eventFilter_eventTypeCodes :: Lens' EventFilter (Maybe (NonEmpty Text))
- eventFilter_regions :: Lens' EventFilter (Maybe (NonEmpty Text))
- eventFilter_eventStatusCodes :: Lens' EventFilter (Maybe (NonEmpty EventStatusCode))
- eventFilter_endTimes :: Lens' EventFilter (Maybe (NonEmpty DateTimeRange))
- eventFilter_availabilityZones :: Lens' EventFilter (Maybe [Text])
- eventFilter_entityArns :: Lens' EventFilter (Maybe (NonEmpty Text))
- eventFilter_entityValues :: Lens' EventFilter (Maybe (NonEmpty Text))
- eventFilter_startTimes :: Lens' EventFilter (Maybe (NonEmpty DateTimeRange))
- eventFilter_services :: Lens' EventFilter (Maybe (NonEmpty Text))
- eventFilter_tags :: Lens' EventFilter (Maybe [HashMap Text Text])
- eventFilter_lastUpdatedTimes :: Lens' EventFilter (Maybe (NonEmpty DateTimeRange))
- data EventType = EventType' {}
- newEventType :: EventType
- eventType_service :: Lens' EventType (Maybe Text)
- eventType_category :: Lens' EventType (Maybe EventTypeCategory)
- eventType_code :: 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_eventArn :: Lens' OrganizationAffectedEntitiesErrorItem (Maybe Text)
- organizationAffectedEntitiesErrorItem_errorName :: Lens' OrganizationAffectedEntitiesErrorItem (Maybe Text)
- organizationAffectedEntitiesErrorItem_errorMessage :: Lens' OrganizationAffectedEntitiesErrorItem (Maybe Text)
- data OrganizationEvent = OrganizationEvent' {}
- newOrganizationEvent :: OrganizationEvent
- organizationEvent_lastUpdatedTime :: Lens' OrganizationEvent (Maybe UTCTime)
- organizationEvent_arn :: Lens' OrganizationEvent (Maybe Text)
- organizationEvent_service :: Lens' OrganizationEvent (Maybe Text)
- organizationEvent_startTime :: Lens' OrganizationEvent (Maybe UTCTime)
- organizationEvent_eventScopeCode :: Lens' OrganizationEvent (Maybe EventScopeCode)
- organizationEvent_eventTypeCode :: Lens' OrganizationEvent (Maybe Text)
- organizationEvent_eventTypeCategory :: Lens' OrganizationEvent (Maybe EventTypeCategory)
- organizationEvent_endTime :: Lens' OrganizationEvent (Maybe UTCTime)
- organizationEvent_region :: Lens' OrganizationEvent (Maybe Text)
- organizationEvent_statusCode :: Lens' OrganizationEvent (Maybe EventStatusCode)
- data OrganizationEventDetails = OrganizationEventDetails' {}
- newOrganizationEventDetails :: OrganizationEventDetails
- organizationEventDetails_event :: Lens' OrganizationEventDetails (Maybe Event)
- organizationEventDetails_eventDescription :: Lens' OrganizationEventDetails (Maybe EventDescription)
- organizationEventDetails_awsAccountId :: Lens' OrganizationEventDetails (Maybe Text)
- organizationEventDetails_eventMetadata :: Lens' OrganizationEventDetails (Maybe (HashMap Text Text))
- data OrganizationEventDetailsErrorItem = OrganizationEventDetailsErrorItem' {}
- newOrganizationEventDetailsErrorItem :: OrganizationEventDetailsErrorItem
- organizationEventDetailsErrorItem_awsAccountId :: Lens' OrganizationEventDetailsErrorItem (Maybe Text)
- organizationEventDetailsErrorItem_eventArn :: Lens' OrganizationEventDetailsErrorItem (Maybe Text)
- organizationEventDetailsErrorItem_errorName :: Lens' OrganizationEventDetailsErrorItem (Maybe Text)
- organizationEventDetailsErrorItem_errorMessage :: Lens' OrganizationEventDetailsErrorItem (Maybe Text)
- data OrganizationEventFilter = OrganizationEventFilter' {
- lastUpdatedTime :: Maybe DateTimeRange
- awsAccountIds :: Maybe (NonEmpty Text)
- eventTypeCategories :: Maybe (NonEmpty EventTypeCategory)
- eventTypeCodes :: Maybe (NonEmpty Text)
- startTime :: Maybe DateTimeRange
- regions :: Maybe (NonEmpty Text)
- eventStatusCodes :: Maybe (NonEmpty EventStatusCode)
- endTime :: Maybe DateTimeRange
- entityArns :: Maybe (NonEmpty Text)
- entityValues :: Maybe (NonEmpty Text)
- services :: Maybe (NonEmpty Text)
- newOrganizationEventFilter :: OrganizationEventFilter
- organizationEventFilter_lastUpdatedTime :: Lens' OrganizationEventFilter (Maybe DateTimeRange)
- organizationEventFilter_awsAccountIds :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text))
- organizationEventFilter_eventTypeCategories :: Lens' OrganizationEventFilter (Maybe (NonEmpty EventTypeCategory))
- organizationEventFilter_eventTypeCodes :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text))
- organizationEventFilter_startTime :: Lens' OrganizationEventFilter (Maybe DateTimeRange)
- organizationEventFilter_regions :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text))
- organizationEventFilter_eventStatusCodes :: Lens' OrganizationEventFilter (Maybe (NonEmpty EventStatusCode))
- organizationEventFilter_endTime :: Lens' OrganizationEventFilter (Maybe DateTimeRange)
- organizationEventFilter_entityArns :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text))
- organizationEventFilter_entityValues :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text))
- organizationEventFilter_services :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text))
Service Configuration
defaultService :: Service Source #
API version 2016-08-04
of the Amazon Health APIs and Notifications SDK configuration.
Errors
_InvalidPaginationToken :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified pagination token (nextToken
) is not valid.
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) 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.
_UnsupportedLocale :: AsError a => Getting (First ServiceError) 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:lastUpdatedTime:AffectedEntity'
, affectedEntity_lastUpdatedTime
- The most recent time that the entity was updated.
$sel:entityValue:AffectedEntity'
, affectedEntity_entityValue
- The ID of the affected entity.
$sel:entityUrl:AffectedEntity'
, affectedEntity_entityUrl
- The URL of the affected entity.
$sel:awsAccountId:AffectedEntity'
, affectedEntity_awsAccountId
- The 12-digit AWS account number that contains 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: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:tags:AffectedEntity'
, affectedEntity_tags
- A map of entity tags attached to the affected entity.
Currently, the tags
property isn't supported.
$sel:statusCode:AffectedEntity'
, affectedEntity_statusCode
- The most recent status of the entity affected by the event. The possible
values are IMPAIRED
, UNIMPAIRED
, and UNKNOWN
.
affectedEntity_lastUpdatedTime :: Lens' AffectedEntity (Maybe UTCTime) Source #
The most recent time that the entity was updated.
affectedEntity_entityValue :: Lens' AffectedEntity (Maybe Text) Source #
The ID of the affected entity.
affectedEntity_entityUrl :: Lens' AffectedEntity (Maybe Text) Source #
The URL of the affected entity.
affectedEntity_awsAccountId :: Lens' AffectedEntity (Maybe Text) Source #
The 12-digit AWS account number that contains 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_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_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.
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
.
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:to:DateTimeRange'
, dateTimeRange_to
- The ending date and time of a time range.
$sel:from:DateTimeRange'
, dateTimeRange_from
- 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.
dateTimeRange_from :: Lens' DateTimeRange (Maybe UTCTime) Source #
The starting 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 EntityFilter 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:statusCodes:EntityFilter'
, entityFilter_statusCodes
- A list of entity status codes (IMPAIRED
, UNIMPAIRED
, or UNKNOWN
).
$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:tags:EntityFilter'
, entityFilter_tags
- A map of entity tags attached to the affected entity.
Currently, the tags
property isn't supported.
$sel:lastUpdatedTimes:EntityFilter'
, entityFilter_lastUpdatedTimes
- A list of the most recent dates and times that the entity was updated.
$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_statusCodes :: Lens' EntityFilter (Maybe (NonEmpty EntityStatusCode)) Source #
A list of entity status codes (IMPAIRED
, UNIMPAIRED
, or UNKNOWN
).
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_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_lastUpdatedTimes :: Lens' EntityFilter (Maybe (NonEmpty DateTimeRange)) Source #
A list of the most recent dates and times that the entity was updated.
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 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.
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:lastUpdatedTime:Event'
, event_lastUpdatedTime
- The most recent date and time that the event was updated.
$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:service:Event'
, event_service
- The AWS 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:eventScopeCode:Event'
, event_eventScopeCode
- This parameter specifies if the AWS Health event is a public AWS 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 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 isNONE
, then theeventArn
that you specified in the request is invalid or doesn't exist.
$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:eventTypeCategory:Event'
, event_eventTypeCategory
- The category of the event. Possible values are issue
,
scheduledChange
, and accountNotification
.
$sel:availabilityZone:Event'
, event_availabilityZone
- The AWS Availability Zone of the event. For example, us-east-1a.
$sel:endTime:Event'
, event_endTime
- The date and time that the event ended.
$sel:region:Event'
, event_region
- The AWS Region name of the event.
$sel:statusCode:Event'
, event_statusCode
- The most recent status of the event. Possible values are open
,
closed
, and upcoming
.
event_lastUpdatedTime :: Lens' Event (Maybe UTCTime) Source #
The most recent date and time that the event was updated.
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_service :: Lens' Event (Maybe Text) Source #
The AWS service that is affected by the event. For example, EC2
,
RDS
.
event_eventScopeCode :: Lens' Event (Maybe EventScopeCode) Source #
This parameter specifies if the AWS Health event is a public AWS 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 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 isNONE
, then theeventArn
that you specified in the request is invalid or doesn't exist.
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_eventTypeCategory :: Lens' Event (Maybe EventTypeCategory) Source #
The category of the event. Possible values are issue
,
scheduledChange
, and accountNotification
.
event_availabilityZone :: Lens' Event (Maybe Text) Source #
The AWS Availability Zone of the event. For example, us-east-1a.
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 AWS 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 AWS 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:count:EventAggregate'
, eventAggregate_count
- The number of events of the associated issue type.
$sel:aggregateValue:EventAggregate'
, eventAggregate_aggregateValue
- The issue type for the associated count.
eventAggregate_count :: Lens' EventAggregate (Maybe Int) Source #
The number of events of the associated issue type.
eventAggregate_aggregateValue :: Lens' EventAggregate (Maybe Text) Source #
The issue type for the associated count.
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: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
$sel:errorName:EventDetailsErrorItem'
, eventDetailsErrorItem_errorName
- The name of the error.
$sel:errorMessage:EventDetailsErrorItem'
, eventDetailsErrorItem_errorMessage
- A message that describes 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
eventDetailsErrorItem_errorName :: Lens' EventDetailsErrorItem (Maybe Text) Source #
The name of the error.
eventDetailsErrorItem_errorMessage :: Lens' EventDetailsErrorItem (Maybe Text) Source #
A message that describes the error.
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: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:eventTypeCategories:EventFilter'
, eventFilter_eventTypeCategories
- A list of event type category codes (issue
, scheduledChange
, or
accountNotification
).
$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:regions:EventFilter'
, eventFilter_regions
- A list of AWS Regions.
$sel:eventStatusCodes:EventFilter'
, eventFilter_eventStatusCodes
- A list of event status codes.
$sel:endTimes:EventFilter'
, eventFilter_endTimes
- A list of dates and times that the event ended.
$sel:availabilityZones:EventFilter'
, eventFilter_availabilityZones
- A list of AWS Availability Zones.
$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:startTimes:EventFilter'
, eventFilter_startTimes
- A list of dates and times that the event began.
$sel:services:EventFilter'
, eventFilter_services
- The AWS services associated with the event. For example, EC2
, RDS
.
$sel:tags:EventFilter'
, eventFilter_tags
- A map of entity tags attached to the affected entity.
Currently, the tags
property isn't supported.
$sel:lastUpdatedTimes:EventFilter'
, eventFilter_lastUpdatedTimes
- A list of dates and times that the event was last updated.
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_eventTypeCategories :: Lens' EventFilter (Maybe (NonEmpty EventTypeCategory)) Source #
A list of event type category codes (issue
, scheduledChange
, or
accountNotification
).
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_regions :: Lens' EventFilter (Maybe (NonEmpty Text)) Source #
A list of AWS Regions.
eventFilter_eventStatusCodes :: Lens' EventFilter (Maybe (NonEmpty EventStatusCode)) Source #
A list of event status codes.
eventFilter_endTimes :: Lens' EventFilter (Maybe (NonEmpty DateTimeRange)) Source #
A list of dates and times that the event ended.
eventFilter_availabilityZones :: Lens' EventFilter (Maybe [Text]) Source #
A list of AWS Availability Zones.
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_startTimes :: Lens' EventFilter (Maybe (NonEmpty DateTimeRange)) Source #
A list of dates and times that the event began.
eventFilter_services :: Lens' EventFilter (Maybe (NonEmpty Text)) Source #
The AWS services associated with the event. For example, EC2
, RDS
.
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.
eventFilter_lastUpdatedTimes :: Lens' EventFilter (Maybe (NonEmpty DateTimeRange)) Source #
A list of dates and times that the event was last updated.
EventType
Contains the metadata about a type of event that is reported by AWS
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 AWS Health delivers a specific event to your AWS account. For more information, see Monitor for AWS Health events with Amazon CloudWatch Events in the AWS Health User Guide.
See: newEventType
smart constructor.
EventType' | |
|
Instances
Eq EventType Source # | |
Read EventType Source # | |
Show EventType Source # | |
Generic EventType Source # | |
NFData EventType Source # | |
Defined in Amazonka.AWSHealth.Types.EventType | |
Hashable EventType Source # | |
Defined in Amazonka.AWSHealth.Types.EventType | |
FromJSON EventType Source # | |
type Rep EventType Source # | |
Defined in Amazonka.AWSHealth.Types.EventType type Rep EventType = D1 ('MetaData "EventType" "Amazonka.AWSHealth.Types.EventType" "libZSservicesZSamazonka-healthZSamazonka-health" 'False) (C1 ('MetaCons "EventType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "service") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "category") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventTypeCategory)) :*: S1 ('MetaSel ('Just "code") '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:service:EventType'
, eventType_service
- The AWS service that is affected by the event. For example, EC2
,
RDS
.
$sel:category:EventType'
, eventType_category
- A list of event type category codes (issue
, scheduledChange
, or
accountNotification
).
$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
.
eventType_service :: Lens' EventType (Maybe Text) Source #
The AWS 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 (issue
, scheduledChange
, or
accountNotification
).
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
.
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 (issue
, scheduledChange
, or
accountNotification
).
$sel:eventTypeCodes:EventTypeFilter'
, eventTypeFilter_eventTypeCodes
- A list of event type codes.
$sel:services:EventTypeFilter'
, eventTypeFilter_services
- The AWS services associated with the event. For example, EC2
, RDS
.
eventTypeFilter_eventTypeCategories :: Lens' EventTypeFilter (Maybe (NonEmpty EventTypeCategory)) Source #
A list of event type category codes (issue
, scheduledChange
, or
accountNotification
).
eventTypeFilter_eventTypeCodes :: Lens' EventTypeFilter (Maybe (NonEmpty Text)) Source #
A list of event type codes.
eventTypeFilter_services :: Lens' EventTypeFilter (Maybe (NonEmpty Text)) Source #
The AWS 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 AWS account numbers that contains the affected entities.
$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
$sel:errorName:OrganizationAffectedEntitiesErrorItem'
, organizationAffectedEntitiesErrorItem_errorName
- The name of the error.
$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
.
organizationAffectedEntitiesErrorItem_awsAccountId :: Lens' OrganizationAffectedEntitiesErrorItem (Maybe Text) Source #
The 12-digit AWS account numbers that contains the affected entities.
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
organizationAffectedEntitiesErrorItem_errorName :: Lens' OrganizationAffectedEntitiesErrorItem (Maybe Text) Source #
The name of the error.
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
.
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:lastUpdatedTime:OrganizationEvent'
, organizationEvent_lastUpdatedTime
- The most recent date and time that the event was updated.
$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:service:OrganizationEvent'
, organizationEvent_service
- The AWS 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:eventScopeCode:OrganizationEvent'
, organizationEvent_eventScopeCode
- This parameter specifies if the AWS Health event is a public AWS 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 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 isNONE
, then theeventArn
that you specified in the request is invalid or doesn't exist.
$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:eventTypeCategory:OrganizationEvent'
, organizationEvent_eventTypeCategory
- The category of the event type.
$sel:endTime:OrganizationEvent'
, organizationEvent_endTime
- The date and time that the event ended.
$sel:region:OrganizationEvent'
, organizationEvent_region
- The AWS Region name of the event.
$sel:statusCode:OrganizationEvent'
, organizationEvent_statusCode
- The most recent status of the event. Possible values are open
,
closed
, and upcoming
.
organizationEvent_lastUpdatedTime :: Lens' OrganizationEvent (Maybe UTCTime) Source #
The most recent date and time that the event was updated.
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_service :: Lens' OrganizationEvent (Maybe Text) Source #
The AWS 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_eventScopeCode :: Lens' OrganizationEvent (Maybe EventScopeCode) Source #
This parameter specifies if the AWS Health event is a public AWS 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 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 isNONE
, then theeventArn
that you specified in the request is invalid or doesn't exist.
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_eventTypeCategory :: Lens' OrganizationEvent (Maybe EventTypeCategory) Source #
The category of the event type.
organizationEvent_endTime :: Lens' OrganizationEvent (Maybe UTCTime) Source #
The date and time that the event ended.
organizationEvent_region :: Lens' OrganizationEvent (Maybe Text) Source #
The AWS Region name of the event.
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:event:OrganizationEventDetails'
, organizationEventDetails_event
- Undocumented member.
$sel:eventDescription:OrganizationEventDetails'
, organizationEventDetails_eventDescription
- Undocumented member.
$sel:awsAccountId:OrganizationEventDetails'
, organizationEventDetails_awsAccountId
- The 12-digit AWS account numbers that contains the affected entities.
$sel:eventMetadata:OrganizationEventDetails'
, organizationEventDetails_eventMetadata
- Additional metadata about the event.
organizationEventDetails_event :: Lens' OrganizationEventDetails (Maybe Event) Source #
Undocumented member.
organizationEventDetails_eventDescription :: Lens' OrganizationEventDetails (Maybe EventDescription) Source #
Undocumented member.
organizationEventDetails_awsAccountId :: Lens' OrganizationEventDetails (Maybe Text) Source #
The 12-digit AWS account numbers that contains the affected entities.
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: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
$sel:errorName:OrganizationEventDetailsErrorItem'
, organizationEventDetailsErrorItem_errorName
- The name of the error.
$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 AWS account ID in the request.
- We couldn't find an account specific event for the specified AWS account. To find an event that is public, you must enter a null value for the AWS account ID in the request.
- Your AWS account doesn't include the AWS Support plan required to use the AWS Health API. You must have either a Business or Enterprise Support plan.
organizationEventDetailsErrorItem_awsAccountId :: Lens' OrganizationEventDetailsErrorItem (Maybe Text) Source #
Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.
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
organizationEventDetailsErrorItem_errorName :: Lens' OrganizationEventDetailsErrorItem (Maybe Text) Source #
The name of the error.
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 AWS account ID in the request.
- We couldn't find an account specific event for the specified AWS account. To find an event that is public, you must enter a null value for the AWS account ID in the request.
- Your AWS account doesn't include the AWS Support plan required to use the AWS Health API. You must have either a Business or Enterprise Support plan.
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:lastUpdatedTime:OrganizationEventFilter'
, organizationEventFilter_lastUpdatedTime
- Undocumented member.
$sel:awsAccountIds:OrganizationEventFilter'
, organizationEventFilter_awsAccountIds
- A list of 12-digit AWS account numbers that contains the affected
entities.
$sel:eventTypeCategories:OrganizationEventFilter'
, organizationEventFilter_eventTypeCategories
- A list of event type category codes (issue, scheduledChange, or
accountNotification).
$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:startTime:OrganizationEventFilter'
, organizationEventFilter_startTime
- Undocumented member.
$sel:regions:OrganizationEventFilter'
, organizationEventFilter_regions
- A list of AWS Regions.
$sel:eventStatusCodes:OrganizationEventFilter'
, organizationEventFilter_eventStatusCodes
- A list of event status codes.
$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:services:OrganizationEventFilter'
, organizationEventFilter_services
- The AWS services associated with the event. For example, EC2
, RDS
.
organizationEventFilter_lastUpdatedTime :: Lens' OrganizationEventFilter (Maybe DateTimeRange) Source #
Undocumented member.
organizationEventFilter_awsAccountIds :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text)) Source #
A list of 12-digit AWS account numbers that contains the affected entities.
organizationEventFilter_eventTypeCategories :: Lens' OrganizationEventFilter (Maybe (NonEmpty EventTypeCategory)) Source #
A list of event type category codes (issue, scheduledChange, or accountNotification).
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_startTime :: Lens' OrganizationEventFilter (Maybe DateTimeRange) Source #
Undocumented member.
organizationEventFilter_regions :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text)) Source #
A list of AWS Regions.
organizationEventFilter_eventStatusCodes :: Lens' OrganizationEventFilter (Maybe (NonEmpty EventStatusCode)) Source #
A list of event status codes.
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_services :: Lens' OrganizationEventFilter (Maybe (NonEmpty Text)) Source #
The AWS services associated with the event. For example, EC2
, RDS
.