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

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

Overview

Note:

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

{
  filters: [
    {
      condition: { # required
        after: Time.now,
        before: Time.now,
        equals: {
          integer_values: [1],
          string_values: ["StringListMemberString"],
        },
      },
      key: "FilterKeyString", # required
    },
  ],
  incident_record_arn: "Arn", # required
  max_results: 1,
  next_token: "NextToken",
  sort_by: "EVENT_TIME", # accepts EVENT_TIME
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::Filter>

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

  • 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:



1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1535

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

#incident_record_arnString

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

Returns:

  • (String)


1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1535

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

#max_resultsInteger

The maximum number of results per page.

Returns:

  • (Integer)


1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1535

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

#next_tokenString

The pagination token to continue to the next page of results.

Returns:

  • (String)


1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1535

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

#sort_byString

Sort by the specified key value pair.

Returns:

  • (String)


1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1535

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

#sort_orderString

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

Returns:

  • (String)


1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1535

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