SSMIncidents / Client / update_incident_record

update_incident_record#

SSMIncidents.Client.update_incident_record(**kwargs)#

Update the details of an incident record. You can use this operation to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat.

See also: AWS API Documentation

Request Syntax

response = client.update_incident_record(
    arn='string',
    chatChannel={
        'chatbotSns': [
            'string',
        ],
        'empty': {}

    },
    clientToken='string',
    impact=123,
    notificationTargets=[
        {
            'snsTopicArn': 'string'
        },
    ],
    status='OPEN'|'RESOLVED',
    summary='string',
    title='string'
)
Parameters:

  • arn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the incident record you are updating.

  • chatChannel (dict) –

    The Chatbot chat channel where responders can collaborate.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: chatbotSns, empty.

    • chatbotSns (list) –

      The Amazon SNS targets that Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the Amazon SNS topics.

      • (string) –

    • empty (dict) –

      Used to remove the chat channel from an incident record or response plan.

  • clientToken (string) –

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

    This field is autopopulated if not provided.

  • impact (integer) –

    Defines the impact of the incident to customers and applications. Providing an impact overwrites the impact provided by the response plan.

    Possible impacts:

    • 1 - Critical impact, 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 aren’t impacted by the problem yet.

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

  • notificationTargets (list) –

    The Amazon SNS targets that are notified when updates are made to an incident.

    Using multiple SNS topics creates redundancy in the event that a Region is down during the incident.

    • (dict) –

      The SNS targets that are notified when updates are made to an incident.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: snsTopicArn.

      • snsTopicArn (string) –

        The Amazon Resource Name (ARN) of the SNS topic.

  • status (string) – The status of the incident. An incident can be Open or Resolved.

  • summary (string) – A longer description of what occurred during the incident.

  • title (string) – A brief description of the incident.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • SSMIncidents.Client.exceptions.ThrottlingException

  • SSMIncidents.Client.exceptions.ResourceNotFoundException

  • SSMIncidents.Client.exceptions.AccessDeniedException

  • SSMIncidents.Client.exceptions.ValidationException

  • SSMIncidents.Client.exceptions.ConflictException

  • SSMIncidents.Client.exceptions.InternalServerException