Skip to content

CreateTimelineEventInput

Source code in docs_src/capo_ssm_incidents/types/create_timeline_event_input.py
class CreateTimelineEventInput(TypedDict, closed=True):
    client_token: NotRequired["capo_ssm_incidents.types.client_token.ClientToken"]
    """<p>A token that ensures that a client calls the action only once with the specified details.</p>"""
    incident_record_arn: "capo_ssm_incidents.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the incident record that the action adds the incident to.</p>"""
    event_time: "datetime.datetime"
    """<p>The timestamp for when the event occurred.</p>"""
    event_type: "capo_ssm_incidents.types.timeline_event_type.TimelineEventType"
    """<p>The type of event. You can create timeline events of type <code>Custom Event</code> and <code>Note</code>.</p> <p>To make a Note-type event appear on the <i>Incident notes</i> panel in the console, specify <code>eventType</code> as <code>Note</code>and enter the Amazon Resource Name (ARN) of the incident as the value for <code>eventReference</code>.</p>"""
    event_data: "capo_ssm_incidents.types.event_data.EventData"
    """<p>A short description of the event.</p>"""
    event_references: NotRequired[
        "capo_ssm_incidents.types.event_reference_list.EventReferenceList"
    ]
    """<p>Adds one or more references to the <code>TimelineEvent</code>. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with a resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

A token that ensures that a client calls the action only once with the specified details.

event_data instance-attribute

event_data: EventData

A short description of the event.

event_references instance-attribute

event_references: NotRequired[EventReferenceList]

Adds one or more references to the TimelineEvent. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with a resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.

event_time instance-attribute

event_time: datetime

The timestamp for when the event occurred.

event_type instance-attribute

event_type: TimelineEventType

The type of event. You can create timeline events of type Custom Event and Note.

To make a Note-type event appear on the Incident notes panel in the console, specify eventType as Noteand enter the Amazon Resource Name (ARN) of the incident as the value for eventReference.

incident_record_arn instance-attribute

incident_record_arn: Arn

The Amazon Resource Name (ARN) of the incident record that the action adds the incident to.