SSMIncidents / Client / get_response_plan

get_response_plan#

SSMIncidents.Client.get_response_plan(**kwargs)#

Retrieves the details of the specified response plan.

See also: AWS API Documentation

Request Syntax

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

arn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the response plan.

Return type:

dict

Returns:

Response Syntax

{
    'actions': [
        {
            'ssmAutomation': {
                'documentName': 'string',
                'documentVersion': 'string',
                'dynamicParameters': {
                    'string': {
                        'variable': 'INCIDENT_RECORD_ARN'|'INVOLVED_RESOURCES'
                    }
                },
                'parameters': {
                    'string': [
                        'string',
                    ]
                },
                'roleArn': 'string',
                'targetAccount': 'RESPONSE_PLAN_OWNER_ACCOUNT'|'IMPACTED_ACCOUNT'
            }
        },
    ],
    'arn': 'string',
    'chatChannel': {
        'chatbotSns': [
            'string',
        ],
        'empty': {}
    },
    'displayName': 'string',
    'engagements': [
        'string',
    ],
    'incidentTemplate': {
        'dedupeString': 'string',
        'impact': 123,
        'incidentTags': {
            'string': 'string'
        },
        'notificationTargets': [
            {
                'snsTopicArn': 'string'
            },
        ],
        'summary': 'string',
        'title': 'string'
    },
    'integrations': [
        {
            'pagerDutyConfiguration': {
                'name': 'string',
                'pagerDutyIncidentConfiguration': {
                    'serviceId': 'string'
                },
                'secretId': 'string'
            }
        },
    ],
    'name': 'string'
}

Response Structure

  • (dict) –

    • actions (list) –

      The actions that this response plan takes at the beginning of the incident.

      • (dict) –

        The action that starts at the beginning of an incident. The response plan defines the action.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: ssmAutomation. 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'}

        • ssmAutomation (dict) –

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

          • documentName (string) –

            The automation document’s name.

          • documentVersion (string) –

            The automation document’s version to use when running.

          • dynamicParameters (dict) –

            The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.

            • (string) –

              • (dict) –

                The dynamic SSM parameter value.

                Note

                This is a Tagged Union structure. Only one of the following top level keys will be set: variable. 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'}

                • variable (string) –

                  Variable dynamic parameters. A parameter value is determined when an incident is created.

          • parameters (dict) –

            The key-value pair parameters to use when running the automation document.

            • (string) –

              • (list) –

                • (string) –

          • roleArn (string) –

            The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.

          • targetAccount (string) –

            The account that the automation document will be run in. This can be in either the management account or an application account.

    • arn (string) –

      The ARN of the response plan.

    • chatChannel (dict) –

      The Chatbot 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.

    • displayName (string) –

      The long format name of the response plan. Can contain spaces.

    • engagements (list) –

      The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

      • (string) –

    • incidentTemplate (dict) –

      Details used to create the incident when using this response plan.

      • dedupeString (string) –

        The string Incident Manager uses to prevent the same root cause from creating multiple incidents in the same account.

        A deduplication string is a term or phrase the system uses to check for duplicate incidents. If you specify a deduplication string, Incident Manager searches for open incidents that contain the same string in the dedupeString field when it creates the incident. If a duplicate is detected, Incident Manager deduplicates the newer incident into the existing incident.

        Note

        By default, Incident Manager automatically deduplicates multiple incidents created by the same Amazon CloudWatch alarm or Amazon EventBridge event. You don’t have to enter your own deduplication string to prevent duplication for these resource types.

      • impact (integer) –

        The impact of the incident on your customers and applications.

        Supported impact codes

        • 1 - Critical

        • 2 - High

        • 3 - Medium

        • 4 - Low

        • 5 - No Impact

      • incidentTags (dict) –

        Tags to assign to the template. When the StartIncident API action is called, Incident Manager assigns the tags specified in the template to the incident.

        • (string) –

          • (string) –

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

      • summary (string) –

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

      • title (string) –

        The title of the incident.

    • integrations (list) –

      Information about third-party services integrated into the Incident Manager response plan.

      • (dict) –

        Information about third-party services integrated into a response plan.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: pagerDutyConfiguration. 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'}

        • pagerDutyConfiguration (dict) –

          Information about the PagerDuty service where the response plan creates an incident.

          • name (string) –

            The name of the PagerDuty configuration.

          • pagerDutyIncidentConfiguration (dict) –

            Details about the PagerDuty service associated with the configuration.

            • serviceId (string) –

              The ID of the PagerDuty service that the response plan associates with an incident when it launches.

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

    • name (string) –

      The short format name of the response plan. The name can’t contain spaces.

Exceptions

  • SSMIncidents.Client.exceptions.ThrottlingException

  • SSMIncidents.Client.exceptions.ResourceNotFoundException

  • SSMIncidents.Client.exceptions.AccessDeniedException

  • SSMIncidents.Client.exceptions.ValidationException

  • SSMIncidents.Client.exceptions.InternalServerException