amazonka-health-2.0: Amazon Health APIs and Notifications SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AWSHealth.Types.EntityAggregate

Description

 
Synopsis

Documentation

data EntityAggregate Source #

The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.

See: newEntityAggregate smart constructor.

Constructors

EntityAggregate' 

Fields

  • count :: Maybe Int

    The number of entities that match the criteria for the specified events.

  • 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

Instances

Instances details
FromJSON EntityAggregate Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.EntityAggregate

Generic EntityAggregate Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.EntityAggregate

Associated Types

type Rep EntityAggregate :: Type -> Type #

Read EntityAggregate Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.EntityAggregate

Show EntityAggregate Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.EntityAggregate

NFData EntityAggregate Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.EntityAggregate

Methods

rnf :: EntityAggregate -> () #

Eq EntityAggregate Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.EntityAggregate

Hashable EntityAggregate Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.EntityAggregate

type Rep EntityAggregate Source # 
Instance details

Defined in Amazonka.AWSHealth.Types.EntityAggregate

type Rep EntityAggregate = D1 ('MetaData "EntityAggregate" "Amazonka.AWSHealth.Types.EntityAggregate" "amazonka-health-2.0-97kQZARXu4I8k4sVSmOp5K" 'False) (C1 ('MetaCons "EntityAggregate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "eventArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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