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 |
Synopsis
- 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))
Documentation
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.