Skip to content

describe_entity_aggregates async

describe_entity_aggregates(
    *,
    config_overrides: Optional[AsyncHealthClientConfig] = None,
    event_arns: Optional[EventArnsList] = None,
) -> DescribeEntityAggregatesResponse

Returns the number of entities that are affected by each of the specified events.

Parameters:

  • event_arns (Optional[EventArnsList], default: None ) –

    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"

Raises:

Source code in docs_src/capo_health/_services/async_health.py
async def describe_entity_aggregates(
    self,
    *,
    config_overrides: Optional[AsyncHealthClientConfig] = None,
    event_arns: Optional["capo_health.types.event_arns_list.EventArnsList"] = None,
) -> "capo_health.types.describe_entity_aggregates_response.DescribeEntityAggregatesResponse":
    """<p>Returns the number of entities that are affected by each of the specified events.</p>

    Args:
        event_arns: <p>A list of event ARNs (unique identifiers). For example: <code>"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"</code> </p>

    Raises:
        capo_health.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_health.types.describe_entity_aggregates_request.DescribeEntityAggregatesRequest]",
    ) -> AsyncOperationResponse[
        "capo_health.types.describe_entity_aggregates_response.DescribeEntityAggregatesResponse"
    ]:
        import capo_health._operations.aws_health_20160804.describe_entity_aggregates

        (
            output,
            http_response,
        ) = await capo_health._operations.aws_health_20160804.describe_entity_aggregates.async_describe_entity_aggregates(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEntityAggregates")
    )
    input_: capo_health.types.describe_entity_aggregates_request.DescribeEntityAggregatesRequest = {}
    if event_arns is not None:
        input_["event_arns"] = event_arns

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output