Skip to content

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

# SSMIncidentsClient 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.

# 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 mypy_boto3_ssm_incidents.client import Exceptions

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

Methods#

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)
    ...
  1. See BatchGetIncidentFindingsOutputTypeDef
# batch_get_incident_findings method usage example with argument unpacking

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

parent.batch_get_incident_findings(**kwargs)
  1. See BatchGetIncidentFindingsInputRequestTypeDef

can_paginate#

Check if an operation can be paginated.

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

close#

Closes underlying endpoint connections.

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

# close 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

# create_replication_set 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
# create_replication_set method usage example with argument unpacking

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

# create_response_plan 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
# create_response_plan method usage example with argument unpacking

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

# create_timeline_event 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
# create_timeline_event method usage example with argument unpacking

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

# 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: 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

# 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: 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

# 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: 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

# 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: 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

# 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: 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

# generate_presigned_url 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

# get_incident_record method definition

def get_incident_record(
    self,
    *,
    arn: str,
) -> GetIncidentRecordOutputTypeDef:  # (1)
    ...
  1. See GetIncidentRecordOutputTypeDef
# get_incident_record method usage example with argument unpacking

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.