list_insights_data ¶

def list_insights_data(
    self,
    insight_source: "capo_cloudtrail.types.resource_arn.ResourceArn",
    data_type: "capo_cloudtrail.types.list_insights_data_type.ListInsightsDataType",
    *,
    config_overrides: Optional[CloudTrailClientConfig] = None,
    dimensions: Optional[
        "capo_cloudtrail.types.list_insights_data_dimensions.ListInsightsDataDimensions"
    ] = None,
    start_time: Optional["capo_cloudtrail.types.date.Date"] = None,
    end_time: Optional["capo_cloudtrail.types.date.Date"] = None,
    max_results: Optional[
        "capo_cloudtrail.types.list_insights_data_max_results_count.ListInsightsDataMaxResultsCount"
    ] = None,
    next_token: Optional[
        "capo_cloudtrail.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_cloudtrail.types.list_insights_data_response.ListInsightsDataResponse":
    """<p>Returns Insights events generated on a trail that logs data events. You can list Insights events that occurred in a Region within the last 90 days.</p> <p>ListInsightsData supports the following Dimensions for Insights events:</p> <ul> <li> <p>Event ID</p> </li> <li> <p>Event name</p> </li> <li> <p>Event source</p> </li> </ul> <p>All dimensions are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.</p> <p>The rate of ListInsightsData requests is limited to two per second, per account, per Region. If this limit is exceeded, a throttling error occurs.</p> <note> <p>For data event Insights on organization trails, only the management account and delegated administrator accounts can call <code>ListInsightsData</code>. For these callers, the API returns Insights events only for the caller's own account. Member accounts cannot call this API on organization trails.</p> </note>

    Args:
        insight_source: <p>The Amazon Resource Name(ARN) of the trail for which you want to retrieve Insights events.</p>
        data_type: <p>Specifies the category of events returned. To fetch Insights events, specify <code>InsightsEvents</code> as the value of <code>DataType</code> </p>
        dimensions: <p>Contains a map of dimensions. Currently the map can contain only one item.</p>
        start_time: <p>Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.</p>
        end_time: <p>Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.</p>
        max_results: <p>The number of events to return. Possible values are 1 through 50. The default is 50.</p>
        next_token: <p>The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified a EventName as a dimension with <code>PutObject</code> as a value, the call with NextToken should include those same parameters. </p>

    Raises:
        capo_cloudtrail.errors.invalid_parameter_exception.InvalidParameterException: <p>The request includes a parameter that is not valid.</p>
        capo_cloudtrail.errors.operation_not_permitted_exception.OperationNotPermittedException: <p>This exception is thrown when the requested operation is not permitted.</p>
        capo_cloudtrail.errors.unsupported_operation_exception.UnsupportedOperationException: <p>This exception is thrown when the requested operation is not supported.</p>
        capo_cloudtrail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudtrail.types.list_insights_data_request.ListInsightsDataRequest]",
    ) -> OperationResponse[
        "capo_cloudtrail.types.list_insights_data_response.ListInsightsDataResponse"
    ]:
        import capo_cloudtrail._operations.cloud_trail_20131101.list_insights_data

        output, http_response = (
            capo_cloudtrail._operations.cloud_trail_20131101.list_insights_data.list_insights_data(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListInsightsData")
    )
    input_: capo_cloudtrail.types.list_insights_data_request.ListInsightsDataRequest = {
        "insight_source": insight_source,
        "data_type": data_type,
    }
    if dimensions is not None:
        input_["dimensions"] = dimensions
    if start_time is not None:
        input_["start_time"] = start_time
    if end_time is not None:
        input_["end_time"] = end_time
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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