Class: Aws::SSMIncidents::Types::ListTimelineEventsInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filters ⇒ Array<Types::Filter>

Filters the timeline events based on the provided conditional values. You can filter timeline events with the following keys:

  • eventReference

  • eventTime

  • eventType

Note the following when deciding how to use Filters:

  • If you don't specify a Filter, the response includes all timeline events.

  • If you specify more than one filter in a single request, the response returns timeline events that match all filters.

  • If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.

Returns:



1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1666

class ListTimelineEventsInput < Struct.new(
  :filters,
  :incident_record_arn,
  :max_results,
  :next_token,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#incident_record_arn ⇒ String

The Amazon Resource Name (ARN) of the incident that includes the timeline event.

Returns:

  • (String) 


1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1666

class ListTimelineEventsInput < Struct.new(
  :filters,
  :incident_record_arn,
  :max_results,
  :next_token,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results per page.

Returns:

  • (Integer) 


1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1666

class ListTimelineEventsInput < Struct.new(
  :filters,
  :incident_record_arn,
  :max_results,
  :next_token,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The pagination token for the next set of items to return. (You received this token from a previous call.)

Returns:

  • (String) 


1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1666

class ListTimelineEventsInput < Struct.new(
  :filters,
  :incident_record_arn,
  :max_results,
  :next_token,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#sort_by ⇒ String

Sort timeline events by the specified key value pair.

Returns:

  • (String) 


1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1666

class ListTimelineEventsInput < Struct.new(
  :filters,
  :incident_record_arn,
  :max_results,
  :next_token,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#sort_order ⇒ String

Sorts the order of timeline events by the value specified in the sortBy field.

Returns:

  • (String) 


1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1666

class ListTimelineEventsInput < Struct.new(
  :filters,
  :incident_record_arn,
  :max_results,
  :next_token,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end