SSMIncidentsClient

Index > SSMIncidents > SSMIncidentsClient

Auto-generated documentation for SSMIncidents type annotations stubs module mypy-boto3-ssm-incidents.

SSMIncidentsClient

Type annotations and code completion for boto3.client("ssm-incidents"). boto3 documentation

Usage example

from boto3.session import Session
from mypy_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.

Usage example

client = boto3.client("ssm-incidents")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)

Type checking example

from mypy_boto3_ssm_incidents.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("ssm-incidents").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("ssm-incidents").close method. boto3 documentation

Method definition

def close(
    self,
) -> None:
    ...

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

Method definition

def create_replication_set(
    self,
    *,
    regions: Mapping[str, RegionMapInputValueTypeDef],  # (1)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateReplicationSetOutputTypeDef:  # (2)
    ...

1. See RegionMapInputValueTypeDef
2. See CreateReplicationSetOutputTypeDef

Usage example with kwargs

kwargs: CreateReplicationSetInputRequestTypeDef = {  # (1)
    "regions": ...,
}

parent.create_replication_set(**kwargs)

1. See CreateReplicationSetInputRequestTypeDef

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

Method definition

def create_response_plan(
    self,
    *,
    incidentTemplate: IncidentTemplateTypeDef,  # (1)
    name: str,
    actions: Sequence[ActionTypeDef] = ...,  # (2)
    chatChannel: ChatChannelTypeDef = ...,  # (3)
    clientToken: str = ...,
    displayName: str = ...,
    engagements: Sequence[str] = ...,
    integrations: Sequence[IntegrationTypeDef] = ...,  # (4)
    tags: Mapping[str, str] = ...,
) -> CreateResponsePlanOutputTypeDef:  # (5)
    ...

1. See IncidentTemplateTypeDef
2. See ActionTypeDef
3. See ChatChannelTypeDef
4. See IntegrationTypeDef
5. See CreateResponsePlanOutputTypeDef

Usage example with kwargs

kwargs: CreateResponsePlanInputRequestTypeDef = {  # (1)
    "incidentTemplate": ...,
    "name": ...,
}

parent.create_response_plan(**kwargs)

1. See CreateResponsePlanInputRequestTypeDef

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

Method definition

def create_timeline_event(
    self,
    *,
    eventData: str,
    eventTime: Union[datetime, str],
    eventType: str,
    incidentRecordArn: str,
    clientToken: str = ...,
    eventReferences: Sequence[EventReferenceTypeDef] = ...,  # (1)
) -> CreateTimelineEventOutputTypeDef:  # (2)
    ...

1. See EventReferenceTypeDef
2. See CreateTimelineEventOutputTypeDef

Usage example with kwargs

kwargs: CreateTimelineEventInputRequestTypeDef = {  # (1)
    "eventData": ...,
    "eventTime": ...,
    "eventType": ...,
    "incidentRecordArn": ...,
}

parent.create_timeline_event(**kwargs)

1. See CreateTimelineEventInputRequestTypeDef

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

Method definition

def delete_incident_record(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteIncidentRecordInputRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_incident_record(**kwargs)

1. See DeleteIncidentRecordInputRequestTypeDef

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

Method definition

def delete_replication_set(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteReplicationSetInputRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_replication_set(**kwargs)

1. See DeleteReplicationSetInputRequestTypeDef

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

Method definition

def delete_resource_policy(
    self,
    *,
    policyId: str,
    resourceArn: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteResourcePolicyInputRequestTypeDef = {  # (1)
    "policyId": ...,
    "resourceArn": ...,
}

parent.delete_resource_policy(**kwargs)

1. See DeleteResourcePolicyInputRequestTypeDef

delete_response_plan

Deletes the specified response plan.

Type annotations and code completion for boto3.client("ssm-incidents").delete_response_plan method. boto3 documentation

Method definition

def delete_response_plan(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteResponsePlanInputRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_response_plan(**kwargs)

1. See DeleteResponsePlanInputRequestTypeDef

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

Method definition

def delete_timeline_event(
    self,
    *,
    eventId: str,
    incidentRecordArn: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteTimelineEventInputRequestTypeDef = {  # (1)
    "eventId": ...,
    "incidentRecordArn": ...,
}

parent.delete_timeline_event(**kwargs)

1. See DeleteTimelineEventInputRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("ssm-incidents").generate_presigned_url method. boto3 documentation

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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

Method definition

def get_incident_record(
    self,
    *,
    arn: str,
) -> GetIncidentRecordOutputTypeDef:  # (1)
    ...

1. See GetIncidentRecordOutputTypeDef

Usage example with kwargs

kwargs: GetIncidentRecordInputRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_incident_record(**kwargs)

1. See GetIncidentRecordInputRequestTypeDef

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

Method definition

def get_replication_set(
    self,
    *,
    arn: str,
) -> GetReplicationSetOutputTypeDef:  # (1)
    ...

1. See GetReplicationSetOutputTypeDef

Usage example with kwargs

kwargs: GetReplicationSetInputRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_replication_set(**kwargs)

1. See GetReplicationSetInputRequestTypeDef

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

Method definition

def get_resource_policies(
    self,
    *,
    resourceArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetResourcePoliciesOutputTypeDef:  # (1)
    ...

1. See GetResourcePoliciesOutputTypeDef

Usage example with kwargs

kwargs: GetResourcePoliciesInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.get_resource_policies(**kwargs)

1. See GetResourcePoliciesInputRequestTypeDef

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

Method definition

def get_response_plan(
    self,
    *,
    arn: str,
) -> GetResponsePlanOutputTypeDef:  # (1)
    ...

1. See GetResponsePlanOutputTypeDef

Usage example with kwargs

kwargs: GetResponsePlanInputRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_response_plan(**kwargs)

1. See GetResponsePlanInputRequestTypeDef

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

Method definition

def get_timeline_event(
    self,
    *,
    eventId: str,
    incidentRecordArn: str,
) -> GetTimelineEventOutputTypeDef:  # (1)
    ...

1. See GetTimelineEventOutputTypeDef

Usage example with kwargs

kwargs: GetTimelineEventInputRequestTypeDef = {  # (1)
    "eventId": ...,
    "incidentRecordArn": ...,
}

parent.get_timeline_event(**kwargs)

1. See GetTimelineEventInputRequestTypeDef

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

Method definition

def list_incident_records(
    self,
    *,
    filters: Sequence[FilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListIncidentRecordsOutputTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See ListIncidentRecordsOutputTypeDef

Usage example with kwargs

kwargs: ListIncidentRecordsInputRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.list_incident_records(**kwargs)

1. See ListIncidentRecordsInputRequestTypeDef

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

Method definition

def list_related_items(
    self,
    *,
    incidentRecordArn: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListRelatedItemsOutputTypeDef:  # (1)
    ...

1. See ListRelatedItemsOutputTypeDef

Usage example with kwargs

kwargs: ListRelatedItemsInputRequestTypeDef = {  # (1)
    "incidentRecordArn": ...,
}

parent.list_related_items(**kwargs)

1. See ListRelatedItemsInputRequestTypeDef

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

Method definition

def list_replication_sets(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListReplicationSetsOutputTypeDef:  # (1)
    ...

1. See ListReplicationSetsOutputTypeDef

Usage example with kwargs

kwargs: ListReplicationSetsInputRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_replication_sets(**kwargs)

1. See ListReplicationSetsInputRequestTypeDef

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

Method definition

def list_response_plans(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListResponsePlansOutputTypeDef:  # (1)
    ...

1. See ListResponsePlansOutputTypeDef

Usage example with kwargs

kwargs: ListResponsePlansInputRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_response_plans(**kwargs)

1. See ListResponsePlansInputRequestTypeDef

list_tags_for_resource

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

Type annotations and code completion for boto3.client("ssm-incidents").list_tags_for_resource method. boto3 documentation

Method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

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

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

1. See FilterTypeDef
2. See TimelineEventSortType
3. See SortOrderType
4. See ListTimelineEventsOutputTypeDef

Usage example with kwargs

kwargs: ListTimelineEventsInputRequestTypeDef = {  # (1)
    "incidentRecordArn": ...,
}

parent.list_timeline_events(**kwargs)

1. See ListTimelineEventsInputRequestTypeDef

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

Method definition

def put_resource_policy(
    self,
    *,
    policy: str,
    resourceArn: str,
) -> PutResourcePolicyOutputTypeDef:  # (1)
    ...

1. See PutResourcePolicyOutputTypeDef

Usage example with kwargs

kwargs: PutResourcePolicyInputRequestTypeDef = {  # (1)
    "policy": ...,
    "resourceArn": ...,
}

parent.put_resource_policy(**kwargs)

1. See PutResourcePolicyInputRequestTypeDef

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

Method definition

def start_incident(
    self,
    *,
    responsePlanArn: str,
    clientToken: str = ...,
    impact: int = ...,
    relatedItems: Sequence[RelatedItemTypeDef] = ...,  # (1)
    title: str = ...,
    triggerDetails: TriggerDetailsTypeDef = ...,  # (2)
) -> StartIncidentOutputTypeDef:  # (3)
    ...

1. See RelatedItemTypeDef
2. See TriggerDetailsTypeDef
3. See StartIncidentOutputTypeDef

Usage example with kwargs

kwargs: StartIncidentInputRequestTypeDef = {  # (1)
    "responsePlanArn": ...,
}

parent.start_incident(**kwargs)

1. See StartIncidentInputRequestTypeDef

tag_resource

Adds a tag to a response plan.

Type annotations and code completion for boto3.client("ssm-incidents").tag_resource method. boto3 documentation

Method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes a tag from a resource.

Type annotations and code completion for boto3.client("ssm-incidents").untag_resource method. boto3 documentation

Method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

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

Method definition

def update_deletion_protection(
    self,
    *,
    arn: str,
    deletionProtected: bool,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UpdateDeletionProtectionInputRequestTypeDef = {  # (1)
    "arn": ...,
    "deletionProtected": ...,
}

parent.update_deletion_protection(**kwargs)

1. See UpdateDeletionProtectionInputRequestTypeDef

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

Method definition

def update_incident_record(
    self,
    *,
    arn: str,
    chatChannel: ChatChannelTypeDef = ...,  # (1)
    clientToken: str = ...,
    impact: int = ...,
    notificationTargets: Sequence[NotificationTargetItemTypeDef] = ...,  # (2)
    status: IncidentRecordStatusType = ...,  # (3)
    summary: str = ...,
    title: str = ...,
) -> Dict[str, Any]:
    ...

1. See ChatChannelTypeDef
2. See NotificationTargetItemTypeDef
3. See IncidentRecordStatusType

Usage example with kwargs

kwargs: UpdateIncidentRecordInputRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.update_incident_record(**kwargs)

1. See UpdateIncidentRecordInputRequestTypeDef

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

Method definition

def update_related_items(
    self,
    *,
    incidentRecordArn: str,
    relatedItemsUpdate: RelatedItemsUpdateTypeDef,  # (1)
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

1. See RelatedItemsUpdateTypeDef

Usage example with kwargs

kwargs: UpdateRelatedItemsInputRequestTypeDef = {  # (1)
    "incidentRecordArn": ...,
    "relatedItemsUpdate": ...,
}

parent.update_related_items(**kwargs)

1. See UpdateRelatedItemsInputRequestTypeDef

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

Method definition

def update_replication_set(
    self,
    *,
    actions: Sequence[UpdateReplicationSetActionTypeDef],  # (1)
    arn: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

1. See UpdateReplicationSetActionTypeDef

Usage example with kwargs

kwargs: UpdateReplicationSetInputRequestTypeDef = {  # (1)
    "actions": ...,
    "arn": ...,
}

parent.update_replication_set(**kwargs)

1. See UpdateReplicationSetInputRequestTypeDef

update_response_plan

Updates the specified response plan.

Type annotations and code completion for boto3.client("ssm-incidents").update_response_plan method. boto3 documentation

Method definition

def update_response_plan(
    self,
    *,
    arn: str,
    actions: Sequence[ActionTypeDef] = ...,  # (1)
    chatChannel: ChatChannelTypeDef = ...,  # (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]:
    ...

1. See ActionTypeDef
2. See ChatChannelTypeDef
3. See NotificationTargetItemTypeDef
4. See IntegrationTypeDef

Usage example with kwargs

kwargs: UpdateResponsePlanInputRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.update_response_plan(**kwargs)

1. See UpdateResponsePlanInputRequestTypeDef

update_timeline_event

Updates a timeline event.

Type annotations and code completion for boto3.client("ssm-incidents").update_timeline_event method. boto3 documentation

Method definition

def update_timeline_event(
    self,
    *,
    eventId: str,
    incidentRecordArn: str,
    clientToken: str = ...,
    eventData: str = ...,
    eventReferences: Sequence[EventReferenceTypeDef] = ...,  # (1)
    eventTime: Union[datetime, str] = ...,
    eventType: str = ...,
) -> Dict[str, Any]:
    ...

1. See EventReferenceTypeDef

Usage example with kwargs

kwargs: UpdateTimelineEventInputRequestTypeDef = {  # (1)
    "eventId": ...,
    "incidentRecordArn": ...,
}

parent.update_timeline_event(**kwargs)

1. See UpdateTimelineEventInputRequestTypeDef

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