SSMIncidents / Client / get_timeline_event

get_timeline_event#

SSMIncidents.Client.get_timeline_event(**kwargs)#

Retrieves a timeline event based on its ID and incident record.

See also: AWS API Documentation

Request Syntax

response = client.get_timeline_event(
    eventId='string',
    incidentRecordArn='string'
)
Parameters:

  • eventId (string) –

    [REQUIRED]

    The ID of the event. You can get an event’s ID when you create it, or by using ListTimelineEvents.

  • incidentRecordArn (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • event (dict) –

      Details about the timeline event.

      • eventData (string) –

        A short description of the event.

      • eventId (string) –

        The ID of the timeline event.

      • 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 that occurred. Currently Incident Manager supports only the Custom Event and Note types.

      • 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 occurred during.

Exceptions