SSMIncidents / Client / get_incident_record

get_incident_record#

SSMIncidents.Client.get_incident_record(**kwargs)#

Returns the details for the specified incident record.

See also: AWS API Documentation

Request Syntax

response = client.get_incident_record(
    arn='string'
)
Parameters:

arn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'incidentRecord': {
        'arn': 'string',
        'automationExecutions': [
            {
                'ssmExecutionArn': 'string'
            },
        ],
        'chatChannel': {
            'chatbotSns': [
                'string',
            ],
            'empty': {}
        },
        'creationTime': datetime(2015, 1, 1),
        'dedupeString': 'string',
        'impact': 123,
        'incidentRecordSource': {
            'createdBy': 'string',
            'invokedBy': 'string',
            'resourceArn': 'string',
            'source': 'string'
        },
        'lastModifiedBy': 'string',
        'lastModifiedTime': datetime(2015, 1, 1),
        'notificationTargets': [
            {
                'snsTopicArn': 'string'
            },
        ],
        'resolvedTime': datetime(2015, 1, 1),
        'status': 'OPEN'|'RESOLVED',
        'summary': 'string',
        'title': 'string'
    }
}

Response Structure

  • (dict) –

    • incidentRecord (dict) –

      Details the structure of the incident record.

      • arn (string) –

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

      • automationExecutions (list) –

        The runbook, or automation document, that’s run at the beginning of the incident.

        • (dict) –

          The Systems Manager automation document process to start as the runbook at the beginning of the incident.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: ssmExecutionArn. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • ssmExecutionArn (string) –

            The Amazon Resource Name (ARN) of the automation process.

      • chatChannel (dict) –

        The chat channel used for collaboration during an incident.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: chatbotSns, empty. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • 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.

      • creationTime (datetime) –

        The timestamp for when Incident Manager created the incident record.

      • dedupeString (string) –

        The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.

      • impact (integer) –

        The impact of the incident on customers and applications.

        Supported impact codes

        • 1 - Critical

        • 2 - High

        • 3 - Medium

        • 4 - Low

        • 5 - No Impact

      • incidentRecordSource (dict) –

        Details about the action that started the incident.

        • createdBy (string) –

          The principal that started the incident.

        • invokedBy (string) –

          The service principal that assumed the role specified in createdBy. If no service principal assumed the role this will be left blank.

        • resourceArn (string) –

          The resource that caused the incident to be created.

        • source (string) –

          The service that started the incident. This can be manually created from Incident Manager, automatically created using an Amazon CloudWatch alarm, or Amazon EventBridge event.

      • lastModifiedBy (string) –

        Who modified the incident most recently.

      • lastModifiedTime (datetime) –

        The timestamp for when the incident was most recently modified.

      • notificationTargets (list) –

        The Amazon SNS targets that are notified when updates are made to an 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 will be set: snsTopicArn. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • snsTopicArn (string) –

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

      • resolvedTime (datetime) –

        The timestamp for when the incident was resolved. This appears as a timeline event.

      • status (string) –

        The current status of the incident.

      • summary (string) –

        The summary of the incident. The summary is a brief synopsis of what occurred, what’s currently happening, and context of the incident.

      • title (string) –

        The title of the incident.

Exceptions