Class: Aws::SSMIncidents::Types::StartIncidentInput

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 ensuring that the operation 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) 


2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
 
# File 'lib/aws-sdk-ssmincidents/types.rb', line 2176

class StartIncidentInput < Struct.new(
  :client_token,
  :impact,
  :related_items,
  :response_plan_arn,
  :title,
  :trigger_details)
  SENSITIVE = []
  include Aws::Structure
end

#impact ⇒ Integer

Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

**Supported impact codes**

  • ‘1` - Critical

  • ‘2` - High

  • ‘3` - Medium

  • ‘4` - Low

  • ‘5` - No Impact

Returns:

  • (Integer) 


2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
 
# File 'lib/aws-sdk-ssmincidents/types.rb', line 2176

class StartIncidentInput < Struct.new(
  :client_token,
  :impact,
  :related_items,
  :response_plan_arn,
  :title,
  :trigger_details)
  SENSITIVE = []
  include Aws::Structure
end

#related_items ⇒ Array<Types::RelatedItem>

Add related items to the incident for other responders to use. Related items are Amazon Web Services resources, external links, or files uploaded to an Amazon S3 bucket.

Returns:



2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
 
# File 'lib/aws-sdk-ssmincidents/types.rb', line 2176

class StartIncidentInput < Struct.new(
  :client_token,
  :impact,
  :related_items,
  :response_plan_arn,
  :title,
  :trigger_details)
  SENSITIVE = []
  include Aws::Structure
end

#response_plan_arn ⇒ String

The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident.

Returns:

  • (String) 


2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
 
# File 'lib/aws-sdk-ssmincidents/types.rb', line 2176

class StartIncidentInput < Struct.new(
  :client_token,
  :impact,
  :related_items,
  :response_plan_arn,
  :title,
  :trigger_details)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

Provide a title for the incident. Providing a title overwrites the title provided by the response plan.

Returns:

  • (String) 


2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
 
# File 'lib/aws-sdk-ssmincidents/types.rb', line 2176

class StartIncidentInput < Struct.new(
  :client_token,
  :impact,
  :related_items,
  :response_plan_arn,
  :title,
  :trigger_details)
  SENSITIVE = []
  include Aws::Structure
end

#trigger_details ⇒ Types::TriggerDetails

Details of what created the incident record in Incident Manager.

Returns:



2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
 
# File 'lib/aws-sdk-ssmincidents/types.rb', line 2176

class StartIncidentInput < Struct.new(
  :client_token,
  :impact,
  :related_items,
  :response_plan_arn,
  :title,
  :trigger_details)
  SENSITIVE = []
  include Aws::Structure
end