describe_insight_details ¶

def describe_insight_details(
    self,
    entity: "capo_opensearch.types.insight_entity.InsightEntity",
    insight_id: "capo_opensearch.types.guid.GUID",
    *,
    config_overrides: Optional[OpenSearchClientConfig] = None,
    show_html_content: Optional["capo_opensearch.types.boolean.Boolean"] = None,
) -> "capo_opensearch.types.describe_insight_details_response.DescribeInsightDetailsResponse":
    """<p>Describes the details of an existing insight for an Amazon OpenSearch Service domain. Returns detailed fields associated with the specified insight, such as text descriptions and metric data.</p>

    Args:
        entity: <p>The entity for which to retrieve insight details. Specifies the type and value of the entity, such as a domain name or Amazon Web Services account ID.</p>
        insight_id: <p>The unique identifier of the insight to describe.</p>
        show_html_content: <p>Specifies whether to show response with HTML content in response or not.</p>

    Raises:
        capo_opensearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_opensearch.errors.disabled_operation_exception.DisabledOperationException: <p>An error occured because the client wanted to access an unsupported operation.</p>
        capo_opensearch.errors.internal_exception.InternalException: <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
        capo_opensearch.errors.limit_exceeded_exception.LimitExceededException: <p>An exception for trying to create more than the allowed number of resources or sub-resources.</p>
        capo_opensearch.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.validation_exception.ValidationException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_opensearch.types.describe_insight_details_request.DescribeInsightDetailsRequest]",
    ) -> OperationResponse[
        "capo_opensearch.types.describe_insight_details_response.DescribeInsightDetailsResponse"
    ]:
        import capo_opensearch._operations.amazon_open_search_service.describe_insight_details

        output, http_response = (
            capo_opensearch._operations.amazon_open_search_service.describe_insight_details.describe_insight_details(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeInsightDetails")
    )
    input_: capo_opensearch.types.describe_insight_details_request.DescribeInsightDetailsRequest = {
        "entity": entity,
        "insight_id": insight_id,
    }
    if show_html_content is not None:
        input_["show_html_content"] = show_html_content

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output