libZSservicesZSamazonka-healthZSamazonka-health
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AWSHealth.Types.AffectedEntity

Description

 
Synopsis

Documentation

data AffectedEntity Source #

Information about an entity that is affected by a Health event.

See: newAffectedEntity smart constructor.

Constructors

AffectedEntity' 

Fields

  • lastUpdatedTime :: Maybe POSIX

    The most recent time that the entity was updated.

  • entityValue :: Maybe Text

    The ID of the affected entity.

  • entityUrl :: Maybe Text

    The URL of the affected entity.

  • awsAccountId :: Maybe Text

    The 12-digit AWS account number that contains the affected entity.

  • eventArn :: Maybe Text

    The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.

    For example, an event ARN might look like the following:

    arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
  • entityArn :: Maybe Text

    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

  • tags :: Maybe (HashMap Text Text)

    A map of entity tags attached to the affected entity.

    Currently, the tags property isn't supported.

  • statusCode :: Maybe EntityStatusCode

    The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, and UNKNOWN.

Instances

Instances details
Eq AffectedEntity Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.AffectedEntity

Read AffectedEntity Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.AffectedEntity

Show AffectedEntity Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.AffectedEntity

Generic AffectedEntity Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.AffectedEntity

Associated Types

type Rep AffectedEntity :: Type -> Type #

NFData AffectedEntity Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.AffectedEntity

Methods

rnf :: AffectedEntity -> () #

Hashable AffectedEntity Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.AffectedEntity

FromJSON AffectedEntity Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.AffectedEntity

type Rep AffectedEntity Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.AffectedEntity

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.