NAME

Paws::SSMIncidents::StartIncident - Arguments for method StartIncident on Paws::SSMIncidents

DESCRIPTION

This class represents the parameters used for calling the method StartIncident on the AWS Systems Manager Incident Manager service. Use the attributes of this class as arguments to method StartIncident.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartIncident.

SYNOPSIS

    my $ssm-incidents = Paws->service('SSMIncidents');
    my $StartIncidentOutput = $ssm -incidents->StartIncident(
      ResponsePlanArn => 'MyArn',
      ClientToken     => 'MyClientToken',    # OPTIONAL
      Impact          => 1,                  # OPTIONAL
      RelatedItems    => [
        {
          Identifier => {
            Type => 'ANALYSIS'
            ,    # values: ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER
            Value => {
              Arn              => 'MyArn',                 # max: 1000
              MetricDefinition => 'MyMetricDefinition',    # max: 4000; OPTIONAL
              Url              => 'MyUrl',                 # max: 1000; OPTIONAL
            },
          },
          Title => 'MyRelatedItemTitleString',             # max: 200; OPTIONAL
        },
        ...
      ],    # OPTIONAL
      Title          => 'MyIncidentTitle',    # OPTIONAL
      TriggerDetails => {
        Source     => 'MyIncidentSource',      # max: 50
        Timestamp  => '1970-01-01T01:00:00',
        RawData    => 'MyRawData',             # max: 4000; OPTIONAL
        TriggerArn => 'MyArn',                 # max: 1000
      },    # OPTIONAL
    );
    # Results:
    my $IncidentRecordArn = $StartIncidentOutput->IncidentRecordArn;
    # Returns a L<Paws::SSMIncidents::StartIncidentOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/ssm-incidents/StartIncident>

ATTRIBUTES

ClientToken => Str

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

Impact => Int

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.

RelatedItems => ArrayRef[Paws::SSMIncidents::RelatedItem]

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.

REQUIRED ResponsePlanArn => Str

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

Title => Str

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

TriggerDetails => Paws::SSMIncidents::TriggerDetails

Details of what created the incident record in Incident Manager.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>