Class: Aws::CloudTrail::Types::ListInsightsMetricDataResponse

Inherits:

Struct

• Object
• Struct
• Aws::CloudTrail::Types::ListInsightsMetricDataResponse

Includes:

Structure

Defined in:

lib/aws-sdk-cloudtrail/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #error_code ⇒ String

  Only returned if InsightType parameter was set to ApiErrorRateInsight.

• #event_name ⇒ String

  The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

• #event_source ⇒ String

  The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

• #insight_type ⇒ String

  The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight.

• #next_token ⇒ String

  Only returned if the full results could not be returned in a single query.

• #timestamps ⇒ Array<Time>

  List of timestamps at intervals corresponding to the specified time period.

• #trail_arn ⇒ String

  Specifies the ARN of the trail.

• #values ⇒ Array<Float>

  List of values representing the API call rate or error rate at each timestamp.

Instance Attribute Details

#error_code ⇒ String

Only returned if InsightType parameter was set to ApiErrorRateInsight.

If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.

Returns:

• (String)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 3745

class ListInsightsMetricDataResponse < Struct.new(
  :trail_arn,
  :event_source,
  :event_name,
  :insight_type,
  :error_code,
  :timestamps,
  :values,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#event_name ⇒ String

The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

Returns:

• (String)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 3745

class ListInsightsMetricDataResponse < Struct.new(
  :trail_arn,
  :event_source,
  :event_name,
  :insight_type,
  :error_code,
  :timestamps,
  :values,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#event_source ⇒ String

The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

Returns:

• (String)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 3745

class ListInsightsMetricDataResponse < Struct.new(
  :trail_arn,
  :event_source,
  :event_name,
  :insight_type,
  :error_code,
  :timestamps,
  :values,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#insight_type ⇒ String

The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.

Returns:

• (String)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 3745

class ListInsightsMetricDataResponse < Struct.new(
  :trail_arn,
  :event_source,
  :event_name,
  :insight_type,
  :error_code,
  :timestamps,
  :values,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

Only returned if the full results could not be returned in a single query. You can set the NextToken parameter in the next request to this value to continue retrieval.

Returns:

• (String)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 3745

class ListInsightsMetricDataResponse < Struct.new(
  :trail_arn,
  :event_source,
  :event_name,
  :insight_type,
  :error_code,
  :timestamps,
  :values,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#timestamps ⇒ Array<Time>

List of timestamps at intervals corresponding to the specified time period.

Returns:

• (Array<Time>)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 3745

class ListInsightsMetricDataResponse < Struct.new(
  :trail_arn,
  :event_source,
  :event_name,
  :insight_type,
  :error_code,
  :timestamps,
  :values,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#trail_arn ⇒ String

Specifies the ARN of the trail. This is only returned when Insights is enabled on a trail logging data events.

Returns:

• (String)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 3745

class ListInsightsMetricDataResponse < Struct.new(
  :trail_arn,
  :event_source,
  :event_name,
  :insight_type,
  :error_code,
  :timestamps,
  :values,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#values ⇒ Array<Float>

List of values representing the API call rate or error rate at each timestamp. The number of values is equal to the number of timestamps.

Returns:

• (Array<Float>)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 3745

class ListInsightsMetricDataResponse < Struct.new(
  :trail_arn,
  :event_source,
  :event_name,
  :insight_type,
  :error_code,
  :timestamps,
  :values,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end