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

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 StartIncidentInput data as a hash:

{
  client_token: "ClientToken",
  impact: 1,
  related_items: [
    {
      identifier: { # required
        type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER
        value: { # required
          arn: "Arn",
          metric_definition: "MetricDefinition",
          url: "Url",
        },
      },
      title: "RelatedItemTitleString",
    },
  ],
  response_plan_arn: "Arn", # required
  title: "IncidentTitle",
  trigger_details: {
    raw_data: "RawData",
    source: "IncidentSource", # required
    timestamp: Time.now, # required
    trigger_arn: "Arn",
  },
}

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)


1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1984

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

#impactInteger

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

Possible impacts:

  • 1 - Critical impact, this typically relates to full application failure that impacts many to all customers.

  • 2 - High impact, partial application failure with impact to many customers.

  • 3 - Medium impact, the application is providing reduced service to customers.

  • 4 - Low impact, customer might aren't impacted by the problem yet.

  • 5 - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.

Returns:

  • (Integer)


1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1984

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

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

Returns:



1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1984

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

#response_plan_arnString

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

Returns:

  • (String)


1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1984

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

#titleString

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

Returns:

  • (String)


1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1984

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

#trigger_detailsTypes::TriggerDetails

Details of what created the incident record in Incident Manager.



1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1984

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