mypy-boto3-codeguru-security

Warnings

• breaking The `mypy-boto3-builder` (which generates this stub package) dropped support for Python 3.8 in version 8.12.0. All generated stub packages now require Python 3.9 or newer.
  Fix: Upgrade your Python environment to 3.9 or higher.
• gotcha This package provides only type stubs and does not install `boto3` itself. You must explicitly install `boto3` alongside this stub package for your application to function at runtime.
  Fix: Ensure `boto3` is included in your project's dependencies and installed (e.g., `pip install boto3 mypy-boto3-codeguru-security`).
• breaking For advanced users who directly import `TypeDef` objects, `mypy-boto3-builder` version 8.9.0 introduced breaking changes to TypeDef naming conventions (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`).
  Fix: Review your imports of specific `TypeDef` classes and update their names according to the new conventions (e.g., look for removed `Request` suffixes or shifted `Extra` postfixes).
• gotcha AWS service names can occasionally change or be deprecated (e.g., 'sms-voice' to 'pinpoint-sms-voice' in older builder versions). While 'codeguru-security' is stable, be aware that the specific stub package you need might change if the underlying AWS service name evolves.
  Fix: Always refer to the official `mypy-boto3` documentation or `boto3` documentation for the latest service names and corresponding stub package names if you encounter import errors for specific services.

Install

• pip install mypy-boto3-codeguru-security boto3 Install library and boto3
• pip install mypy Install Mypy (if not already)

Imports

• CodeGuruSecurityClient

  from mypy_boto3_codeguru_security.client import CodeGuruSecurityClient

  Import the specific client type for explicit type hinting of the boto3 client object.
• ListFindingsResponseTypeDef

  from mypy_boto3_codeguru_security.type_defs import ListFindingsResponseTypeDef

  Import specific TypedDicts for precise type hinting of API responses or request parameters. These are nested under `type_defs`.

Quickstart

This example demonstrates how to create a `boto3` client for CodeGuruSecurity with explicit type hints and then use it to list findings, leveraging paginators. To run this, ensure `boto3` and `mypy-boto3-codeguru-security` are installed, and your AWS credentials are configured (e.g., via environment variables or AWS CLI configuration).

import boto3
from mypy_boto3_codeguru_security.client import CodeGuruSecurityClient
from mypy_boto3_codeguru_security.type_defs import ListFindingsResponseTypeDef

def get_codeguru_security_client() -> CodeGuruSecurityClient:
    """Initializes and returns a CodeGuruSecurity client with type hints."""
    # boto3 automatically picks up credentials from environment variables or IAM roles
    # For local testing, ensure AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN (optional) are set.
    return boto3.client("codeguru-security")

def list_all_findings(client: CodeGuruSecurityClient) -> None:
    """Lists CodeGuruSecurity findings and prints their IDs."""
    print("Listing CodeGuruSecurity findings...")
    paginator = client.get_paginator("list_findings")
    page_iterator = paginator.paginate()

    found_findings = 0
    for page in page_iterator:
        page_data: ListFindingsResponseTypeDef = page
        for finding in page_data.get("findings", []):
            print(f"  Finding ID: {finding.get('id')}")
            found_findings += 1
    if found_findings == 0:
        print("  No findings found.")
    else:
        print(f"Found {found_findings} findings.")

if __name__ == "__main__":
    # Example usage
    codeguru_client = get_codeguru_security_client()
    list_all_findings(codeguru_client)