Class: Aws::XRay::Types::GetInsightSummariesRequest

Inherits:

Struct

• Object
• Struct
• Aws::XRay::Types::GetInsightSummariesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-xray/types.rb

Overview

Note:

When making an API call, you may pass GetInsightSummariesRequest data as a hash:

{
  states: ["ACTIVE"], # accepts ACTIVE, CLOSED
  group_arn: "GroupARN",
  group_name: "GroupName",
  start_time: Time.now, # required
  end_time: Time.now, # required
  max_results: 1,
  next_token: "Token",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #end_time ⇒ Time

  The end of the time frame in which the insights ended.

• #group_arn ⇒ String

  The Amazon Resource Name (ARN) of the group.

• #group_name ⇒ String

  The name of the group.

• #max_results ⇒ Integer

  The maximum number of results to display.

• #next_token ⇒ String

  Pagination token.

• #start_time ⇒ Time

  The beginning of the time frame in which the insights started.

• #states ⇒ Array<String>

  The list of insight states.

Instance Attribute Details

#end_time ⇒ Time

The end of the time frame in which the insights ended. The end time can’t be more than 30 days old.

Returns:

• (Time)

# File 'lib/aws-sdk-xray/types.rb', line 1075

class GetInsightSummariesRequest < Struct.new(
  :states,
  :group_arn,
  :group_name,
  :start_time,
  :end_time,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#group_arn ⇒ String

The Amazon Resource Name (ARN) of the group. Required if the GroupName isn’t provided.

Returns:

• (String)

# File 'lib/aws-sdk-xray/types.rb', line 1075

class GetInsightSummariesRequest < Struct.new(
  :states,
  :group_arn,
  :group_name,
  :start_time,
  :end_time,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#group_name ⇒ String

The name of the group. Required if the GroupARN isn’t provided.

Returns:

• (String)

# File 'lib/aws-sdk-xray/types.rb', line 1075

class GetInsightSummariesRequest < Struct.new(
  :states,
  :group_arn,
  :group_name,
  :start_time,
  :end_time,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to display.

Returns:

• (Integer)

# File 'lib/aws-sdk-xray/types.rb', line 1075

class GetInsightSummariesRequest < Struct.new(
  :states,
  :group_arn,
  :group_name,
  :start_time,
  :end_time,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

Pagination token.

Returns:

• (String)

# File 'lib/aws-sdk-xray/types.rb', line 1075

class GetInsightSummariesRequest < Struct.new(
  :states,
  :group_arn,
  :group_name,
  :start_time,
  :end_time,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The beginning of the time frame in which the insights started. The start time can’t be more than 30 days old.

Returns:

• (Time)

# File 'lib/aws-sdk-xray/types.rb', line 1075

class GetInsightSummariesRequest < Struct.new(
  :states,
  :group_arn,
  :group_name,
  :start_time,
  :end_time,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#states ⇒ Array<String>

The list of insight states.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-xray/types.rb', line 1075

class GetInsightSummariesRequest < Struct.new(
  :states,
  :group_arn,
  :group_name,
  :start_time,
  :end_time,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end