SSMIncidents / Client / list_timeline_events

list_timeline_events#

SSMIncidents.Client.list_timeline_events(**kwargs)#

Lists timeline events for the specified incident record.

See also: AWS API Documentation

Request Syntax

response = client.list_timeline_events(
    filters=[
        {
            'condition': {
                'after': datetime(2015, 1, 1),
                'before': datetime(2015, 1, 1),
                'equals': {
                    'integerValues': [
                        123,
                    ],
                    'stringValues': [
                        'string',
                    ]
                }
            },
            'key': 'string'
        },
    ],
    incidentRecordArn='string',
    maxResults=123,
    nextToken='string',
    sortBy='EVENT_TIME',
    sortOrder='ASCENDING'|'DESCENDING'
)
Parameters:

  • filters (list) –

    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.

    • (dict) –

      Filter the selection by using a condition.

      • condition (dict) – [REQUIRED]

        The condition accepts before or after a specified time, equal to a string, or equal to an integer.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: after, before, equals.

        • after (datetime) –

          After the specified timestamp.

        • before (datetime) –

          Before the specified timestamp

        • equals (dict) –

          The value is equal to the provided string or integer.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: integerValues, stringValues.

          • integerValues (list) –

            The list of integer values that the filter matches.

            • (integer) –

          • stringValues (list) –

            The list of string values that the filter matches.

            • (string) –

      • key (string) – [REQUIRED]

        The key that you’re filtering on.

  • incidentRecordArn (string) –

    [REQUIRED]

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

  • maxResults (integer) – The maximum number of results per page.

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

  • sortBy (string) – Sort timeline events by the specified key value pair.

  • sortOrder (string) – Sorts the order of timeline events by the value specified in the sortBy field.

Return type:

dict

Returns:

Response Syntax

{
    'eventSummaries': [
        {
            'eventId': 'string',
            'eventReferences': [
                {
                    'relatedItemId': 'string',
                    'resource': 'string'
                },
            ],
            'eventTime': datetime(2015, 1, 1),
            'eventType': 'string',
            'eventUpdatedTime': datetime(2015, 1, 1),
            'incidentRecordArn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • eventSummaries (list) –

      Details about each event that occurred during the incident.

      • (dict) –

        Details about a timeline event during an incident.

        • eventId (string) –

          The timeline event ID.

        • eventReferences (list) –

          A list of references in a TimelineEvent.

          • (dict) –

            An item referenced in a TimelineEvent that is involved in or somehow associated with an incident. You can specify an Amazon Resource Name (ARN) for an Amazon Web Services resource or a RelatedItem ID.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: relatedItemId, resource. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

            • relatedItemId (string) –

              The ID of a RelatedItem referenced in a TimelineEvent.

            • resource (string) –

              The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a TimelineEvent.

        • eventTime (datetime) –

          The timestamp for when the event occurred.

        • eventType (string) –

          The type of event. The timeline event must be Custom Event or Note.

        • eventUpdatedTime (datetime) –

          The timestamp for when the timeline event was last updated.

        • incidentRecordArn (string) –

          The Amazon Resource Name (ARN) of the incident that the event happened during.

    • nextToken (string) –

      The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.

Exceptions