Skip to content

UpdateTimelineEventInput

Source code in docs_src/capo_ssm_incidents/types/update_timeline_event_input.py
class UpdateTimelineEventInput(TypedDict, closed=True):
    client_token: NotRequired["capo_ssm_incidents.types.client_token.ClientToken"]
    """<p>A token that ensures that a client calls the operation 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 that includes the timeline event.</p>"""
    event_id: "capo_ssm_incidents.types.uuid.UUID"
    """<p>The ID of the event to update. You can use <code>ListTimelineEvents</code> to find an event's ID.</p>"""
    event_time: NotRequired["datetime.datetime"]
    """<p>The timestamp for when the event occurred.</p>"""
    event_type: NotRequired[
        "capo_ssm_incidents.types.timeline_event_type.TimelineEventType"
    ]
    """<p>The type of event. You can update events of type <code>Custom Event</code> and <code>Note</code>.</p>"""
    event_data: NotRequired["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>Updates all existing references in a <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 that resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.</p> <important> <p>This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes any existing references and enters only new references.</p> </important>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

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

event_data instance-attribute

event_data: NotRequired[EventData]

A short description of the event.

event_id instance-attribute

event_id: UUID

The ID of the event to update. You can use ListTimelineEvents to find an event's ID.

event_references instance-attribute

event_references: NotRequired[EventReferenceList]

Updates all existing references in a 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 that resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.

This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes any existing references and enters only new references.

event_time instance-attribute

event_time: NotRequired[datetime]

The timestamp for when the event occurred.

event_type instance-attribute

event_type: NotRequired[TimelineEventType]

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

incident_record_arn instance-attribute

incident_record_arn: Arn

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