Type Annotations for boto3 SSM Incidents

1.42.3 · active · verified Sat Apr 11

mypy-boto3-ssm-incidents provides official type annotations (stubs) for the boto3 AWS SSM Incidents service client. It allows users to leverage static type checking with tools like MyPy, improving code quality and catching errors early. This library is automatically generated by the `mypy-boto3-builder` and its version typically aligns with the corresponding `boto3` service version. The current version is 1.42.3, reflecting the boto3 API version, and updates frequently alongside new boto3 releases.

Warnings

breaking Python 3.8 is no longer supported by `mypy-boto3-builder` and consequently by `mypy-boto3` packages generated with it.
Fix: Upgrade your Python environment to version 3.9 or newer.
breaking `mypy-boto3` packages migrated to PEP 561. This change affects how MyPy locates and uses the stubs.
Fix: Ensure your `mypy` configuration is up-to-date and compatible with PEP 561 packages. Update MyPy if necessary.
gotcha Type stub imports (`from mypy_boto3_ssm_incidents import ...`) should always be wrapped in an `if TYPE_CHECKING:` block.
Fix: Wrap all `mypy-boto3` specific imports within `if TYPE_CHECKING: ...` to prevent runtime import errors if the stub package is not installed as a direct runtime dependency.
gotcha `mypy-boto3-ssm-incidents` provides *only* type annotations. The actual `boto3` library must be installed separately for your code to run.
Fix: Always ensure `boto3` is included in your project's runtime dependencies (`pip install boto3`).
breaking TypeDef naming conventions changed in earlier `mypy-boto3-builder` versions, impacting how some specific TypeDefs are named (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`).
Fix: When upgrading `mypy-boto3` packages across major builder versions, review your code for explicit `from ...type_defs import ...` imports and adjust TypeDef names if they no longer match the generated stubs.

Install

pip install mypy-boto3-ssm-incidents boto3 Install with boto3

Imports

SSMIncidentsClient

from mypy_boto3_ssm_incidents import SSMIncidentsClient

GetIncidentRecordOutputTypeDef

from mypy_boto3_ssm_incidents.type_defs import GetIncidentRecordOutputTypeDef

Quickstart

This quickstart demonstrates how to use `mypy-boto3-ssm-incidents` for type-hinting a boto3 SSM Incidents client. It shows the use of `TYPE_CHECKING` to guard stub imports and provides an example API call with inferred types.

import os
import boto3
from typing import TYPE_CHECKING

# These imports are only for type checking purposes.
# They are ignored at runtime if TYPE_CHECKING is False.
if TYPE_CHECKING:
    from mypy_boto3_ssm_incidents import SSMIncidentsClient
    from mypy_boto3_ssm_incidents.type_defs import GetIncidentRecordOutputTypeDef

# Initialize the boto3 client at runtime
# Ensure AWS credentials are configured (e.g., via environment variables or ~/.aws/credentials)
client: 'SSMIncidentsClient' = boto3.client(
    "ssm-incidents",
    region_name=os.environ.get("AWS_REGION", "us-east-1")
)

# Example API call with type hints
try:
    # Use a dummy ARN for demonstration; replace with a valid one if you have it
    incident_arn = "arn:aws:ssm-incidents::123456789012:incident-record/example-incident"
    
    response: 'GetIncidentRecordOutputTypeDef' = client.get_incident_record(
        incidentRecordArn=incident_arn
    )
    print(f"Incident found: {response['incidentRecord']['title']}")
except client.exceptions.ResourceNotFoundException:
    print(f"Incident record '{incident_arn}' not found (as expected for example ARN).")
except Exception as e:
    print(f"An error occurred: {e}")

print("Type checking setup successful!")

view raw JSON →