mypy-boto3-security-ir Type Annotations

1.42.3 · active · verified Sat Apr 11

This library provides type annotations (stubs) for the `boto3` AWS Security Incident Response service client. It enhances development experience by enabling static type checking with tools like MyPy, catching potential errors early. Currently at version 1.42.3, this package is part of the `mypy-boto3` ecosystem, which generates new versions frequently to keep up with AWS service updates and `boto3` releases.

Warnings

breaking Python 3.8 support has been removed since `mypy-boto3-builder` version 8.12.0. All generated stubs, including `mypy-boto3-security-ir`, now require Python 3.9 or newer.
Fix: Upgrade your Python environment to 3.9 or higher. If you need Python 3.8 support, pin `mypy-boto3-builder` to an earlier version (e.g., `<8.12.0`) and regenerate/use older stub versions if available.
breaking All `mypy-boto3` packages migrated to PEP 561 packaging (namespace packages) in `mypy-boto3-builder` 8.12.0. This change affects how MyPy might locate packages, especially in complex project structures.
Fix: Ensure your `sys.path` and MyPy configuration (`mypy.ini` or `pyproject.toml`) correctly resolve namespace packages. Typically, installing via pip handles this, but custom setups might need adjustment. Verify MyPy can find the stubs by running it after the update.
gotcha `mypy-boto3-security-ir` provides *only* type stubs. For runtime functionality, the `boto3` library itself must be installed alongside the stub package.
Fix: Always install `boto3` in addition to `mypy-boto3-security-ir` using `pip install boto3 mypy-boto3-security-ir`.
gotcha The service name passed to `boto3.client()` must exactly match the expected string, which is `'security-incident-response'` for this service. Mismatches will result in runtime errors from `boto3` and potentially incorrect type hints if a different stub package is inadvertently used.
Fix: Always use `boto3.client("security-incident-response")` when interacting with the Security Incident Response service.
breaking TypeDef naming conventions changed in `mypy-boto3-builder` 8.9.0. Specifically, `RequestRequestTypeDef` was shortened to `RequestTypeDef`, and `ExtraRequestTypeDef` became `RequestExtraTypeDef`. If you directly import or refer to these generated TypeDef names, your code might break.
Fix: Review your code for direct imports or references to generated TypeDef names and update them according to the new naming conventions. Consult the `mypy-boto3-security-ir` source for the exact TypeDef names.

Install

pip install boto3 mypy-boto3-security-ir Install with boto3

Imports

SecurityIncidentResponseClient
```
from mypy_boto3_security_ir.client import SecurityIncidentResponseClient
```
Client types are nested under the 'client' submodule.
SecurityIncidentResponseServiceName
```
from mypy_boto3_security_ir.type_defs import SecurityIncidentResponseServiceName
```
Service names and TypeDefs are commonly imported directly from their respective submodules for clarity and type hinting.
ListIncidentRecordsOutputTypeDef
```
from mypy_boto3_security_ir.type_defs import ListIncidentRecordsOutputTypeDef
```
Request and response TypeDefs reside in the 'type_defs' submodule, not 'client'.

Quickstart

This quickstart demonstrates how to initialize a `boto3` client for AWS Security Incident Response and type-hint it using `mypy-boto3-security-ir`. It then calls `list_incident_records` with its return type hinted. For actual usage, ensure valid AWS credentials and region are configured.

import boto3
from mypy_boto3_security_ir.client import SecurityIncidentResponseClient
from mypy_boto3_security_ir.type_defs import ListIncidentRecordsOutputTypeDef
import os

# Ensure boto3 is configured, e.g., via environment variables or ~/.aws/credentials
# For demonstration, we'll use a dummy client, but in real-world, provide credentials.
# Boto3 client initialization with type hint
client: SecurityIncidentResponseClient = boto3.client(
    "security-incident-response",
    region_name=os.environ.get('AWS_REGION', 'us-east-1'),
    aws_access_key_id=os.environ.get('AWS_ACCESS_KEY_ID', 'dummy'),
    aws_secret_access_key=os.environ.get('AWS_SECRET_ACCESS_KEY', 'dummy'),
)

# Call a method and type hint its output
try:
    response: ListIncidentRecordsOutputTypeDef = client.list_incident_records()
    print("Successfully listed incident records (or empty list if none):", response.get('incidentRecords'))
except Exception as e:
    print(f"An error occurred: {e}")
    print("Please ensure your AWS credentials and region are correctly configured and you have permissions.")

view raw JSON →