SSMIncidents / Client / start_incident

start_incident#

SSMIncidents.Client.start_incident(**kwargs)#

Used to start an incident from CloudWatch alarms, EventBridge events, or manually.

See also: AWS API Documentation

Request Syntax

response = client.start_incident(
    clientToken='string',
    impact=123,
    relatedItems=[
        {
            'generatedId': 'string',
            'identifier': {
                'type': 'ANALYSIS'|'INCIDENT'|'METRIC'|'PARENT'|'ATTACHMENT'|'OTHER'|'AUTOMATION'|'INVOLVED_RESOURCE'|'TASK',
                'value': {
                    'arn': 'string',
                    'metricDefinition': 'string',
                    'pagerDutyIncidentDetail': {
                        'autoResolve': True|False,
                        'id': 'string',
                        'secretId': 'string'
                    },
                    'url': 'string'
                }
            },
            'title': 'string'
        },
    ],
    responsePlanArn='string',
    title='string',
    triggerDetails={
        'rawData': 'string',
        'source': 'string',
        'timestamp': datetime(2015, 1, 1),
        'triggerArn': 'string'
    }
)
Parameters:

  • clientToken (string) –

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

    This field is autopopulated if not provided.

  • 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

  • relatedItems (list) –

    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.

    • (dict) –

      Resources that responders use to triage and mitigate the incident.

      • generatedId (string) –

        A unique ID for a RelatedItem.

        Warning

        Don’t specify this parameter when you add a RelatedItem by using the UpdateRelatedItems API action.

      • identifier (dict) – [REQUIRED]

        Details about the related item.

        • type (string) – [REQUIRED]

          The type of related item.

        • value (dict) – [REQUIRED]

          Details about the related item.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: arn, metricDefinition, pagerDutyIncidentDetail, url.

          • arn (string) –

            The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.

          • metricDefinition (string) –

            The metric definition, if the related item is a metric in Amazon CloudWatch.

          • pagerDutyIncidentDetail (dict) –

            Details about an incident that is associated with a PagerDuty incident.

            • autoResolve (boolean) –

              Indicates whether to resolve the PagerDuty incident when you resolve the associated Incident Manager incident.

            • id (string) – [REQUIRED]

              The ID of the incident associated with the PagerDuty service for the response plan.

            • secretId (string) –

              The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.

          • url (string) –

            The URL, if the related item is a non-Amazon Web Services resource.

      • title (string) –

        The title of the related item.

  • responsePlanArn (string) –

    [REQUIRED]

    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.

  • title (string) – Provide a title for the incident. Providing a title overwrites the title provided by the response plan.

  • triggerDetails (dict) –

    Details of what created the incident record in Incident Manager.

    • rawData (string) –

      Raw data passed from either Amazon EventBridge, Amazon CloudWatch, or Incident Manager when an incident is created.

    • source (string) – [REQUIRED]

      Identifies the service that sourced the event. All events sourced from within Amazon Web Services begin with “ aws.” Customer-generated events can have any value here, as long as it doesn’t begin with “ aws.” We recommend the use of Java package-name style reverse domain-name strings.

    • timestamp (datetime) – [REQUIRED]

      The timestamp for when the incident was detected.

    • triggerArn (string) –

      The Amazon Resource Name (ARN) of the source that detected the incident.

Return type:

dict

Returns:

Response Syntax

{
    'incidentRecordArn': 'string'
}

Response Structure

  • (dict) –

    • incidentRecordArn (string) –

      The ARN of the newly created incident record.

Exceptions