Skip to content

get_insight_results async

get_insight_results(
    insight_arn: NonEmptyString,
    *,
    config_overrides: Optional[AsyncSecurityHubClientConfig] = None,
) -> GetInsightResultsResponse

Lists the results of the Security Hub CSPM insight specified by the insight ARN.

Parameters:

  • insight_arn (NonEmptyString) –

    The ARN of the insight for which to return results.

Raises:

  • InternalException –

    Internal server error.

  • InvalidAccessException –

    The account doesn't have permission to perform this action.

  • InvalidInputException –

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException –

    The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceNotFoundException –

    The request was rejected because we can't find the specified resource.

  • UnknownServiceError –

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

Examples:

To get the results of a Security Hub insight The following example returns the results of the Security Hub insight specified by the insight ARN.

>>> await client.get_insight_results(insight_arn='arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111')
Source code in docs_src/capo_securityhub/_services/async_security_hub.py
async def get_insight_results(
    self,
    insight_arn: "capo_securityhub.types.non_empty_string.NonEmptyString",
    *,
    config_overrides: Optional[AsyncSecurityHubClientConfig] = None,
) -> (
    "capo_securityhub.types.get_insight_results_response.GetInsightResultsResponse"
):
    """<p>Lists the results of the Security Hub CSPM insight specified by the insight ARN.</p>

    Args:
        insight_arn: <p>The ARN of the insight for which to return results.</p>

    Raises:
        capo_securityhub.errors.internal_exception.InternalException: <p>Internal server error.</p>
        capo_securityhub.errors.invalid_access_exception.InvalidAccessException: <p>The account doesn't have permission to perform this action.</p>
        capo_securityhub.errors.invalid_input_exception.InvalidInputException: <p>The request was rejected because you supplied an invalid or out-of-range value for an input parameter.</p>
        capo_securityhub.errors.limit_exceeded_exception.LimitExceededException: <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.</p>
        capo_securityhub.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request was rejected because we can't find the specified resource.</p>
        capo_securityhub.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To get the results of a Security Hub insight
        The following example returns the results of the Security Hub insight specified by the insight ARN.

        >>> await client.get_insight_results(insight_arn='arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_securityhub.types.get_insight_results_request.GetInsightResultsRequest]",
    ) -> AsyncOperationResponse[
        "capo_securityhub.types.get_insight_results_response.GetInsightResultsResponse"
    ]:
        import capo_securityhub._operations.security_hub_api_service.get_insight_results

        (
            output,
            http_response,
        ) = await capo_securityhub._operations.security_hub_api_service.get_insight_results.async_get_insight_results(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetInsightResults")
    )
    input_: capo_securityhub.types.get_insight_results_request.GetInsightResultsRequest = {
        "insight_arn": insight_arn
    }

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