AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::SSMIncidents::Types::CreateTimelineEventInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb

Overview

Note:

When making an API call, you may pass CreateTimelineEventInput data as a hash:

{
  client_token: "ClientToken",
  event_data: "EventData", # required
  event_time: Time.now, # required
  event_type: "TimelineEventType", # required
  incident_record_arn: "Arn", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

A token ensuring that the action is called only once with the specified details.

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

Returns:

  • (String)


415
416
417
418
419
420
421
422
423
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 415

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

#event_dataString

A valid JSON string. There is no other schema imposed. A short description of the event.

Returns:

  • (String)


415
416
417
418
419
420
421
422
423
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 415

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

#event_timeTime

The time that the event occurred.

Returns:

  • (Time)


415
416
417
418
419
420
421
422
423
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 415

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

#event_typeString

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

Returns:

  • (String)


415
416
417
418
419
420
421
422
423
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 415

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

#incident_record_arnString

The Amazon Resource Name (ARN) of the incident record you are adding the event to.

Returns:

  • (String)


415
416
417
418
419
420
421
422
423
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 415

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