describe_event_details `async` ¶

describe_event_details(
    event_arns: eventArnList,
    *,
    config_overrides: Optional[AsyncHealthClientConfig] = None,
    locale: Optional[locale] = None,
) -> DescribeEventDetailsResponse

Returns detailed information about one or more specified events. Information includes standard event data (Amazon Web Services Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve the entities, use the DescribeAffectedEntities operation.

If a specified event can't be retrieved, an error message is returned for that event.

This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.

Parameters:

event_arns (eventArnList) –

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"
locale (Optional[locale], default: None ) –

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

Raises:

UnsupportedLocale –

The specified locale is not supported.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_health/_services/async_health.py

async def describe_event_details(
    self,
    event_arns: "capo_health.types.event_arn_list.eventArnList",
    *,
    config_overrides: Optional[AsyncHealthClientConfig] = None,
    locale: Optional["capo_health.types.locale.locale"] = None,
) -> (
    "capo_health.types.describe_event_details_response.DescribeEventDetailsResponse"
):
    """<p>Returns detailed information about one or more specified events. Information includes standard event data (Amazon Web Services Region, service, and so on, as returned by <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html">DescribeEvents</a>), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve the entities, use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html">DescribeAffectedEntities</a> operation.</p> <p>If a specified event can't be retrieved, an error message is returned for that event.</p> <note> <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in the <i>Health User Guide</i>.</p> </note>

    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>
        locale: <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>

    Raises:
        capo_health.errors.unsupported_locale.UnsupportedLocale: <p>The specified locale is not supported.</p>
        capo_health.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_health.types.describe_event_details_request.DescribeEventDetailsRequest]",
    ) -> AsyncOperationResponse[
        "capo_health.types.describe_event_details_response.DescribeEventDetailsResponse"
    ]:
        import capo_health._operations.aws_health_20160804.describe_event_details

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEventDetails")
    )
    input_: capo_health.types.describe_event_details_request.DescribeEventDetailsRequest = {
        "event_arns": event_arns
    }
    if locale is not None:
        input_["locale"] = locale

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

describe_event_details async ¶

describe_event_details `async` ¶