SSMIncidents

Client

class SSMIncidents.Client

A low-level client representing AWS Systems Manager Incident Manager (SSM Incidents)

Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An incident is any unplanned interruption or reduction in quality of services.

Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation.

client = session.create_client('ssm-incidents')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_replication_set(**kwargs)

A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.

See also: AWS API Documentation

Request Syntax

response = client.create_replication_set(
    clientToken='string',
    regions={
        'string': {
            'sseKmsKeyId': '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.

  • regions (dict) --

    [REQUIRED]

    The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.

    • (string) --
      • (dict) --

        The mapping between a Amazon Web Services Region and the key that's used to encrypt the data.

        • sseKmsKeyId (string) --

          The KMS key used to encrypt the data in your replication set.

Return type

dict

Returns

Response Syntax

{
    'arn': 'string'
}

Response Structure

  • (dict) --

    • arn (string) --

      The Amazon Resource Name (ARN) of the replication set.

Exceptions

create_response_plan(**kwargs)

Creates a response plan that automates the initial response to incidents. A response plan engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning of an incident.

See also: AWS API Documentation

Request Syntax

response = client.create_response_plan(
    actions=[
        {
            'ssmAutomation': {
                'documentName': 'string',
                'documentVersion': 'string',
                'parameters': {
                    'string': [
                        'string',
                    ]
                },
                'roleArn': 'string',
                'targetAccount': 'RESPONSE_PLAN_OWNER_ACCOUNT'|'IMPACTED_ACCOUNT'
            }
        },
    ],
    chatChannel={
        'chatbotSns': [
            'string',
        ],
        'empty': {}

    },
    clientToken='string',
    displayName='string',
    engagements=[
        'string',
    ],
    incidentTemplate={
        'dedupeString': 'string',
        'impact': 123,
        'notificationTargets': [
            {
                'snsTopicArn': 'string'
            },
        ],
        'summary': 'string',
        'title': 'string'
    },
    name='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • actions (list) --

    The actions that the response plan starts at the beginning of an 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 can be set: ssmAutomation.

      • ssmAutomation (dict) --

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

        • documentName (string) -- [REQUIRED]

          The automation document's name.

        • documentVersion (string) --

          The automation document's version to use when running.

        • parameters (dict) --

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

          • (string) --
            • (list) --
              • (string) --
        • roleArn (string) -- [REQUIRED]

          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.

  • 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 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 ensuring that the operation is called only once with the specified details.

    This field is autopopulated if not provided.

  • displayName (string) -- The long format of the response plan name. This field can contain spaces.
  • engagements (list) --

    The contacts and escalation plans that the response plan engages during an incident.

    • (string) --
  • incidentTemplate (dict) --

    [REQUIRED]

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

    • dedupeString (string) --

      Used to stop Incident Manager from creating multiple incident records for the same incident.

    • impact (integer) -- [REQUIRED]

      The impact of the incident on your customers and applications.

    • 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 can be set: snsTopicArn.

        • 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) -- [REQUIRED]

      The title of the incident.

  • name (string) --

    [REQUIRED]

    The short format name of the response plan. Can't include spaces.

  • tags (dict) --

    A list of tags that you are adding to the response plan.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'arn': 'string'
}

Response Structure

  • (dict) --

    • arn (string) --

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

Exceptions

create_timeline_event(**kwargs)

Creates a custom timeline event on the incident details page of an incident record. Timeline events are automatically created by Incident Manager, marking key moment during an incident. You can create custom timeline events to mark important events that are automatically detected by Incident Manager.

See also: AWS API Documentation

Request Syntax

response = client.create_timeline_event(
    clientToken='string',
    eventData='string',
    eventTime=datetime(2015, 1, 1),
    eventType='string',
    incidentRecordArn='string'
)
Parameters
  • clientToken (string) --

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

    This field is autopopulated if not provided.

  • eventData (string) --

    [REQUIRED]

    A short description of the event as a valid JSON string. There is no other schema imposed.

  • eventTime (datetime) --

    [REQUIRED]

    The time that the event occurred.

  • eventType (string) --

    [REQUIRED]

    The type of the event. You can create timeline events of type Custom Event .

  • incidentRecordArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the incident record to which the event will be added.

Return type

dict

Returns

Response Syntax

{
    'eventId': 'string',
    'incidentRecordArn': 'string'
}

Response Structure

  • (dict) --

    • eventId (string) --

      The ID of the event for easy reference later.

    • incidentRecordArn (string) --

      The ARN of the incident record that you added the event to.

Exceptions

delete_incident_record(**kwargs)

Delete an incident record from Incident Manager.

See also: AWS API Documentation

Request Syntax

response = client.delete_incident_record(
    arn='string'
)
Parameters
arn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_replication_set(**kwargs)

Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data.

See also: AWS API Documentation

Request Syntax

response = client.delete_replication_set(
    arn='string'
)
Parameters
arn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the replication set you're deleting.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_resource_policy(**kwargs)

Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource.

See also: AWS API Documentation

Request Syntax

response = client.delete_resource_policy(
    policyId='string',
    resourceArn='string'
)
Parameters
  • policyId (string) --

    [REQUIRED]

    The ID of the resource policy you're deleting.

  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource you're deleting the policy from.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_response_plan(**kwargs)

Deletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this response plan.

See also: AWS API Documentation

Request Syntax

response = client.delete_response_plan(
    arn='string'
)
Parameters
arn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_timeline_event(**kwargs)

Deletes a timeline event from an incident.

See also: AWS API Documentation

Request Syntax

response = client.delete_timeline_event(
    eventId='string',
    incidentRecordArn='string'
)
Parameters
  • eventId (string) --

    [REQUIRED]

    The ID of the event you are updating. You can find this by using ListTimelineEvents .

  • incidentRecordArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the incident that includes the timeline event.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

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 time that 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.

      • incidentRecordSource (dict) --

        Details about the action that started the incident.

        • createdBy (string) --

          The principal that started the incident.

        • invokedBy (string) --

          The principal the assumed the role specified of the createdBy .

        • 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 time at which 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 time at which 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

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_replication_set(**kwargs)

Retrieve your Incident Manager replication set.

See also: AWS API Documentation

Request Syntax

response = client.get_replication_set(
    arn='string'
)
Parameters
arn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the replication set you want to retrieve.

Return type
dict
Returns
Response Syntax
{
    'replicationSet': {
        'arn': 'string',
        'createdBy': 'string',
        'createdTime': datetime(2015, 1, 1),
        'deletionProtected': True|False,
        'lastModifiedBy': 'string',
        'lastModifiedTime': datetime(2015, 1, 1),
        'regionMap': {
            'string': {
                'sseKmsKeyId': 'string',
                'status': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED',
                'statusMessage': 'string',
                'statusUpdateDateTime': datetime(2015, 1, 1)
            }
        },
        'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'FAILED'
    }
}

Response Structure

  • (dict) --
    • replicationSet (dict) --

      Details of the replication set.

      • arn (string) --

        The Amazon Resource Name (ARN) of the replication set.

      • createdBy (string) --

        Details about who created the replication set.

      • createdTime (datetime) --

        When the replication set was created.

      • deletionProtected (boolean) --

        Determines if the replication set deletion protection is enabled or not. If deletion protection is enabled, you can't delete the last Amazon Web Services Region in the replication set.

      • lastModifiedBy (string) --

        Who last modified the replication set.

      • lastModifiedTime (datetime) --

        When the replication set was last updated.

      • regionMap (dict) --

        The map between each Amazon Web Services Region in your replication set and the KMS key that's used to encrypt the data in that Region.

        • (string) --
          • (dict) --

            Information about a Amazon Web Services Region in your replication set.

            • sseKmsKeyId (string) --

              The ID of the KMS key used to encrypt the data in this Amazon Web Services Region.

            • status (string) --

              The status of the Amazon Web Services Region in the replication set.

            • statusMessage (string) --

              Information displayed about the status of the Amazon Web Services Region.

            • statusUpdateDateTime (datetime) --

              The most recent date and time that Incident Manager updated the Amazon Web Services Region's status.

      • status (string) --

        The status of the replication set. If the replication set is still pending, you can't use Incident Manager functionality.

Exceptions

get_resource_policies(**kwargs)

Retrieves the resource policies attached to the specified response plan.

See also: AWS API Documentation

Request Syntax

response = client.get_resource_policies(
    maxResults=123,
    nextToken='string',
    resourceArn='string'
)
Parameters
  • maxResults (integer) -- The maximum number of resource policies to display per page of results.
  • nextToken (string) -- The pagination token to continue to the next page of results.
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the response plan with the attached resource policy.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'resourcePolicies': [
        {
            'policyDocument': 'string',
            'policyId': 'string',
            'ramResourceShareRegion': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The pagination token to continue to the next page of results.

    • resourcePolicies (list) --

      Details about the resource policy attached to the response plan.

      • (dict) --

        The resource policy that allows Incident Manager to perform actions on resources on your behalf.

        • policyDocument (string) --

          The JSON blob that describes the policy.

        • policyId (string) --

          The ID of the resource policy.

        • ramResourceShareRegion (string) --

          The Amazon Web Services Region that policy allows resources to be used in.

Exceptions

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',
                '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,
        'notificationTargets': [
            {
                'snsTopicArn': 'string'
            },
        ],
        'summary': 'string',
        'title': '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.

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

        Used to stop Incident Manager from creating multiple incident records for the same incident.

      • impact (integer) --

        The impact of the incident on your customers and applications.

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

    • name (string) --

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

Exceptions

get_timeline_event(**kwargs)

Retrieves a timeline event based on its ID and incident record.

See also: AWS API Documentation

Request Syntax

response = client.get_timeline_event(
    eventId='string',
    incidentRecordArn='string'
)
Parameters
  • eventId (string) --

    [REQUIRED]

    The ID of the event. You can get an event's ID when you create it, or by using ListTimelineEvents .

  • incidentRecordArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the incident that includes the timeline event.

Return type

dict

Returns

Response Syntax

{
    'event': {
        'eventData': 'string',
        'eventId': 'string',
        'eventTime': datetime(2015, 1, 1),
        'eventType': 'string',
        'eventUpdatedTime': datetime(2015, 1, 1),
        'incidentRecordArn': 'string'
    }
}

Response Structure

  • (dict) --

    • event (dict) --

      Details about the timeline event.

      • eventData (string) --

        A short description of the event.

      • eventId (string) --

        The ID of the timeline event.

      • eventTime (datetime) --

        The time that the event occurred.

      • eventType (string) --

        The type of event that occurred. Currently Incident Manager supports only the Custom Event type.

      • eventUpdatedTime (datetime) --

        The time that the timeline event was last updated.

      • incidentRecordArn (string) --

        The Amazon Resource Name (ARN) of the incident that the event occurred during.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_incident_records(**kwargs)

Lists all incident records in your account. Use this command to retrieve the Amazon Resource Name (ARN) of the incident record you want to update.

See also: AWS API Documentation

Request Syntax

response = client.list_incident_records(
    filters=[
        {
            'condition': {
                'after': datetime(2015, 1, 1),
                'before': datetime(2015, 1, 1),
                'equals': {
                    'integerValues': [
                        123,
                    ],
                    'stringValues': [
                        'string',
                    ]
                }
            },
            'key': 'string'
        },
    ],
    maxResults=123,
    nextToken='string'
)
Parameters
  • filters (list) --

    Filters the list of incident records through which you are searching. You can filter on the following keys:

    • creationTime
    • impact
    • status
    • createdBy

    Note the following when deciding how to use Filters:

    • If you don't specify a Filter, the response includes all incident records.
    • If you specify more than one filter in a single request, the response returns incident records that match all filters.
    • If you specify a filter with more than one value, the response returns incident records that match any of the values provided.
    • (dict) --

      Filter the selection by using a condition.

      • condition (dict) -- [REQUIRED]

        The condition accepts before or after a specified time, equal to a string, or equal to an integer.

        Note

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

        • after (datetime) --

          After the specified timestamp.

        • before (datetime) --

          Before the specified timestamp

        • equals (dict) --

          The value is equal to the provided string or integer.

          Note

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

          • integerValues (list) --

            The list of integer values that the filter matches.

            • (integer) --
          • stringValues (list) --

            The list of string values that the filter matches.

            • (string) --
      • key (string) -- [REQUIRED]

        The key that you're filtering on.

  • maxResults (integer) -- The maximum number of results per page.
  • nextToken (string) -- The pagination token to continue to the next page of results.
Return type

dict

Returns

Response Syntax

{
    'incidentRecordSummaries': [
        {
            'arn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'impact': 123,
            'incidentRecordSource': {
                'createdBy': 'string',
                'invokedBy': 'string',
                'resourceArn': 'string',
                'source': 'string'
            },
            'resolvedTime': datetime(2015, 1, 1),
            'status': 'OPEN'|'RESOLVED',
            'title': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • incidentRecordSummaries (list) --

      The details of each listed incident record.

      • (dict) --

        Details describing an incident record.

        • arn (string) --

          The Amazon Resource Name (ARN) of the incident.

        • creationTime (datetime) --

          The time the incident was created.

        • impact (integer) --

          Defines the impact to customers and applications.

        • incidentRecordSource (dict) --

          What caused Incident Manager to create the incident.

          • createdBy (string) --

            The principal that started the incident.

          • invokedBy (string) --

            The principal the assumed the role specified of the createdBy .

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

        • resolvedTime (datetime) --

          The time the incident was resolved.

        • status (string) --

          The current status of the incident.

        • title (string) --

          The title of the incident. This value is either provided by the response plan or overwritten on creation.

    • nextToken (string) --

      The pagination token to continue to the next page of results.

Exceptions

List all related items for an incident record.

See also: AWS API Documentation

Request Syntax

response = client.list_related_items(
    incidentRecordArn='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • incidentRecordArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the incident record containing the listed related items.

  • maxResults (integer) -- The maximum number of related items per page.
  • nextToken (string) -- The pagination token to continue to the next page of results.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'relatedItems': [
        {
            'identifier': {
                'type': 'ANALYSIS'|'INCIDENT'|'METRIC'|'PARENT'|'ATTACHMENT'|'OTHER',
                'value': {
                    'arn': 'string',
                    'metricDefinition': 'string',
                    'url': 'string'
                }
            },
            'title': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The pagination token to continue to the next page of results.

    • relatedItems (list) --

      Details about each related item.

      • (dict) --

        Resources that responders use to triage and mitigate the incident.

        • identifier (dict) --

          Details about the related item.

          • type (string) --

            The type of related item. Incident Manager supports the following types:

            • ANALYSIS
            • INCIDENT
            • METRIC
            • PARENT
            • ATTACHMENT
            • OTHER
          • value (dict) --

            Details about the related item.

            Note

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

            • url (string) --

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

        • title (string) --

          The title of the related item.

Exceptions

list_replication_sets(**kwargs)

Lists details about the replication set configured in your account.

See also: AWS API Documentation

Request Syntax

response = client.list_replication_sets(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- The maximum number of results per page.
  • nextToken (string) -- The pagination token to continue to the next page of results.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'replicationSetArns': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The pagination token to continue to the next page of results.

    • replicationSetArns (list) --

      The Amazon Resource Name (ARN) of the list replication set.

      • (string) --

Exceptions

list_response_plans(**kwargs)

Lists all response plans in your account.

See also: AWS API Documentation

Request Syntax

response = client.list_response_plans(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- The maximum number of response plans per page.
  • nextToken (string) -- The pagination token to continue to the next page of results.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'responsePlanSummaries': [
        {
            'arn': 'string',
            'displayName': 'string',
            'name': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The pagination token to continue to the next page of results.

    • responsePlanSummaries (list) --

      Details of each response plan.

      • (dict) --

        Details of the response plan that are used when creating an incident.

        • arn (string) --

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

        • displayName (string) --

          The human readable name of the response plan. This can include spaces.

        • name (string) --

          The name of the response plan. This can't include spaces.

Exceptions

list_tags_for_resource(**kwargs)

Lists the tags that are attached to the specified response plan.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string'
)
Parameters
resourceArn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • tags (dict) --

      A list of tags for the response plan.

      • (string) --
        • (string) --

Exceptions

list_timeline_events(**kwargs)

Lists timeline events for the specified incident record.

See also: AWS API Documentation

Request Syntax

response = client.list_timeline_events(
    filters=[
        {
            'condition': {
                'after': datetime(2015, 1, 1),
                'before': datetime(2015, 1, 1),
                'equals': {
                    'integerValues': [
                        123,
                    ],
                    'stringValues': [
                        'string',
                    ]
                }
            },
            'key': 'string'
        },
    ],
    incidentRecordArn='string',
    maxResults=123,
    nextToken='string',
    sortBy='EVENT_TIME',
    sortOrder='ASCENDING'|'DESCENDING'
)
Parameters
  • filters (list) --

    Filters the timeline events based on the provided conditional values. You can filter timeline events using the following keys:

    • eventTime
    • eventType

    Note the following when deciding how to use Filters:

    • If you don't specify a Filter, the response includes all timeline events.
    • If you specify more than one filter in a single request, the response returns timeline events that match all filters.
    • If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.
    • (dict) --

      Filter the selection by using a condition.

      • condition (dict) -- [REQUIRED]

        The condition accepts before or after a specified time, equal to a string, or equal to an integer.

        Note

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

        • after (datetime) --

          After the specified timestamp.

        • before (datetime) --

          Before the specified timestamp

        • equals (dict) --

          The value is equal to the provided string or integer.

          Note

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

          • integerValues (list) --

            The list of integer values that the filter matches.

            • (integer) --
          • stringValues (list) --

            The list of string values that the filter matches.

            • (string) --
      • key (string) -- [REQUIRED]

        The key that you're filtering on.

  • incidentRecordArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the incident that includes the timeline event.

  • maxResults (integer) -- The maximum number of results per page.
  • nextToken (string) -- The pagination token to continue to the next page of results.
  • sortBy (string) -- Sort by the specified key value pair.
  • sortOrder (string) -- Sorts the order of timeline events by the value specified in the sortBy field.
Return type

dict

Returns

Response Syntax

{
    'eventSummaries': [
        {
            'eventId': 'string',
            'eventTime': datetime(2015, 1, 1),
            'eventType': 'string',
            'eventUpdatedTime': datetime(2015, 1, 1),
            'incidentRecordArn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • eventSummaries (list) --

      Details about each event that occurred during the incident.

      • (dict) --

        Details about a timeline event during an incident.

        • eventId (string) --

          The timeline event ID.

        • eventTime (datetime) --

          The time that the event occurred.

        • eventType (string) --

          The type of event. The timeline event must be Custom Event .

        • eventUpdatedTime (datetime) --

          The time that the timeline event was last updated.

        • incidentRecordArn (string) --

          The Amazon Resource Name (ARN) of the incident that the event happened during.

    • nextToken (string) --

      The pagination token to continue to the next page of results.

Exceptions

put_resource_policy(**kwargs)

Adds a resource policy to the specified response plan.

See also: AWS API Documentation

Request Syntax

response = client.put_resource_policy(
    policy='string',
    resourceArn='string'
)
Parameters
  • policy (string) --

    [REQUIRED]

    Details of the resource policy.

  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the response plan you're adding the resource policy to.

Return type

dict

Returns

Response Syntax

{
    'policyId': 'string'
}

Response Structure

  • (dict) --

    • policyId (string) --

      The ID of the resource policy.

Exceptions

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=[
        {
            'identifier': {
                'type': 'ANALYSIS'|'INCIDENT'|'METRIC'|'PARENT'|'ATTACHMENT'|'OTHER',
                'value': {
                    'arn': 'string',
                    'metricDefinition': '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.

    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 (list) --

    Add related items to the incident for other responders to use. Related items are AWS resources, external links, or files uploaded to an Amazon S3 bucket.

    • (dict) --

      Resources that responders use to triage and mitigate the incident.

      • identifier (dict) -- [REQUIRED]

        Details about the related item.

        • type (string) -- [REQUIRED]

          The type of related item. Incident Manager supports the following types:

          • ANALYSIS
          • INCIDENT
          • METRIC
          • PARENT
          • ATTACHMENT
          • OTHER
        • 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, 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.

          • 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 time that 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

tag_resource(**kwargs)

Adds a tag to a response plan.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the response plan you're adding the tags to.

  • tags (dict) --

    [REQUIRED]

    A list of tags that you are adding to the response plan.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes a tag from a resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the response plan you're removing a tag from.

  • tagKeys (list) --

    [REQUIRED]

    The name of the tag you're removing from the response plan.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_deletion_protection(**kwargs)

Update deletion protection to either allow or deny deletion of the final Region in a replication set.

See also: AWS API Documentation

Request Syntax

response = client.update_deletion_protection(
    arn='string',
    clientToken='string',
    deletionProtected=True|False
)
Parameters
  • arn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the replication set you're updating.

  • clientToken (string) --

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

    This field is autopopulated if not provided.

  • deletionProtected (boolean) --

    [REQUIRED]

    Details if deletion protection is enabled or disabled in your account.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

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

Add or remove related items from the related items tab of an incident record.

See also: AWS API Documentation

Request Syntax

response = client.update_related_items(
    clientToken='string',
    incidentRecordArn='string',
    relatedItemsUpdate={
        'itemToAdd': {
            'identifier': {
                'type': 'ANALYSIS'|'INCIDENT'|'METRIC'|'PARENT'|'ATTACHMENT'|'OTHER',
                'value': {
                    'arn': 'string',
                    'metricDefinition': 'string',
                    'url': 'string'
                }
            },
            'title': 'string'
        },
        'itemToRemove': {
            'type': 'ANALYSIS'|'INCIDENT'|'METRIC'|'PARENT'|'ATTACHMENT'|'OTHER',
            'value': {
                'arn': 'string',
                'metricDefinition': 'string',
                'url': '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.

  • incidentRecordArn (string) --

    [REQUIRED]

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

  • relatedItemsUpdate (dict) --

    [REQUIRED]

    Details about the item you are adding or deleting.

    Note

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

    • itemToAdd (dict) --

      Details about the related item you're adding.

      • identifier (dict) -- [REQUIRED]

        Details about the related item.

        • type (string) -- [REQUIRED]

          The type of related item. Incident Manager supports the following types:

          • ANALYSIS
          • INCIDENT
          • METRIC
          • PARENT
          • ATTACHMENT
          • OTHER
        • 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, 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.

          • url (string) --

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

      • title (string) --

        The title of the related item.

    • itemToRemove (dict) --

      Details about the related item you're deleting.

      • type (string) -- [REQUIRED]

        The type of related item. Incident Manager supports the following types:

        • ANALYSIS
        • INCIDENT
        • METRIC
        • PARENT
        • ATTACHMENT
        • OTHER
      • 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, 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.

        • url (string) --

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_replication_set(**kwargs)

Add or delete Regions from your replication set.

See also: AWS API Documentation

Request Syntax

response = client.update_replication_set(
    actions=[
        {
            'addRegionAction': {
                'regionName': 'string',
                'sseKmsKeyId': 'string'
            },
            'deleteRegionAction': {
                'regionName': 'string'
            }
        },
    ],
    arn='string',
    clientToken='string'
)
Parameters
  • actions (list) --

    [REQUIRED]

    An action to add or delete a Region.

    • (dict) --

      Details used when updating the replication set.

      Note

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

      • addRegionAction (dict) --

        Details about the Amazon Web Services Region that you're adding to the replication set.

        • regionName (string) -- [REQUIRED]

          The Amazon Web Services Region name to add to the replication set.

        • sseKmsKeyId (string) --

          The KMS key ID to use to encrypt your replication set.

      • deleteRegionAction (dict) --

        Details about the Amazon Web Services Region that you're deleting to the replication set.

        • regionName (string) -- [REQUIRED]

          The name of the Amazon Web Services Region you're deleting from the replication set.

  • arn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the replication set you're updating.

  • clientToken (string) --

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_response_plan(**kwargs)

Updates the specified response plan.

See also: AWS API Documentation

Request Syntax

response = client.update_response_plan(
    actions=[
        {
            'ssmAutomation': {
                'documentName': 'string',
                'documentVersion': 'string',
                'parameters': {
                    'string': [
                        'string',
                    ]
                },
                'roleArn': 'string',
                'targetAccount': 'RESPONSE_PLAN_OWNER_ACCOUNT'|'IMPACTED_ACCOUNT'
            }
        },
    ],
    arn='string',
    chatChannel={
        'chatbotSns': [
            'string',
        ],
        'empty': {}

    },
    clientToken='string',
    displayName='string',
    engagements=[
        'string',
    ],
    incidentTemplateDedupeString='string',
    incidentTemplateImpact=123,
    incidentTemplateNotificationTargets=[
        {
            'snsTopicArn': 'string'
        },
    ],
    incidentTemplateSummary='string',
    incidentTemplateTitle='string'
)
Parameters
  • actions (list) --

    The actions that this response plan takes at the beginning of an 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 can be set: ssmAutomation.

      • ssmAutomation (dict) --

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

        • documentName (string) -- [REQUIRED]

          The automation document's name.

        • documentVersion (string) --

          The automation document's version to use when running.

        • parameters (dict) --

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

          • (string) --
            • (list) --
              • (string) --
        • roleArn (string) -- [REQUIRED]

          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) --

    [REQUIRED]

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

  • chatChannel (dict) --

    The Chatbot chat channel used for collaboration during an incident.

    Use the empty structure to remove the chat channel from the response plan.

    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 ensuring that the operation is called only once with the specified details.

    This field is autopopulated if not provided.

  • displayName (string) -- The long format name of the response plan. The display name can't contain spaces.
  • engagements (list) --

    The contacts and escalation plans that Incident Manager engages at the start of the incident.

    • (string) --
  • incidentTemplateDedupeString (string) -- The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.
  • incidentTemplateImpact (integer) --

    Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

    Possible impacts:
    • 5 - Severe impact
    • 4 - High impact
    • 3 - Medium impact
    • 2 - Low impact
    • 1 - No impact
  • incidentTemplateNotificationTargets (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 can be set: snsTopicArn.

      • snsTopicArn (string) --

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

  • incidentTemplateSummary (string) -- A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.
  • incidentTemplateTitle (string) -- The short format name of the incident. The title can't contain spaces.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_timeline_event(**kwargs)

Updates a timeline event. You can update events of type Custom Event .

See also: AWS API Documentation

Request Syntax

response = client.update_timeline_event(
    clientToken='string',
    eventData='string',
    eventId='string',
    eventTime=datetime(2015, 1, 1),
    eventType='string',
    incidentRecordArn='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.

  • eventData (string) -- A short description of the event.
  • eventId (string) --

    [REQUIRED]

    The ID of the event you are updating. You can find this by using ListTimelineEvents .

  • eventTime (datetime) -- The time that the event occurred.
  • eventType (string) -- The type of the event. You can update events of type Custom Event .
  • incidentRecordArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the incident that includes the timeline event.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class SSMIncidents.Client.exceptions.AccessDeniedException

You don't have sufficient access to perform this operation.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You don't have sufficient access to perform this operation.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SSMIncidents.Client.exceptions.ConflictException

Updating or deleting a resource causes an inconsistent state.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceIdentifier': 'string',
    'resourceType': 'RESPONSE_PLAN'|'INCIDENT_RECORD'|'TIMELINE_EVENT'|'REPLICATION_SET'|'RESOURCE_POLICY',
    'retryAfter': datetime(2015, 1, 1),
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Updating or deleting a resource causes an inconsistent state.

    • message (string) --

    • resourceIdentifier (string) --

      The identifier of the requested resource

    • resourceType (string) --

      The resource type

    • retryAfter (datetime) --

      If present in the output, the operation can be retried after this time

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SSMIncidents.Client.exceptions.InternalServerException

The request processing has failed because of an unknown error, exception or failure.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request processing has failed because of an unknown error, exception or failure.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SSMIncidents.Client.exceptions.ResourceNotFoundException

Request references a resource which doesn't exist.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceIdentifier': 'string',
    'resourceType': 'RESPONSE_PLAN'|'INCIDENT_RECORD'|'TIMELINE_EVENT'|'REPLICATION_SET'|'RESOURCE_POLICY',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Request references a resource which doesn't exist.

    • message (string) --

    • resourceIdentifier (string) --

      The identifier for the requested resource

    • resourceType (string) --

      The resource type

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SSMIncidents.Client.exceptions.ServiceQuotaExceededException

Request would cause a service quota to be exceeded.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'quotaCode': 'string',
    'resourceIdentifier': 'string',
    'resourceType': 'RESPONSE_PLAN'|'INCIDENT_RECORD'|'TIMELINE_EVENT'|'REPLICATION_SET'|'RESOURCE_POLICY',
    'serviceCode': 'ssm-incidents',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Request would cause a service quota to be exceeded.

    • message (string) --

    • quotaCode (string) --

      Originating quota code

    • resourceIdentifier (string) --

      The identifier for the requested resource

    • resourceType (string) --

      The resource type

    • serviceCode (string) --

      Originating service code

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SSMIncidents.Client.exceptions.ThrottlingException

The request was denied due to request throttling.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'quotaCode': 'string',
    'serviceCode': 'ssm-incidents',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied due to request throttling.

    • message (string) --

    • quotaCode (string) --

      Originating quota code

    • serviceCode (string) --

      Originating service code

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class SSMIncidents.Client.exceptions.ValidationException

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The input fails to satisfy the constraints specified by an Amazon Web Services service.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class SSMIncidents.Paginator.GetResourcePolicies
paginator = client.get_paginator('get_resource_policies')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SSMIncidents.Client.get_resource_policies().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    resourceArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the response plan with the attached resource policy.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'resourcePolicies': [
        {
            'policyDocument': 'string',
            'policyId': 'string',
            'ramResourceShareRegion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • resourcePolicies (list) --

      Details about the resource policy attached to the response plan.

      • (dict) --

        The resource policy that allows Incident Manager to perform actions on resources on your behalf.

        • policyDocument (string) --

          The JSON blob that describes the policy.

        • policyId (string) --

          The ID of the resource policy.

        • ramResourceShareRegion (string) --

          The Amazon Web Services Region that policy allows resources to be used in.

    • NextToken (string) --

      A token to resume pagination.

class SSMIncidents.Paginator.ListIncidentRecords
paginator = client.get_paginator('list_incident_records')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SSMIncidents.Client.list_incident_records().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'condition': {
                'after': datetime(2015, 1, 1),
                'before': datetime(2015, 1, 1),
                'equals': {
                    'integerValues': [
                        123,
                    ],
                    'stringValues': [
                        'string',
                    ]
                }
            },
            'key': 'string'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • filters (list) --

    Filters the list of incident records through which you are searching. You can filter on the following keys:

    • creationTime
    • impact
    • status
    • createdBy

    Note the following when deciding how to use Filters:

    • If you don't specify a Filter, the response includes all incident records.
    • If you specify more than one filter in a single request, the response returns incident records that match all filters.
    • If you specify a filter with more than one value, the response returns incident records that match any of the values provided.
    • (dict) --

      Filter the selection by using a condition.

      • condition (dict) -- [REQUIRED]

        The condition accepts before or after a specified time, equal to a string, or equal to an integer.

        Note

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

        • after (datetime) --

          After the specified timestamp.

        • before (datetime) --

          Before the specified timestamp

        • equals (dict) --

          The value is equal to the provided string or integer.

          Note

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

          • integerValues (list) --

            The list of integer values that the filter matches.

            • (integer) --
          • stringValues (list) --

            The list of string values that the filter matches.

            • (string) --
      • key (string) -- [REQUIRED]

        The key that you're filtering on.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'incidentRecordSummaries': [
        {
            'arn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'impact': 123,
            'incidentRecordSource': {
                'createdBy': 'string',
                'invokedBy': 'string',
                'resourceArn': 'string',
                'source': 'string'
            },
            'resolvedTime': datetime(2015, 1, 1),
            'status': 'OPEN'|'RESOLVED',
            'title': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • incidentRecordSummaries (list) --

      The details of each listed incident record.

      • (dict) --

        Details describing an incident record.

        • arn (string) --

          The Amazon Resource Name (ARN) of the incident.

        • creationTime (datetime) --

          The time the incident was created.

        • impact (integer) --

          Defines the impact to customers and applications.

        • incidentRecordSource (dict) --

          What caused Incident Manager to create the incident.

          • createdBy (string) --

            The principal that started the incident.

          • invokedBy (string) --

            The principal the assumed the role specified of the createdBy .

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

        • resolvedTime (datetime) --

          The time the incident was resolved.

        • status (string) --

          The current status of the incident.

        • title (string) --

          The title of the incident. This value is either provided by the response plan or overwritten on creation.

    • NextToken (string) --

      A token to resume pagination.

class SSMIncidents.Paginator.ListRelatedItems
paginator = client.get_paginator('list_related_items')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SSMIncidents.Client.list_related_items().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    incidentRecordArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • incidentRecordArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the incident record containing the listed related items.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'relatedItems': [
        {
            'identifier': {
                'type': 'ANALYSIS'|'INCIDENT'|'METRIC'|'PARENT'|'ATTACHMENT'|'OTHER',
                'value': {
                    'arn': 'string',
                    'metricDefinition': 'string',
                    'url': 'string'
                }
            },
            'title': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • relatedItems (list) --

      Details about each related item.

      • (dict) --

        Resources that responders use to triage and mitigate the incident.

        • identifier (dict) --

          Details about the related item.

          • type (string) --

            The type of related item. Incident Manager supports the following types:

            • ANALYSIS
            • INCIDENT
            • METRIC
            • PARENT
            • ATTACHMENT
            • OTHER
          • value (dict) --

            Details about the related item.

            Note

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

            • url (string) --

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

        • title (string) --

          The title of the related item.

    • NextToken (string) --

      A token to resume pagination.

class SSMIncidents.Paginator.ListReplicationSets
paginator = client.get_paginator('list_replication_sets')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SSMIncidents.Client.list_replication_sets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'replicationSetArns': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • replicationSetArns (list) --

      The Amazon Resource Name (ARN) of the list replication set.

      • (string) --
    • NextToken (string) --

      A token to resume pagination.

class SSMIncidents.Paginator.ListResponsePlans
paginator = client.get_paginator('list_response_plans')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SSMIncidents.Client.list_response_plans().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'responsePlanSummaries': [
        {
            'arn': 'string',
            'displayName': 'string',
            'name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • responsePlanSummaries (list) --

      Details of each response plan.

      • (dict) --

        Details of the response plan that are used when creating an incident.

        • arn (string) --

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

        • displayName (string) --

          The human readable name of the response plan. This can include spaces.

        • name (string) --

          The name of the response plan. This can't include spaces.

    • NextToken (string) --

      A token to resume pagination.

class SSMIncidents.Paginator.ListTimelineEvents
paginator = client.get_paginator('list_timeline_events')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SSMIncidents.Client.list_timeline_events().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'condition': {
                'after': datetime(2015, 1, 1),
                'before': datetime(2015, 1, 1),
                'equals': {
                    'integerValues': [
                        123,
                    ],
                    'stringValues': [
                        'string',
                    ]
                }
            },
            'key': 'string'
        },
    ],
    incidentRecordArn='string',
    sortBy='EVENT_TIME',
    sortOrder='ASCENDING'|'DESCENDING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • filters (list) --

    Filters the timeline events based on the provided conditional values. You can filter timeline events using the following keys:

    • eventTime
    • eventType

    Note the following when deciding how to use Filters:

    • If you don't specify a Filter, the response includes all timeline events.
    • If you specify more than one filter in a single request, the response returns timeline events that match all filters.
    • If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.
    • (dict) --

      Filter the selection by using a condition.

      • condition (dict) -- [REQUIRED]

        The condition accepts before or after a specified time, equal to a string, or equal to an integer.

        Note

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

        • after (datetime) --

          After the specified timestamp.

        • before (datetime) --

          Before the specified timestamp

        • equals (dict) --

          The value is equal to the provided string or integer.

          Note

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

          • integerValues (list) --

            The list of integer values that the filter matches.

            • (integer) --
          • stringValues (list) --

            The list of string values that the filter matches.

            • (string) --
      • key (string) -- [REQUIRED]

        The key that you're filtering on.

  • incidentRecordArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the incident that includes the timeline event.

  • sortBy (string) -- Sort by the specified key value pair.
  • sortOrder (string) -- Sorts the order of timeline events by the value specified in the sortBy field.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'eventSummaries': [
        {
            'eventId': 'string',
            'eventTime': datetime(2015, 1, 1),
            'eventType': 'string',
            'eventUpdatedTime': datetime(2015, 1, 1),
            'incidentRecordArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • eventSummaries (list) --

      Details about each event that occurred during the incident.

      • (dict) --

        Details about a timeline event during an incident.

        • eventId (string) --

          The timeline event ID.

        • eventTime (datetime) --

          The time that the event occurred.

        • eventType (string) --

          The type of event. The timeline event must be Custom Event .

        • eventUpdatedTime (datetime) --

          The time that the timeline event was last updated.

        • incidentRecordArn (string) --

          The Amazon Resource Name (ARN) of the incident that the event happened during.

    • NextToken (string) --

      A token to resume pagination.

Waiters

The available waiters are:

class SSMIncidents.Waiter.WaitForReplicationSetActive
waiter = client.get_waiter('wait_for_replication_set_active')
wait(**kwargs)

Polls SSMIncidents.Client.get_replication_set() every 30 seconds until a successful state is reached. An error is returned after 5 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    arn='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • arn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the replication set you want to retrieve.

  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 30

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 5

Returns

None

class SSMIncidents.Waiter.WaitForReplicationSetDeleted
waiter = client.get_waiter('wait_for_replication_set_deleted')
wait(**kwargs)

Polls SSMIncidents.Client.get_replication_set() every 30 seconds until a successful state is reached. An error is returned after 5 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    arn='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • arn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the replication set you want to retrieve.

  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 30

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 5

Returns

None