ListInsightsMetricData (smaws-clients.Smaws_Client_CloudTrail.ListInsightsMetricData)

Module Smaws_Client_CloudTrail.ListInsightsMetricData

Returns Insights metrics data for trails that have enabled Insights. The request must include the EventSource, EventName, and InsightType parameters.

If the InsightType is set to ApiErrorRateInsight, the request must also include the ErrorCode parameter.

The following are the available time periods for ListInsightsMetricData. Each cutoff is inclusive.

Data points with a period of 60 seconds (1-minute) are available for 15 days.

Data points with a period of 300 seconds (5-minute) are available for 63 days.

Data points with a period of 3600 seconds (1 hour) are available for 90 days.

To use ListInsightsMetricData operation, you must have the following permissions:

If ListInsightsMetricData is invoked with TrailName parameter, access to the ListInsightsMetricData API operation is linked to the cloudtrail:LookupEvents action and cloudtrail:ListInsightsData. To use this operation, you must have permissions to perform the cloudtrail:LookupEvents and cloudtrail:ListInsightsData action on the specific trail.

If ListInsightsMetricData is invoked without TrailName parameter, access to the ListInsightsMetricData API operation is linked to the cloudtrail:LookupEvents action only. To use this operation, you must have permissions to perform the cloudtrail:LookupEvents action.

val error_to_string : 
  [ Smaws_Lib.Protocols.AwsJson.error
  | `InvalidParameterException of Types.invalid_parameter_exception
  | `InvalidTrailNameException of Types.invalid_trail_name_exception
  | `OperationNotPermittedException of Types.operation_not_permitted_exception
  | `UnsupportedOperationException of Types.unsupported_operation_exception ] ->
  string

val request : 
  'http_type Smaws_Lib.Context.t ->
  Types.list_insights_metric_data_request ->
  (Types.list_insights_metric_data_response,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `InvalidParameterException of Types.invalid_parameter_exception
    | `InvalidTrailNameException of Types.invalid_trail_name_exception
    | `OperationNotPermittedException of
      Types.operation_not_permitted_exception
    | `UnsupportedOperationException of Types.unsupported_operation_exception ])
    Stdlib.result

val request_with_metadata : 
  'http_type Smaws_Lib.Context.t ->
  Types.list_insights_metric_data_request ->
  (Types.list_insights_metric_data_response Smaws_Lib.Response.t,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `InvalidParameterException of Types.invalid_parameter_exception
    | `InvalidTrailNameException of Types.invalid_trail_name_exception
    | `OperationNotPermittedException of
      Types.operation_not_permitted_exception
    | `UnsupportedOperationException of Types.unsupported_operation_exception ]
    * Smaws_Lib.Response.metadata)
    Stdlib.result