Skip to content

describe_entity_aggregates_for_organization async

describe_entity_aggregates_for_organization(
    event_arns: OrganizationEventArnsList,
    *,
    config_overrides: Optional[AsyncHealthClientConfig] = None,
    aws_account_ids: Optional[OrganizationAccountIdsList] = None,
) -> DescribeEntityAggregatesForOrganizationResponse

Returns a list of entity aggregates for your Organizations that are affected by each of the specified events.

Parameters:

  • event_arns (OrganizationEventArnsList) –

    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"

  • aws_account_ids (Optional[OrganizationAccountIdsList], default: None ) –

    A list of 12-digit Amazon Web Services account numbers that contains the affected entities.

Raises:

Source code in docs_src/capo_health/_services/async_health.py
async def describe_entity_aggregates_for_organization(
    self,
    event_arns: "capo_health.types.organization_event_arns_list.OrganizationEventArnsList",
    *,
    config_overrides: Optional[AsyncHealthClientConfig] = None,
    aws_account_ids: Optional[
        "capo_health.types.organization_account_ids_list.OrganizationAccountIdsList"
    ] = None,
) -> "capo_health.types.describe_entity_aggregates_for_organization_response.DescribeEntityAggregatesForOrganizationResponse":
    """<p>Returns a list of entity aggregates for your Organizations 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>
        aws_account_ids: <p>A list of 12-digit Amazon Web Services account numbers that contains the affected entities.</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_for_organization_request.DescribeEntityAggregatesForOrganizationRequest]",
    ) -> AsyncOperationResponse[
        "capo_health.types.describe_entity_aggregates_for_organization_response.DescribeEntityAggregatesForOrganizationResponse"
    ]:
        import capo_health._operations.aws_health_20160804.describe_entity_aggregates_for_organization

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

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeEntityAggregatesForOrganization"),
    )
    input_: capo_health.types.describe_entity_aggregates_for_organization_request.DescribeEntityAggregatesForOrganizationRequest = {
        "event_arns": event_arns
    }
    if aws_account_ids is not None:
        input_["aws_account_ids"] = aws_account_ids

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