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. import boto3 client = boto3.client('ssm-incidents') These are the available methods: * batch_get_incident_findings * can_paginate * close * create_replication_set * create_response_plan * create_timeline_event * delete_incident_record * delete_replication_set * delete_resource_policy * delete_response_plan * delete_timeline_event * get_incident_record * get_paginator * get_replication_set * get_resource_policies * get_response_plan * get_timeline_event * get_waiter * list_incident_findings * list_incident_records * list_related_items * list_replication_sets * list_response_plans * list_tags_for_resource * list_timeline_events * put_resource_policy * start_incident * tag_resource * untag_resource * update_deletion_protection * update_incident_record * update_related_items * update_replication_set * update_response_plan * update_timeline_event Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * GetResourcePolicies * ListIncidentFindings * ListIncidentRecords * ListRelatedItems * ListReplicationSets * ListResponsePlans * ListTimelineEvents Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * WaitForReplicationSetActive * WaitForReplicationSetDeleted SSMIncidents / Waiter / WaitForReplicationSetActive WaitForReplicationSetActive *************************** 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 raised 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 SSMIncidents / Waiter / WaitForReplicationSetDeleted WaitForReplicationSetDeleted **************************** 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 raised 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 SSMIncidents / Paginator / ListResponsePlans ListResponsePlans ***************** 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. SSMIncidents / Paginator / ListRelatedItems ListRelatedItems **************** 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': [ { 'generatedId': 'string', 'identifier': { 'type': 'ANALYSIS'|'INCIDENT'|'METRIC'|'PARENT'|'ATTACHMENT'|'OTHER'|'AUTOMATION'|'INVOLVED_RESOURCE'|'TASK', 'value': { 'arn': 'string', 'metricDefinition': 'string', 'pagerDutyIncidentDetail': { 'autoResolve': True|False, 'id': 'string', 'secretId': 'string' }, 'url': 'string' } }, 'title': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **relatedItems** *(list) --* Details about each related item. * *(dict) --* Resources that responders use to triage and mitigate the incident. * **generatedId** *(string) --* A unique ID for a "RelatedItem". Warning: Don't specify this parameter when you add a "RelatedItem" by using the UpdateRelatedItems API action. * **identifier** *(dict) --* Details about the related item. * **type** *(string) --* The type of related item. * **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", "pagerDutyIncidentDetail", "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. * **pagerDutyIncidentDetail** *(dict) --* Details about an incident that is associated with a PagerDuty incident. * **autoResolve** *(boolean) --* Indicates whether to resolve the PagerDuty incident when you resolve the associated Incident Manager incident. * **id** *(string) --* The ID of the incident associated with the PagerDuty service for the response plan. * **secretId** *(string) --* The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials. * **url** *(string) --* The URL, if the related item is a non-Amazon Web Services resource. * **title** *(string) --* The title of the related item. * **NextToken** *(string) --* A token to resume pagination. SSMIncidents / Paginator / ListIncidentFindings ListIncidentFindings ******************** class SSMIncidents.Paginator.ListIncidentFindings paginator = client.get_paginator('list_incident_findings') paginate(**kwargs) Creates an iterator that will paginate through responses from "SSMIncidents.Client.list_incident_findings()". 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 for which you want to view associated findings. * **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** { 'findings': [ { 'id': 'string', 'lastModifiedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **findings** *(list) --* A list of findings that represent deployments that might be the potential cause of the incident. * *(dict) --* Identifying information about the finding. * **id** *(string) --* The ID of the finding. * **lastModifiedTime** *(datetime) --* The timestamp for when the finding was last updated. * **NextToken** *(string) --* A token to resume pagination. SSMIncidents / Paginator / ListReplicationSets ListReplicationSets ******************* 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. SSMIncidents / Paginator / ListIncidentRecords ListIncidentRecords ******************* 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 you want to search through. You can filter on the following keys: * "creationTime" * "impact" * "status" * "createdBy" Note the following when when you 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 timestamp for when 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 service principal that assumed the role specified in "createdBy". If no service principal assumed the role this will be left blank. * **resourceArn** *(string) --* The resource that caused the incident to be created. * **source** *(string) --* The service that started the incident. This can be manually created from Incident Manager, automatically created using an Amazon CloudWatch alarm, or Amazon EventBridge event. * **resolvedTime** *(datetime) --* The timestamp for when 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. SSMIncidents / Paginator / GetResourcePolicies GetResourcePolicies ******************* 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. SSMIncidents / Paginator / ListTimelineEvents ListTimelineEvents ****************** 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 with the following keys: * "eventReference" * "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 timeline events 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', 'eventReferences': [ { 'relatedItemId': 'string', 'resource': '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. * **eventReferences** *(list) --* A list of references in a "TimelineEvent". * *(dict) --* An item referenced in a "TimelineEvent" that is involved in or somehow associated with an incident. You can specify an Amazon Resource Name (ARN) for an Amazon Web Services resource or a "RelatedItem" ID. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "relatedItemId", "resource". 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'} * **relatedItemId** *(string) --* The ID of a "RelatedItem" referenced in a "TimelineEvent". * **resource** *(string) --* The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a "TimelineEvent". * **eventTime** *(datetime) --* The timestamp for when the event occurred. * **eventType** *(string) --* The type of event. The timeline event must be "Custom Event" or "Note". * **eventUpdatedTime** *(datetime) --* The timestamp for when 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. SSMIncidents / Client / create_replication_set create_replication_set ********************** SSMIncidents.Client.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' } }, tags={ 'string': 'string' } ) Parameters: * **clientToken** (*string*) -- A token that ensures 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. * **tags** (*dict*) -- A list of tags to add to the replication set. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'arn': 'string' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the replication set. **Exceptions** * "SSMIncidents.Client.exceptions.ServiceQuotaExceededException" * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.ConflictException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / get_incident_record get_incident_record ******************* SSMIncidents.Client.get_incident_record(**kwargs) Returns the details for the specified incident record. See also: AWS API Documentation **Request Syntax** response = client.get_incident_record( arn='string' ) Parameters: **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the incident record. Return type: dict Returns: **Response Syntax** { 'incidentRecord': { 'arn': 'string', 'automationExecutions': [ { 'ssmExecutionArn': 'string' }, ], 'chatChannel': { 'chatbotSns': [ 'string', ], 'empty': {} }, 'creationTime': datetime(2015, 1, 1), 'dedupeString': 'string', 'impact': 123, 'incidentRecordSource': { 'createdBy': 'string', 'invokedBy': 'string', 'resourceArn': 'string', 'source': 'string' }, 'lastModifiedBy': 'string', 'lastModifiedTime': datetime(2015, 1, 1), 'notificationTargets': [ { 'snsTopicArn': 'string' }, ], 'resolvedTime': datetime(2015, 1, 1), 'status': 'OPEN'|'RESOLVED', 'summary': 'string', 'title': 'string' } } **Response Structure** * *(dict) --* * **incidentRecord** *(dict) --* Details the structure of the incident record. * **arn** *(string) --* The Amazon Resource Name (ARN) of the incident record. * **automationExecutions** *(list) --* The runbook, or automation document, that's run at the beginning of the incident. * *(dict) --* The Systems Manager automation document process to start as the runbook at the beginning of the incident. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "ssmExecutionArn". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **ssmExecutionArn** *(string) --* The Amazon Resource Name (ARN) of the automation process. * **chatChannel** *(dict) --* The chat channel used for collaboration during an incident. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "chatbotSns", "empty". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **chatbotSns** *(list) --* The Amazon SNS targets that Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the Amazon SNS topics. * *(string) --* * **empty** *(dict) --* Used to remove the chat channel from an incident record or response plan. * **creationTime** *(datetime) --* The timestamp for when Incident Manager created the incident record. * **dedupeString** *(string) --* The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account. * **impact** *(integer) --* The impact of the incident on customers and applications. **Supported impact codes** * "1" - Critical * "2" - High * "3" - Medium * "4" - Low * "5" - No Impact * **incidentRecordSource** *(dict) --* Details about the action that started the incident. * **createdBy** *(string) --* The principal that started the incident. * **invokedBy** *(string) --* The service principal that assumed the role specified in "createdBy". If no service principal assumed the role this will be left blank. * **resourceArn** *(string) --* The resource that caused the incident to be created. * **source** *(string) --* The service that started the incident. This can be manually created from Incident Manager, automatically created using an Amazon CloudWatch alarm, or Amazon EventBridge event. * **lastModifiedBy** *(string) --* Who modified the incident most recently. * **lastModifiedTime** *(datetime) --* The timestamp for when the incident was most recently modified. * **notificationTargets** *(list) --* The Amazon SNS targets that are notified when updates are made to an incident. * *(dict) --* The SNS targets that are notified when updates are made to an incident. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "snsTopicArn". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **snsTopicArn** *(string) --* The Amazon Resource Name (ARN) of the SNS topic. * **resolvedTime** *(datetime) --* The timestamp for when the incident was resolved. This appears as a timeline event. * **status** *(string) --* The current status of the incident. * **summary** *(string) --* The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context of the incident. * **title** *(string) --* The title of the incident. **Exceptions** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / get_paginator get_paginator ************* SSMIncidents.Client.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: "botocore.paginate.Paginator" Returns: A paginator object. SSMIncidents / Client / list_replication_sets list_replication_sets ********************* SSMIncidents.Client.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 for the next set of items to return. (You received this token from a previous call.) Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'replicationSetArns': [ 'string', ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null. * **replicationSetArns** *(list) --* The Amazon Resource Name (ARN) of the list replication set. * *(string) --* **Exceptions** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / update_deletion_protection update_deletion_protection ************************** SSMIncidents.Client.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 to update. * **clientToken** (*string*) -- A token that ensures that the operation is called only once with the specified details. This field is autopopulated if not provided. * **deletionProtected** (*boolean*) -- **[REQUIRED]** Specifies if deletion protection is turned on or off in your account. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / can_paginate can_paginate ************ SSMIncidents.Client.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. SSMIncidents / Client / delete_replication_set delete_replication_set ********************** SSMIncidents.Client.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** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / list_incident_records list_incident_records ********************* SSMIncidents.Client.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 you want to search through. You can filter on the following keys: * "creationTime" * "impact" * "status" * "createdBy" Note the following when when you 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 for the next set of items to return. (You received this token from a previous call.) 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 timestamp for when 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 service principal that assumed the role specified in "createdBy". If no service principal assumed the role this will be left blank. * **resourceArn** *(string) --* The resource that caused the incident to be created. * **source** *(string) --* The service that started the incident. This can be manually created from Incident Manager, automatically created using an Amazon CloudWatch alarm, or Amazon EventBridge event. * **resolvedTime** *(datetime) --* The timestamp for when 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 use when requesting the next set of items. If there are no additional items to return, the string is null. **Exceptions** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / update_incident_record update_incident_record ********************** SSMIncidents.Client.update_incident_record(**kwargs) Update the details of an incident record. You can use this operation to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat. See also: AWS API Documentation **Request Syntax** response = client.update_incident_record( arn='string', chatChannel={ 'chatbotSns': [ 'string', ], 'empty': {} }, clientToken='string', impact=123, notificationTargets=[ { 'snsTopicArn': 'string' }, ], status='OPEN'|'RESOLVED', summary='string', title='string' ) Parameters: * **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the incident record you are updating. * **chatChannel** (*dict*) -- The Chatbot chat channel where responders can collaborate. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "chatbotSns", "empty". * **chatbotSns** *(list) --* The Amazon SNS targets that Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the Amazon SNS topics. * *(string) --* * **empty** *(dict) --* Used to remove the chat channel from an incident record or response plan. * **clientToken** (*string*) -- A token that ensures that a client calls the operation 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. If you provide an impact for an incident, it overwrites the impact provided by the response plan. **Supported impact codes** * "1" - Critical * "2" - High * "3" - Medium * "4" - Low * "5" - No Impact * **notificationTargets** (*list*) -- The Amazon SNS targets that Incident Manager notifies when a client updates 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. Possible statuses are "Open" or "Resolved". * **summary** (*string*) -- A longer description of what occurred during the incident. * **title** (*string*) -- A brief description of the incident. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.ConflictException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / update_replication_set update_replication_set ********************** SSMIncidents.Client.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 that ensures 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** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.ConflictException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / delete_incident_record delete_incident_record ********************** SSMIncidents.Client.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** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / list_tags_for_resource list_tags_for_resource ********************** SSMIncidents.Client.list_tags_for_resource(**kwargs) Lists the tags that are attached to the specified response plan or incident. 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 or incident. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* A list of tags for the response plan or incident. * *(string) --* * *(string) --* **Exceptions** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / list_incident_findings list_incident_findings ********************** SSMIncidents.Client.list_incident_findings(**kwargs) Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident. A finding represents a recent application environment change made by an CloudFormation stack creation or update or an CodeDeploy deployment that can be investigated as a potential cause of the incident. See also: AWS API Documentation **Request Syntax** response = client.list_incident_findings( incidentRecordArn='string', maxResults=123, nextToken='string' ) Parameters: * **incidentRecordArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the incident for which you want to view associated findings. * **maxResults** (*integer*) -- The maximum number of findings to retrieve per call. * **nextToken** (*string*) -- The pagination token for the next set of items to return. (You received this token from a previous call.) Return type: dict Returns: **Response Syntax** { 'findings': [ { 'id': 'string', 'lastModifiedTime': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **findings** *(list) --* A list of findings that represent deployments that might be the potential cause of the incident. * *(dict) --* Identifying information about the finding. * **id** *(string) --* The ID of the finding. * **lastModifiedTime** *(datetime) --* The timestamp for when the finding was last updated. * **nextToken** *(string) --* The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null. **Exceptions** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / untag_resource untag_resource ************** SSMIncidents.Client.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 to remove from the response plan. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.ConflictException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / delete_timeline_event delete_timeline_event ********************* SSMIncidents.Client.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 to update. You can use "ListTimelineEvents" to find an event's ID. * **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** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / create_response_plan create_response_plan ******************** SSMIncidents.Client.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', 'dynamicParameters': { 'string': { 'variable': 'INCIDENT_RECORD_ARN'|'INVOLVED_RESOURCES' } }, '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, 'incidentTags': { 'string': 'string' }, 'notificationTargets': [ { 'snsTopicArn': 'string' }, ], 'summary': 'string', 'title': 'string' }, integrations=[ { 'pagerDutyConfiguration': { 'name': 'string', 'pagerDutyIncidentConfiguration': { 'serviceId': 'string' }, 'secretId': '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. * **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 can be set: "variable". * **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) --* **[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 Amazon Resource Name (ARN) for 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) --* 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) --* **[REQUIRED]** 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 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. * **integrations** (*list*) -- Information about third-party services integrated into the 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 can be set: "pagerDutyConfiguration". * **pagerDutyConfiguration** *(dict) --* Information about the PagerDuty service where the response plan creates an incident. * **name** *(string) --* **[REQUIRED]** The name of the PagerDuty configuration. * **pagerDutyIncidentConfiguration** *(dict) --* **[REQUIRED]** Details about the PagerDuty service associated with the configuration. * **serviceId** *(string) --* **[REQUIRED]** The ID of the PagerDuty service that the response plan associates with an incident when it launches. * **secretId** *(string) --* **[REQUIRED]** 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*) -- **[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** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.ConflictException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / get_waiter get_waiter ********** SSMIncidents.Client.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" SSMIncidents / Client / get_replication_set get_replication_set ******************* SSMIncidents.Client.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 timestamp for when Incident Manager updated the status of the Amazon Web Services Region. * **status** *(string) --* The status of the replication set. If the replication set is still pending, you can't use Incident Manager functionality. **Exceptions** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / create_timeline_event create_timeline_event ********************* SSMIncidents.Client.create_timeline_event(**kwargs) Creates a custom timeline event on the incident details page of an incident record. Incident Manager automatically creates timeline events that mark key moments during an incident. You can create custom timeline events to mark important events that Incident Manager can detect automatically. See also: AWS API Documentation **Request Syntax** response = client.create_timeline_event( clientToken='string', eventData='string', eventReferences=[ { 'relatedItemId': 'string', 'resource': 'string' }, ], eventTime=datetime(2015, 1, 1), eventType='string', incidentRecordArn='string' ) Parameters: * **clientToken** (*string*) -- A token that ensures that a client calls the action only once with the specified details. This field is autopopulated if not provided. * **eventData** (*string*) -- **[REQUIRED]** A short description of the event. * **eventReferences** (*list*) -- Adds one or more references to the "TimelineEvent". A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with a resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item. * *(dict) --* An item referenced in a "TimelineEvent" that is involved in or somehow associated with an incident. You can specify an Amazon Resource Name (ARN) for an Amazon Web Services resource or a "RelatedItem" ID. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "relatedItemId", "resource". * **relatedItemId** *(string) --* The ID of a "RelatedItem" referenced in a "TimelineEvent". * **resource** *(string) --* The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a "TimelineEvent". * **eventTime** (*datetime*) -- **[REQUIRED]** The timestamp for when the event occurred. * **eventType** (*string*) -- **[REQUIRED]** The type of event. You can create timeline events of type "Custom Event" and "Note". To make a Note-type event appear on the *Incident notes* panel in the console, specify "eventType" as "Note``and enter the Amazon Resource Name (ARN) of the incident as the value for ``eventReference". * **incidentRecordArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the incident record that the action adds the incident to. 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** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.ConflictException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / list_timeline_events list_timeline_events ******************** SSMIncidents.Client.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 with the following keys: * "eventReference" * "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 for the next set of items to return. (You received this token from a previous call.) * **sortBy** (*string*) -- Sort timeline events 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', 'eventReferences': [ { 'relatedItemId': 'string', 'resource': '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. * **eventReferences** *(list) --* A list of references in a "TimelineEvent". * *(dict) --* An item referenced in a "TimelineEvent" that is involved in or somehow associated with an incident. You can specify an Amazon Resource Name (ARN) for an Amazon Web Services resource or a "RelatedItem" ID. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "relatedItemId", "resource". 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'} * **relatedItemId** *(string) --* The ID of a "RelatedItem" referenced in a "TimelineEvent". * **resource** *(string) --* The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a "TimelineEvent". * **eventTime** *(datetime) --* The timestamp for when the event occurred. * **eventType** *(string) --* The type of event. The timeline event must be "Custom Event" or "Note". * **eventUpdatedTime** *(datetime) --* The timestamp for when 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 use when requesting the next set of items. If there are no additional items to return, the string is null. **Exceptions** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" 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" SSMIncidents / Client / get_resource_policies get_resource_policies ********************* SSMIncidents.Client.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 for each page of results. * **nextToken** (*string*) -- The pagination token for the next set of items to return. (You received this token from a previous call.) * **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 use when requesting the next set of items. If there are no additional items to return, the string is null. * **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** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / list_response_plans list_response_plans ******************* SSMIncidents.Client.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 for the next set of items to return. (You received this token from a previous call.) Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'responsePlanSummaries': [ { 'arn': 'string', 'displayName': 'string', 'name': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null. * **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** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / get_timeline_event get_timeline_event ****************** SSMIncidents.Client.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', 'eventReferences': [ { 'relatedItemId': 'string', 'resource': '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. * **eventReferences** *(list) --* A list of references in a "TimelineEvent". * *(dict) --* An item referenced in a "TimelineEvent" that is involved in or somehow associated with an incident. You can specify an Amazon Resource Name (ARN) for an Amazon Web Services resource or a "RelatedItem" ID. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "relatedItemId", "resource". 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'} * **relatedItemId** *(string) --* The ID of a "RelatedItem" referenced in a "TimelineEvent". * **resource** *(string) --* The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a "TimelineEvent". * **eventTime** *(datetime) --* The timestamp for when the event occurred. * **eventType** *(string) --* The type of event that occurred. Currently Incident Manager supports only the "Custom Event" and "Note" types. * **eventUpdatedTime** *(datetime) --* The timestamp for when the timeline event was last updated. * **incidentRecordArn** *(string) --* The Amazon Resource Name (ARN) of the incident that the event occurred during. **Exceptions** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / close close ***** SSMIncidents.Client.close() Closes underlying endpoint connections. SSMIncidents / Client / put_resource_policy put_resource_policy ******************* SSMIncidents.Client.put_resource_policy(**kwargs) Adds a resource policy to the specified response plan. The resource policy is used to share the response plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Cross-Region and cross-account incident management. 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 to add the resource policy to. Return type: dict Returns: **Response Syntax** { 'policyId': 'string' } **Response Structure** * *(dict) --* * **policyId** *(string) --* The ID of the resource policy. **Exceptions** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / list_related_items list_related_items ****************** SSMIncidents.Client.list_related_items(**kwargs) 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 for the next set of items to return. (You received this token from a previous call.) Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'relatedItems': [ { 'generatedId': 'string', 'identifier': { 'type': 'ANALYSIS'|'INCIDENT'|'METRIC'|'PARENT'|'ATTACHMENT'|'OTHER'|'AUTOMATION'|'INVOLVED_RESOURCE'|'TASK', 'value': { 'arn': 'string', 'metricDefinition': 'string', 'pagerDutyIncidentDetail': { 'autoResolve': True|False, 'id': 'string', 'secretId': 'string' }, 'url': 'string' } }, 'title': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null. * **relatedItems** *(list) --* Details about each related item. * *(dict) --* Resources that responders use to triage and mitigate the incident. * **generatedId** *(string) --* A unique ID for a "RelatedItem". Warning: Don't specify this parameter when you add a "RelatedItem" by using the UpdateRelatedItems API action. * **identifier** *(dict) --* Details about the related item. * **type** *(string) --* The type of related item. * **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", "pagerDutyIncidentDetail", "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. * **pagerDutyIncidentDetail** *(dict) --* Details about an incident that is associated with a PagerDuty incident. * **autoResolve** *(boolean) --* Indicates whether to resolve the PagerDuty incident when you resolve the associated Incident Manager incident. * **id** *(string) --* The ID of the incident associated with the PagerDuty service for the response plan. * **secretId** *(string) --* The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials. * **url** *(string) --* The URL, if the related item is a non-Amazon Web Services resource. * **title** *(string) --* The title of the related item. **Exceptions** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / delete_response_plan delete_response_plan ******************** SSMIncidents.Client.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** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / update_related_items update_related_items ******************** SSMIncidents.Client.update_related_items(**kwargs) 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': { 'generatedId': 'string', 'identifier': { 'type': 'ANALYSIS'|'INCIDENT'|'METRIC'|'PARENT'|'ATTACHMENT'|'OTHER'|'AUTOMATION'|'INVOLVED_RESOURCE'|'TASK', 'value': { 'arn': 'string', 'metricDefinition': 'string', 'pagerDutyIncidentDetail': { 'autoResolve': True|False, 'id': 'string', 'secretId': 'string' }, 'url': 'string' } }, 'title': 'string' }, 'itemToRemove': { 'type': 'ANALYSIS'|'INCIDENT'|'METRIC'|'PARENT'|'ATTACHMENT'|'OTHER'|'AUTOMATION'|'INVOLVED_RESOURCE'|'TASK', 'value': { 'arn': 'string', 'metricDefinition': 'string', 'pagerDutyIncidentDetail': { 'autoResolve': True|False, 'id': 'string', 'secretId': 'string' }, 'url': 'string' } } } ) Parameters: * **clientToken** (*string*) -- A token that ensures that a client calls the operation 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 that contains the related items that you update. * **relatedItemsUpdate** (*dict*) -- **[REQUIRED]** Details about the item that you are add to, or delete from, an incident. 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. * **generatedId** *(string) --* A unique ID for a "RelatedItem". Warning: Don't specify this parameter when you add a "RelatedItem" by using the UpdateRelatedItems API action. * **identifier** *(dict) --* **[REQUIRED]** Details about the related item. * **type** *(string) --* **[REQUIRED]** The type of related item. * **value** *(dict) --* **[REQUIRED]** Details about the related item. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "arn", "metricDefinition", "pagerDutyIncidentDetail", "url". * **arn** *(string) --* The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource. * **metricDefinition** *(string) --* The metric definition, if the related item is a metric in Amazon CloudWatch. * **pagerDutyIncidentDetail** *(dict) --* Details about an incident that is associated with a PagerDuty incident. * **autoResolve** *(boolean) --* Indicates whether to resolve the PagerDuty incident when you resolve the associated Incident Manager incident. * **id** *(string) --* **[REQUIRED]** The ID of the incident associated with the PagerDuty service for the response plan. * **secretId** *(string) --* The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials. * **url** *(string) --* The URL, if the related item is a non-Amazon Web Services resource. * **title** *(string) --* The title of the related item. * **itemToRemove** *(dict) --* Details about the related item you're deleting. * **type** *(string) --* **[REQUIRED]** The type of related item. * **value** *(dict) --* **[REQUIRED]** Details about the related item. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "arn", "metricDefinition", "pagerDutyIncidentDetail", "url". * **arn** *(string) --* The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource. * **metricDefinition** *(string) --* The metric definition, if the related item is a metric in Amazon CloudWatch. * **pagerDutyIncidentDetail** *(dict) --* Details about an incident that is associated with a PagerDuty incident. * **autoResolve** *(boolean) --* Indicates whether to resolve the PagerDuty incident when you resolve the associated Incident Manager incident. * **id** *(string) --* **[REQUIRED]** The ID of the incident associated with the PagerDuty service for the response plan. * **secretId** *(string) --* The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials. * **url** *(string) --* The URL, if the related item is a non-Amazon Web Services resource. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.ConflictException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / batch_get_incident_findings batch_get_incident_findings *************************** SSMIncidents.Client.batch_get_incident_findings(**kwargs) Retrieves details about all specified findings for an incident, including descriptive details about each finding. A finding represents a recent application environment change made by an CodeDeploy deployment or an CloudFormation stack creation or update that can be investigated as a potential cause of the incident. See also: AWS API Documentation **Request Syntax** response = client.batch_get_incident_findings( findingIds=[ 'string', ], incidentRecordArn='string' ) Parameters: * **findingIds** (*list*) -- **[REQUIRED]** A list of IDs of findings for which you want to view details. * *(string) --* * **incidentRecordArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the incident for which you want to view finding details. Return type: dict Returns: **Response Syntax** { 'errors': [ { 'code': 'string', 'findingId': 'string', 'message': 'string' }, ], 'findings': [ { 'creationTime': datetime(2015, 1, 1), 'details': { 'cloudFormationStackUpdate': { 'endTime': datetime(2015, 1, 1), 'stackArn': 'string', 'startTime': datetime(2015, 1, 1) }, 'codeDeployDeployment': { 'deploymentGroupArn': 'string', 'deploymentId': 'string', 'endTime': datetime(2015, 1, 1), 'startTime': datetime(2015, 1, 1) } }, 'id': 'string', 'lastModifiedTime': datetime(2015, 1, 1) }, ] } **Response Structure** * *(dict) --* * **errors** *(list) --* A list of errors encountered during the operation. * *(dict) --* Details about an error returned for a BatchGetIncidentFindings operation. * **code** *(string) --* The code associated with an error that was returned for a "BatchGetIncidentFindings" operation. * **findingId** *(string) --* The ID of a specified finding for which an error was returned for a "BatchGetIncidentFindings" operation. * **message** *(string) --* The description for an error that was returned for a "BatchGetIncidentFindings" operation. * **findings** *(list) --* Information about the requested findings. * *(dict) --* Information about a specific CodeDeploy deployment or CloudFormation stack creation or update that occurred around the time of a reported incident. These activities can be investigated as a potential cause of the incident. * **creationTime** *(datetime) --* The timestamp for when a finding was created. * **details** *(dict) --* Details about the finding. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "cloudFormationStackUpdate", "codeDeployDeployment". 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'} * **cloudFormationStackUpdate** *(dict) --* Information about the CloudFormation stack creation or update associated with the finding. * **endTime** *(datetime) --* The timestamp for when the CloudFormation stack creation or update ended. Not reported for deployments that are still in progress. * **stackArn** *(string) --* The Amazon Resource Name (ARN) of the CloudFormation stack involved in the update. * **startTime** *(datetime) --* The timestamp for when the CloudFormation stack creation or update began. * **codeDeployDeployment** *(dict) --* Information about the CodeDeploy deployment associated with the finding. * **deploymentGroupArn** *(string) --* The Amazon Resource Name (ARN) of the CodeDeploy deployment group associated with the deployment. * **deploymentId** *(string) --* The ID of the CodeDeploy deployment. * **endTime** *(datetime) --* The timestamp for when the CodeDeploy deployment ended. Not reported for deployments that are still in progress. * **startTime** *(datetime) --* The timestamp for when the CodeDeploy deployment began. * **id** *(string) --* The ID assigned to the finding. * **lastModifiedTime** *(datetime) --* The timestamp for when the finding was most recently updated with additional information. **Exceptions** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / tag_resource tag_resource ************ SSMIncidents.Client.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 to add to the response plan. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSMIncidents.Client.exceptions.ServiceQuotaExceededException" * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.ConflictException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / update_response_plan update_response_plan ******************** SSMIncidents.Client.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', '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': {} }, clientToken='string', displayName='string', engagements=[ 'string', ], incidentTemplateDedupeString='string', incidentTemplateImpact=123, incidentTemplateNotificationTargets=[ { 'snsTopicArn': 'string' }, ], incidentTemplateSummary='string', incidentTemplateTags={ 'string': 'string' }, incidentTemplateTitle='string', integrations=[ { 'pagerDutyConfiguration': { 'name': 'string', 'pagerDutyIncidentConfiguration': { 'serviceId': 'string' }, 'secretId': '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. * **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 can be set: "variable". * **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) --* **[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 Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an 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. **Supported impact codes** * "1" - Critical * "2" - High * "3" - Medium * "4" - Low * "5" - 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. * **incidentTemplateTags** (*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. To call this action, you must also have permission to call the "TagResource" API action for the incident record resource. * *(string) --* * *(string) --* * **incidentTemplateTitle** (*string*) -- The short format name of the incident. The title can't contain spaces. * **integrations** (*list*) -- Information about third-party services integrated into the 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 can be set: "pagerDutyConfiguration". * **pagerDutyConfiguration** *(dict) --* Information about the PagerDuty service where the response plan creates an incident. * **name** *(string) --* **[REQUIRED]** The name of the PagerDuty configuration. * **pagerDutyIncidentConfiguration** *(dict) --* **[REQUIRED]** Details about the PagerDuty service associated with the configuration. * **serviceId** *(string) --* **[REQUIRED]** The ID of the PagerDuty service that the response plan associates with an incident when it launches. * **secretId** *(string) --* **[REQUIRED]** 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. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.ConflictException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / start_incident start_incident ************** SSMIncidents.Client.start_incident(**kwargs) Used to start an incident from CloudWatch alarms, EventBridge events, or manually. See also: AWS API Documentation **Request Syntax** response = client.start_incident( clientToken='string', impact=123, relatedItems=[ { 'generatedId': 'string', 'identifier': { 'type': 'ANALYSIS'|'INCIDENT'|'METRIC'|'PARENT'|'ATTACHMENT'|'OTHER'|'AUTOMATION'|'INVOLVED_RESOURCE'|'TASK', 'value': { 'arn': 'string', 'metricDefinition': 'string', 'pagerDutyIncidentDetail': { 'autoResolve': True|False, 'id': 'string', 'secretId': 'string' }, 'url': 'string' } }, 'title': 'string' }, ], responsePlanArn='string', title='string', triggerDetails={ 'rawData': 'string', 'source': 'string', 'timestamp': datetime(2015, 1, 1), 'triggerArn': 'string' } ) Parameters: * **clientToken** (*string*) -- A token ensuring that the operation is called only once with the specified details. This field is autopopulated if not provided. * **impact** (*integer*) -- Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan. **Supported impact codes** * "1" - Critical * "2" - High * "3" - Medium * "4" - Low * "5" - No Impact * **relatedItems** (*list*) -- Add related items to the incident for other responders to use. Related items are Amazon Web Services resources, external links, or files uploaded to an Amazon S3 bucket. * *(dict) --* Resources that responders use to triage and mitigate the incident. * **generatedId** *(string) --* A unique ID for a "RelatedItem". Warning: Don't specify this parameter when you add a "RelatedItem" by using the UpdateRelatedItems API action. * **identifier** *(dict) --* **[REQUIRED]** Details about the related item. * **type** *(string) --* **[REQUIRED]** The type of related item. * **value** *(dict) --* **[REQUIRED]** Details about the related item. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "arn", "metricDefinition", "pagerDutyIncidentDetail", "url". * **arn** *(string) --* The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource. * **metricDefinition** *(string) --* The metric definition, if the related item is a metric in Amazon CloudWatch. * **pagerDutyIncidentDetail** *(dict) --* Details about an incident that is associated with a PagerDuty incident. * **autoResolve** *(boolean) --* Indicates whether to resolve the PagerDuty incident when you resolve the associated Incident Manager incident. * **id** *(string) --* **[REQUIRED]** The ID of the incident associated with the PagerDuty service for the response plan. * **secretId** *(string) --* The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials. * **url** *(string) --* The URL, if the related item is a non-Amazon Web Services resource. * **title** *(string) --* The title of the related item. * **responsePlanArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the response plan that pre- defines summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident. * **title** (*string*) -- Provide a title for the incident. Providing a title overwrites the title provided by the response plan. * **triggerDetails** (*dict*) -- Details of what created the incident record in Incident Manager. * **rawData** *(string) --* Raw data passed from either Amazon EventBridge, Amazon CloudWatch, or Incident Manager when an incident is created. * **source** *(string) --* **[REQUIRED]** Identifies the service that sourced the event. All events sourced from within Amazon Web Services begin with " "aws."" Customer-generated events can have any value here, as long as it doesn't begin with " "aws."" We recommend the use of Java package-name style reverse domain-name strings. * **timestamp** *(datetime) --* **[REQUIRED]** The timestamp for when the incident was detected. * **triggerArn** *(string) --* The Amazon Resource Name (ARN) of the source that detected the incident. Return type: dict Returns: **Response Syntax** { 'incidentRecordArn': 'string' } **Response Structure** * *(dict) --* * **incidentRecordArn** *(string) --* The ARN of the newly created incident record. **Exceptions** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.ConflictException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / delete_resource_policy delete_resource_policy ********************** SSMIncidents.Client.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** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.InternalServerException" SSMIncidents / Client / update_timeline_event update_timeline_event ********************* SSMIncidents.Client.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', eventReferences=[ { 'relatedItemId': 'string', 'resource': 'string' }, ], eventTime=datetime(2015, 1, 1), eventType='string', incidentRecordArn='string' ) Parameters: * **clientToken** (*string*) -- A token that ensures that a client calls the operation 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 to update. You can use "ListTimelineEvents" to find an event's ID. * **eventReferences** (*list*) -- Updates all existing references in a "TimelineEvent". A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with that resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item. Warning: This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes any existing references and enters only new references. * *(dict) --* An item referenced in a "TimelineEvent" that is involved in or somehow associated with an incident. You can specify an Amazon Resource Name (ARN) for an Amazon Web Services resource or a "RelatedItem" ID. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "relatedItemId", "resource". * **relatedItemId** *(string) --* The ID of a "RelatedItem" referenced in a "TimelineEvent". * **resource** *(string) --* The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a "TimelineEvent". * **eventTime** (*datetime*) -- The timestamp for when the event occurred. * **eventType** (*string*) -- The type of event. You can update events of type "Custom Event" and "Note". * **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** * "SSMIncidents.Client.exceptions.ThrottlingException" * "SSMIncidents.Client.exceptions.ResourceNotFoundException" * "SSMIncidents.Client.exceptions.AccessDeniedException" * "SSMIncidents.Client.exceptions.ValidationException" * "SSMIncidents.Client.exceptions.ConflictException" * "SSMIncidents.Client.exceptions.InternalServerException"