Class: Aws::SSMIncidents::Types::UpdateTimelineEventInput

Inherits:

Struct

• Object
• Struct
• Aws::SSMIncidents::Types::UpdateTimelineEventInput

Defined in:

gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

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

• #event_data ⇒ String

  A short description of the event.

• #event_id ⇒ String

  The ID of the event to update.

• #event_references ⇒ Array<Types::EventReference>

  Updates all existing references in a TimelineEvent.

• #event_time ⇒ Time

  The timestamp for when the event occurred.

• #event_type ⇒ String

  The type of event.

• #incident_record_arn ⇒ String

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

Instance Attribute Details

#client_token ⇒ String

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

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2703

class UpdateTimelineEventInput < Struct.new(
  :client_token,
  :event_data,
  :event_id,
  :event_references,
  :event_time,
  :event_type,
  :incident_record_arn)
  SENSITIVE = []
  include Aws::Structure
end

#event_data ⇒ String

A short description of the event.

Returns:

• (String)

# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2703

class UpdateTimelineEventInput < Struct.new(
  :client_token,
  :event_data,
  :event_id,
  :event_references,
  :event_time,
  :event_type,
  :incident_record_arn)
  SENSITIVE = []
  include Aws::Structure
end

#event_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2703

class UpdateTimelineEventInput < Struct.new(
  :client_token,
  :event_data,
  :event_id,
  :event_references,
  :event_time,
  :event_type,
  :incident_record_arn)
  SENSITIVE = []
  include Aws::Structure
end

#event_references ⇒ Array<Types::EventReference>

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.

Returns:

• (Array<Types::EventReference>)

# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2703

class UpdateTimelineEventInput < Struct.new(
  :client_token,
  :event_data,
  :event_id,
  :event_references,
  :event_time,
  :event_type,
  :incident_record_arn)
  SENSITIVE = []
  include Aws::Structure
end

#event_time ⇒ Time

The timestamp for when the event occurred.

Returns:

• (Time)

# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2703

class UpdateTimelineEventInput < Struct.new(
  :client_token,
  :event_data,
  :event_id,
  :event_references,
  :event_time,
  :event_type,
  :incident_record_arn)
  SENSITIVE = []
  include Aws::Structure
end

#event_type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2703

class UpdateTimelineEventInput < Struct.new(
  :client_token,
  :event_data,
  :event_id,
  :event_references,
  :event_time,
  :event_type,
  :incident_record_arn)
  SENSITIVE = []
  include Aws::Structure
end

#incident_record_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 2703

class UpdateTimelineEventInput < Struct.new(
  :client_token,
  :event_data,
  :event_id,
  :event_references,
  :event_time,
  :event_type,
  :incident_record_arn)
  SENSITIVE = []
  include Aws::Structure
end