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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

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

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

Returns:

  • (String) 


497
498
499
500
501
502
503
504
505
506
 
# File 'lib/aws-sdk-ssmincidents/types.rb', line 497

class CreateTimelineEventInput < Struct.new(
  :client_token,
  :event_data,
  :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) 


497
498
499
500
501
502
503
504
505
506
 
# File 'lib/aws-sdk-ssmincidents/types.rb', line 497

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

#event_references ⇒ Array<Types::EventReference>

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.

Returns:



497
498
499
500
501
502
503
504
505
506
 
# File 'lib/aws-sdk-ssmincidents/types.rb', line 497

class CreateTimelineEventInput < Struct.new(
  :client_token,
  :event_data,
  :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) 


497
498
499
500
501
502
503
504
505
506
 
# File 'lib/aws-sdk-ssmincidents/types.rb', line 497

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

#event_type ⇒ String

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 `Note`and enter the Amazon Resource Name (ARN) of the incident as the value for `eventReference`.

Returns:

  • (String) 


497
498
499
500
501
502
503
504
505
506
 
# File 'lib/aws-sdk-ssmincidents/types.rb', line 497

class CreateTimelineEventInput < Struct.new(
  :client_token,
  :event_data,
  :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 record that the action adds the incident to.

Returns:

  • (String) 


497
498
499
500
501
502
503
504
505
506
 
# File 'lib/aws-sdk-ssmincidents/types.rb', line 497

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