SSMIncidentsClient#
Index > SSMIncidents > SSMIncidentsClient
Auto-generated documentation for SSMIncidents type annotations stubs module types-boto3-ssm-incidents.
SSMIncidentsClient#
Type annotations and code completion for boto3.client("ssm-incidents").
 boto3 documentation
# SSMIncidentsClient usage example
from boto3.session import Session
from types_boto3_ssm_incidents.client import SSMIncidentsClient
def get_ssm-incidents_client() -> SSMIncidentsClient:
    return Session().client("ssm-incidents")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("ssm-incidents").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("ssm-incidents")
try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)# Exceptions.exceptions type checking example
from types_boto3_ssm_incidents.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...Methods#
can_paginate#
Type annotations and code completion for boto3.client("ssm-incidents").can_paginate method.
 boto3 documentation
# can_paginate method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...generate_presigned_url#
Type annotations and code completion for boto3.client("ssm-incidents").generate_presigned_url method.
 boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...batch_get_incident_findings#
Retrieves details about all specified findings for an incident, including descriptive details about each finding.
Type annotations and code completion for boto3.client("ssm-incidents").batch_get_incident_findings method.
 boto3 documentation
# batch_get_incident_findings method definition
def batch_get_incident_findings(
    self,
    *,
    findingIds: Sequence[str],
    incidentRecordArn: str,
) -> BatchGetIncidentFindingsOutputTypeDef:  # (1)
    ...# batch_get_incident_findings method usage example with argument unpacking
kwargs: BatchGetIncidentFindingsInputTypeDef = {  # (1)
    "findingIds": ...,
    "incidentRecordArn": ...,
}
parent.batch_get_incident_findings(**kwargs)create_replication_set#
A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.
Type annotations and code completion for boto3.client("ssm-incidents").create_replication_set method.
 boto3 documentation
# create_replication_set method definition
def create_replication_set(
    self,
    *,
    regions: Mapping[str, RegionMapInputValueTypeDef],  # (1)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateReplicationSetOutputTypeDef:  # (2)
    ...- See Mapping[str, RegionMapInputValueTypeDef]
- See CreateReplicationSetOutputTypeDef
# create_replication_set method usage example with argument unpacking
kwargs: CreateReplicationSetInputTypeDef = {  # (1)
    "regions": ...,
}
parent.create_replication_set(**kwargs)create_response_plan#
Creates a response plan that automates the initial response to incidents.
Type annotations and code completion for boto3.client("ssm-incidents").create_response_plan method.
 boto3 documentation
# create_response_plan method definition
def create_response_plan(
    self,
    *,
    incidentTemplate: IncidentTemplateUnionTypeDef,  # (1)
    name: str,
    actions: Sequence[ActionUnionTypeDef] = ...,  # (2)
    chatChannel: ChatChannelUnionTypeDef = ...,  # (3)
    clientToken: str = ...,
    displayName: str = ...,
    engagements: Sequence[str] = ...,
    integrations: Sequence[IntegrationTypeDef] = ...,  # (4)
    tags: Mapping[str, str] = ...,
) -> CreateResponsePlanOutputTypeDef:  # (5)
    ...- See IncidentTemplateUnionTypeDef
- See Sequence[ActionUnionTypeDef]
- See ChatChannelUnionTypeDef
- See Sequence[IntegrationTypeDef]
- See CreateResponsePlanOutputTypeDef
# create_response_plan method usage example with argument unpacking
kwargs: CreateResponsePlanInputTypeDef = {  # (1)
    "incidentTemplate": ...,
    "name": ...,
}
parent.create_response_plan(**kwargs)create_timeline_event#
Creates a custom timeline event on the incident details page of an incident record.
Type annotations and code completion for boto3.client("ssm-incidents").create_timeline_event method.
 boto3 documentation
# create_timeline_event method definition
def create_timeline_event(
    self,
    *,
    eventData: str,
    eventTime: TimestampTypeDef,
    eventType: str,
    incidentRecordArn: str,
    clientToken: str = ...,
    eventReferences: Sequence[EventReferenceTypeDef] = ...,  # (1)
) -> CreateTimelineEventOutputTypeDef:  # (2)
    ...- See Sequence[EventReferenceTypeDef]
- See CreateTimelineEventOutputTypeDef
# create_timeline_event method usage example with argument unpacking
kwargs: CreateTimelineEventInputTypeDef = {  # (1)
    "eventData": ...,
    "eventTime": ...,
    "eventType": ...,
    "incidentRecordArn": ...,
}
parent.create_timeline_event(**kwargs)delete_incident_record#
Delete an incident record from Incident Manager.
Type annotations and code completion for boto3.client("ssm-incidents").delete_incident_record method.
 boto3 documentation
# delete_incident_record method definition
def delete_incident_record(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...# delete_incident_record method usage example with argument unpacking
kwargs: DeleteIncidentRecordInputTypeDef = {  # (1)
    "arn": ...,
}
parent.delete_incident_record(**kwargs)delete_replication_set#
Deletes all Regions in your replication set.
Type annotations and code completion for boto3.client("ssm-incidents").delete_replication_set method.
 boto3 documentation
# delete_replication_set method definition
def delete_replication_set(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...# delete_replication_set method usage example with argument unpacking
kwargs: DeleteReplicationSetInputTypeDef = {  # (1)
    "arn": ...,
}
parent.delete_replication_set(**kwargs)delete_resource_policy#
Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource.
Type annotations and code completion for boto3.client("ssm-incidents").delete_resource_policy method.
 boto3 documentation
# delete_resource_policy method definition
def delete_resource_policy(
    self,
    *,
    policyId: str,
    resourceArn: str,
) -> Dict[str, Any]:
    ...# delete_resource_policy method usage example with argument unpacking
kwargs: DeleteResourcePolicyInputTypeDef = {  # (1)
    "policyId": ...,
    "resourceArn": ...,
}
parent.delete_resource_policy(**kwargs)delete_response_plan#
Deletes the specified response plan.
Type annotations and code completion for boto3.client("ssm-incidents").delete_response_plan method.
 boto3 documentation
# delete_response_plan method definition
def delete_response_plan(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...# delete_response_plan method usage example with argument unpacking
kwargs: DeleteResponsePlanInputTypeDef = {  # (1)
    "arn": ...,
}
parent.delete_response_plan(**kwargs)delete_timeline_event#
Deletes a timeline event from an incident.
Type annotations and code completion for boto3.client("ssm-incidents").delete_timeline_event method.
 boto3 documentation
# delete_timeline_event method definition
def delete_timeline_event(
    self,
    *,
    eventId: str,
    incidentRecordArn: str,
) -> Dict[str, Any]:
    ...# delete_timeline_event method usage example with argument unpacking
kwargs: DeleteTimelineEventInputTypeDef = {  # (1)
    "eventId": ...,
    "incidentRecordArn": ...,
}
parent.delete_timeline_event(**kwargs)get_incident_record#
Returns the details for the specified incident record.
Type annotations and code completion for boto3.client("ssm-incidents").get_incident_record method.
 boto3 documentation
# get_incident_record method definition
def get_incident_record(
    self,
    *,
    arn: str,
) -> GetIncidentRecordOutputTypeDef:  # (1)
    ...# get_incident_record method usage example with argument unpacking
kwargs: GetIncidentRecordInputTypeDef = {  # (1)
    "arn": ...,
}
parent.get_incident_record(**kwargs)get_replication_set#
Retrieve your Incident Manager replication set.
Type annotations and code completion for boto3.client("ssm-incidents").get_replication_set method.
 boto3 documentation
# get_replication_set method definition
def get_replication_set(
    self,
    *,
    arn: str,
) -> GetReplicationSetOutputTypeDef:  # (1)
    ...# get_replication_set method usage example with argument unpacking
kwargs: GetReplicationSetInputTypeDef = {  # (1)
    "arn": ...,
}
parent.get_replication_set(**kwargs)get_resource_policies#
Retrieves the resource policies attached to the specified response plan.
Type annotations and code completion for boto3.client("ssm-incidents").get_resource_policies method.
 boto3 documentation
# get_resource_policies method definition
def get_resource_policies(
    self,
    *,
    resourceArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetResourcePoliciesOutputTypeDef:  # (1)
    ...# get_resource_policies method usage example with argument unpacking
kwargs: GetResourcePoliciesInputTypeDef = {  # (1)
    "resourceArn": ...,
}
parent.get_resource_policies(**kwargs)get_response_plan#
Retrieves the details of the specified response plan.
Type annotations and code completion for boto3.client("ssm-incidents").get_response_plan method.
 boto3 documentation
# get_response_plan method definition
def get_response_plan(
    self,
    *,
    arn: str,
) -> GetResponsePlanOutputTypeDef:  # (1)
    ...# get_response_plan method usage example with argument unpacking
kwargs: GetResponsePlanInputTypeDef = {  # (1)
    "arn": ...,
}
parent.get_response_plan(**kwargs)get_timeline_event#
Retrieves a timeline event based on its ID and incident record.
Type annotations and code completion for boto3.client("ssm-incidents").get_timeline_event method.
 boto3 documentation
# get_timeline_event method definition
def get_timeline_event(
    self,
    *,
    eventId: str,
    incidentRecordArn: str,
) -> GetTimelineEventOutputTypeDef:  # (1)
    ...# get_timeline_event method usage example with argument unpacking
kwargs: GetTimelineEventInputTypeDef = {  # (1)
    "eventId": ...,
    "incidentRecordArn": ...,
}
parent.get_timeline_event(**kwargs)list_incident_findings#
Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident.
Type annotations and code completion for boto3.client("ssm-incidents").list_incident_findings method.
 boto3 documentation
# list_incident_findings method definition
def list_incident_findings(
    self,
    *,
    incidentRecordArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListIncidentFindingsOutputTypeDef:  # (1)
    ...# list_incident_findings method usage example with argument unpacking
kwargs: ListIncidentFindingsInputTypeDef = {  # (1)
    "incidentRecordArn": ...,
}
parent.list_incident_findings(**kwargs)list_incident_records#
Lists all incident records in your account.
Type annotations and code completion for boto3.client("ssm-incidents").list_incident_records method.
 boto3 documentation
# list_incident_records method definition
def list_incident_records(
    self,
    *,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListIncidentRecordsOutputTypeDef:  # (2)
    ...- See Sequence[FilterTypeDef]
- See ListIncidentRecordsOutputTypeDef
# list_incident_records method usage example with argument unpacking
kwargs: ListIncidentRecordsInputTypeDef = {  # (1)
    "filters": ...,
}
parent.list_incident_records(**kwargs)list_related_items#
List all related items for an incident record.
Type annotations and code completion for boto3.client("ssm-incidents").list_related_items method.
 boto3 documentation
# list_related_items method definition
def list_related_items(
    self,
    *,
    incidentRecordArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListRelatedItemsOutputTypeDef:  # (1)
    ...# list_related_items method usage example with argument unpacking
kwargs: ListRelatedItemsInputTypeDef = {  # (1)
    "incidentRecordArn": ...,
}
parent.list_related_items(**kwargs)list_replication_sets#
Lists details about the replication set configured in your account.
Type annotations and code completion for boto3.client("ssm-incidents").list_replication_sets method.
 boto3 documentation
# list_replication_sets method definition
def list_replication_sets(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListReplicationSetsOutputTypeDef:  # (1)
    ...# list_replication_sets method usage example with argument unpacking
kwargs: ListReplicationSetsInputTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_replication_sets(**kwargs)list_response_plans#
Lists all response plans in your account.
Type annotations and code completion for boto3.client("ssm-incidents").list_response_plans method.
 boto3 documentation
# list_response_plans method definition
def list_response_plans(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListResponsePlansOutputTypeDef:  # (1)
    ...# list_response_plans method usage example with argument unpacking
kwargs: ListResponsePlansInputTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_response_plans(**kwargs)list_tags_for_resource#
Lists the tags that are attached to the specified response plan or incident.
Type annotations and code completion for boto3.client("ssm-incidents").list_tags_for_resource method.
 boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)list_timeline_events#
Lists timeline events for the specified incident record.
Type annotations and code completion for boto3.client("ssm-incidents").list_timeline_events method.
 boto3 documentation
# list_timeline_events method definition
def list_timeline_events(
    self,
    *,
    incidentRecordArn: str,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    sortBy: TimelineEventSortType = ...,  # (2)
    sortOrder: SortOrderType = ...,  # (3)
) -> ListTimelineEventsOutputTypeDef:  # (4)
    ...- See Sequence[FilterTypeDef]
- See TimelineEventSortType
- See SortOrderType
- See ListTimelineEventsOutputTypeDef
# list_timeline_events method usage example with argument unpacking
kwargs: ListTimelineEventsInputTypeDef = {  # (1)
    "incidentRecordArn": ...,
}
parent.list_timeline_events(**kwargs)put_resource_policy#
Adds a resource policy to the specified response plan.
Type annotations and code completion for boto3.client("ssm-incidents").put_resource_policy method.
 boto3 documentation
# put_resource_policy method definition
def put_resource_policy(
    self,
    *,
    policy: str,
    resourceArn: str,
) -> PutResourcePolicyOutputTypeDef:  # (1)
    ...# put_resource_policy method usage example with argument unpacking
kwargs: PutResourcePolicyInputTypeDef = {  # (1)
    "policy": ...,
    "resourceArn": ...,
}
parent.put_resource_policy(**kwargs)start_incident#
Used to start an incident from CloudWatch alarms, EventBridge events, or manually.
Type annotations and code completion for boto3.client("ssm-incidents").start_incident method.
 boto3 documentation
# start_incident method definition
def start_incident(
    self,
    *,
    responsePlanArn: str,
    clientToken: str = ...,
    impact: int = ...,
    relatedItems: Sequence[RelatedItemTypeDef] = ...,  # (1)
    title: str = ...,
    triggerDetails: TriggerDetailsTypeDef = ...,  # (2)
) -> StartIncidentOutputTypeDef:  # (3)
    ...- See Sequence[RelatedItemTypeDef]
- See TriggerDetailsTypeDef
- See StartIncidentOutputTypeDef
# start_incident method usage example with argument unpacking
kwargs: StartIncidentInputTypeDef = {  # (1)
    "responsePlanArn": ...,
}
parent.start_incident(**kwargs)tag_resource#
Adds a tag to a response plan.
Type annotations and code completion for boto3.client("ssm-incidents").tag_resource method.
 boto3 documentation
# tag_resource method definition
def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}
parent.tag_resource(**kwargs)untag_resource#
Removes a tag from a resource.
Type annotations and code completion for boto3.client("ssm-incidents").untag_resource method.
 boto3 documentation
# untag_resource method definition
def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}
parent.untag_resource(**kwargs)update_deletion_protection#
Update deletion protection to either allow or deny deletion of the final Region in a replication set.
Type annotations and code completion for boto3.client("ssm-incidents").update_deletion_protection method.
 boto3 documentation
# update_deletion_protection method definition
def update_deletion_protection(
    self,
    *,
    arn: str,
    deletionProtected: bool,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...# update_deletion_protection method usage example with argument unpacking
kwargs: UpdateDeletionProtectionInputTypeDef = {  # (1)
    "arn": ...,
    "deletionProtected": ...,
}
parent.update_deletion_protection(**kwargs)update_incident_record#
Update the details of an incident record.
Type annotations and code completion for boto3.client("ssm-incidents").update_incident_record method.
 boto3 documentation
# update_incident_record method definition
def update_incident_record(
    self,
    *,
    arn: str,
    chatChannel: ChatChannelUnionTypeDef = ...,  # (1)
    clientToken: str = ...,
    impact: int = ...,
    notificationTargets: Sequence[NotificationTargetItemTypeDef] = ...,  # (2)
    status: IncidentRecordStatusType = ...,  # (3)
    summary: str = ...,
    title: str = ...,
) -> Dict[str, Any]:
    ...- See ChatChannelUnionTypeDef
- See Sequence[NotificationTargetItemTypeDef]
- See IncidentRecordStatusType
# update_incident_record method usage example with argument unpacking
kwargs: UpdateIncidentRecordInputTypeDef = {  # (1)
    "arn": ...,
}
parent.update_incident_record(**kwargs)update_related_items#
Add or remove related items from the related items tab of an incident record.
Type annotations and code completion for boto3.client("ssm-incidents").update_related_items method.
 boto3 documentation
# update_related_items method definition
def update_related_items(
    self,
    *,
    incidentRecordArn: str,
    relatedItemsUpdate: RelatedItemsUpdateTypeDef,  # (1)
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...# update_related_items method usage example with argument unpacking
kwargs: UpdateRelatedItemsInputTypeDef = {  # (1)
    "incidentRecordArn": ...,
    "relatedItemsUpdate": ...,
}
parent.update_related_items(**kwargs)update_replication_set#
Add or delete Regions from your replication set.
Type annotations and code completion for boto3.client("ssm-incidents").update_replication_set method.
 boto3 documentation
# update_replication_set method definition
def update_replication_set(
    self,
    *,
    actions: Sequence[UpdateReplicationSetActionTypeDef],  # (1)
    arn: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...- See Sequence[UpdateReplicationSetActionTypeDef]
# update_replication_set method usage example with argument unpacking
kwargs: UpdateReplicationSetInputTypeDef = {  # (1)
    "actions": ...,
    "arn": ...,
}
parent.update_replication_set(**kwargs)update_response_plan#
Updates the specified response plan.
Type annotations and code completion for boto3.client("ssm-incidents").update_response_plan method.
 boto3 documentation
# update_response_plan method definition
def update_response_plan(
    self,
    *,
    arn: str,
    actions: Sequence[ActionUnionTypeDef] = ...,  # (1)
    chatChannel: ChatChannelUnionTypeDef = ...,  # (2)
    clientToken: str = ...,
    displayName: str = ...,
    engagements: Sequence[str] = ...,
    incidentTemplateDedupeString: str = ...,
    incidentTemplateImpact: int = ...,
    incidentTemplateNotificationTargets: Sequence[NotificationTargetItemTypeDef] = ...,  # (3)
    incidentTemplateSummary: str = ...,
    incidentTemplateTags: Mapping[str, str] = ...,
    incidentTemplateTitle: str = ...,
    integrations: Sequence[IntegrationTypeDef] = ...,  # (4)
) -> Dict[str, Any]:
    ...- See Sequence[ActionUnionTypeDef]
- See ChatChannelUnionTypeDef
- See Sequence[NotificationTargetItemTypeDef]
- See Sequence[IntegrationTypeDef]
# update_response_plan method usage example with argument unpacking
kwargs: UpdateResponsePlanInputTypeDef = {  # (1)
    "arn": ...,
}
parent.update_response_plan(**kwargs)update_timeline_event#
Updates a timeline event.
Type annotations and code completion for boto3.client("ssm-incidents").update_timeline_event method.
 boto3 documentation
# update_timeline_event method definition
def update_timeline_event(
    self,
    *,
    eventId: str,
    incidentRecordArn: str,
    clientToken: str = ...,
    eventData: str = ...,
    eventReferences: Sequence[EventReferenceTypeDef] = ...,  # (1)
    eventTime: TimestampTypeDef = ...,
    eventType: str = ...,
) -> Dict[str, Any]:
    ...- See Sequence[EventReferenceTypeDef]
# update_timeline_event method usage example with argument unpacking
kwargs: UpdateTimelineEventInputTypeDef = {  # (1)
    "eventId": ...,
    "incidentRecordArn": ...,
}
parent.update_timeline_event(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("ssm-incidents").get_paginator method with overloads.
- client.get_paginator("get_resource_policies")-> GetResourcePoliciesPaginator
- client.get_paginator("list_incident_findings")-> ListIncidentFindingsPaginator
- client.get_paginator("list_incident_records")-> ListIncidentRecordsPaginator
- client.get_paginator("list_related_items")-> ListRelatedItemsPaginator
- client.get_paginator("list_replication_sets")-> ListReplicationSetsPaginator
- client.get_paginator("list_response_plans")-> ListResponsePlansPaginator
- client.get_paginator("list_timeline_events")-> ListTimelineEventsPaginator
get_waiter#
Type annotations and code completion for boto3.client("ssm-incidents").get_waiter method with overloads.
- client.get_waiter("wait_for_replication_set_active")-> WaitForReplicationSetActiveWaiter
- client.get_waiter("wait_for_replication_set_deleted")-> WaitForReplicationSetDeletedWaiter