Skip to content

CloudTrail module#

Index > CloudTrail

Auto-generated documentation for CloudTrail type annotations stubs module mypy-boto3-cloudtrail.

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.38.18' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add CloudTrail service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and CloudTrail.

From PyPI with pip#

Install boto3-stubs for CloudTrail service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[cloudtrail]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[cloudtrail]'

# standalone installation
python -m pip install mypy-boto3-cloudtrail

How to uninstall#

python -m pip uninstall -y mypy-boto3-cloudtrail

Usage#

Code samples can be found in Examples.

CloudTrailClient#

Type annotations and code completion for boto3.client("cloudtrail") as CloudTrailClient boto3 documentation

# CloudTrailClient usage example

from boto3.session import Session

from mypy_boto3_cloudtrail.client import CloudTrailClient

def get_client() -> CloudTrailClient:
    return Session().client("cloudtrail")

Paginators#

Type annotations and code completion for paginators from boto3.client("cloudtrail").get_paginator("...").

# ListImportFailuresPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudtrail.paginator import ListImportFailuresPaginator

def get_list_import_failures_paginator() -> ListImportFailuresPaginator:
    return Session().client("cloudtrail").get_paginator("list_import_failures"))

Literals#

Type annotations for literals used in methods and schema.

# BillingModeType usage example

from mypy_boto3_cloudtrail.literals import BillingModeType

def get_value() -> BillingModeType:
    return "EXTENDABLE_RETENTION_PRICING"

Type definitions#

Type annotations for type definitions used in methods and schema.