CloudTrail module#
Index > CloudTrail
Auto-generated documentation for CloudTrail type annotations stubs module mypy-boto3-cloudtrail.
How to install#
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"))
- ListImportFailuresPaginator
- ListImportsPaginator
- ListPublicKeysPaginator
- ListTagsPaginator
- ListTrailsPaginator
- LookupEventsPaginator
Literals#
Type annotations for literals used in methods and schemas.
# DeliveryStatusType usage example
from mypy_boto3_cloudtrail.literals import DeliveryStatusType
def get_value() -> DeliveryStatusType:
return "ACCESS_DENIED"
- DeliveryStatusType
- DestinationTypeType
- EventCategoryType
- EventDataStoreStatusType
- ImportFailureStatusType
- ImportStatusType
- InsightTypeType
- ListImportFailuresPaginatorName
- ListImportsPaginatorName
- ListPublicKeysPaginatorName
- ListTagsPaginatorName
- ListTrailsPaginatorName
- LookupAttributeKeyType
- LookupEventsPaginatorName
- QueryStatusType
- ReadWriteTypeType
- CloudTrailServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# TagTypeDef usage example
from mypy_boto3_cloudtrail.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
- TagTypeDef
- AdvancedFieldSelectorTypeDef
- CancelQueryRequestRequestTypeDef
- CancelQueryResponseTypeDef
- ChannelTypeDef
- DestinationTypeDef
- CreateTrailResponseTypeDef
- DataResourceTypeDef
- DeleteChannelRequestRequestTypeDef
- DeleteEventDataStoreRequestRequestTypeDef
- DeleteResourcePolicyRequestRequestTypeDef
- DeleteTrailRequestRequestTypeDef
- DeregisterOrganizationDelegatedAdminRequestRequestTypeDef
- DescribeQueryRequestRequestTypeDef
- QueryStatisticsForDescribeQueryTypeDef
- DescribeTrailsRequestRequestTypeDef
- TrailTypeDef
- ResourceTypeDef
- GetChannelRequestRequestTypeDef
- IngestionStatusTypeDef
- GetEventDataStoreRequestRequestTypeDef
- GetEventSelectorsRequestRequestTypeDef
- GetImportRequestRequestTypeDef
- ImportStatisticsTypeDef
- GetInsightSelectorsRequestRequestTypeDef
- InsightSelectorTypeDef
- GetQueryResultsRequestRequestTypeDef
- QueryStatisticsTypeDef
- GetResourcePolicyRequestRequestTypeDef
- GetResourcePolicyResponseTypeDef
- GetTrailRequestRequestTypeDef
- GetTrailStatusRequestRequestTypeDef
- GetTrailStatusResponseTypeDef
- ImportFailureListItemTypeDef
- S3ImportSourceTypeDef
- ImportsListItemTypeDef
- ListChannelsRequestRequestTypeDef
- ListEventDataStoresRequestRequestTypeDef
- ListImportFailuresRequestListImportFailuresPaginateTypeDef
- ListImportFailuresRequestRequestTypeDef
- ListImportsRequestListImportsPaginateTypeDef
- ListImportsRequestRequestTypeDef
- ListPublicKeysRequestListPublicKeysPaginateTypeDef
- ListPublicKeysRequestRequestTypeDef
- PublicKeyTypeDef
- ListQueriesRequestRequestTypeDef
- QueryTypeDef
- ListTagsRequestListTagsPaginateTypeDef
- ListTagsRequestRequestTypeDef
- ListTrailsRequestListTrailsPaginateTypeDef
- ListTrailsRequestRequestTypeDef
- TrailInfoTypeDef
- LookupAttributeTypeDef
- PaginatorConfigTypeDef
- PutResourcePolicyRequestRequestTypeDef
- PutResourcePolicyResponseTypeDef
- RegisterOrganizationDelegatedAdminRequestRequestTypeDef
- ResponseMetadataTypeDef
- RestoreEventDataStoreRequestRequestTypeDef
- StartLoggingRequestRequestTypeDef
- StartQueryRequestRequestTypeDef
- StartQueryResponseTypeDef
- StopImportRequestRequestTypeDef
- StopLoggingRequestRequestTypeDef
- UpdateTrailRequestRequestTypeDef
- UpdateTrailResponseTypeDef
- AddTagsRequestRequestTypeDef
- CreateTrailRequestRequestTypeDef
- RemoveTagsRequestRequestTypeDef
- ResourceTagTypeDef
- AdvancedEventSelectorTypeDef
- ListChannelsResponseTypeDef
- CreateChannelRequestRequestTypeDef
- CreateChannelResponseTypeDef
- UpdateChannelRequestRequestTypeDef
- UpdateChannelResponseTypeDef
- EventSelectorTypeDef
- DescribeQueryResponseTypeDef
- DescribeTrailsResponseTypeDef
- GetTrailResponseTypeDef
- EventTypeDef
- GetInsightSelectorsResponseTypeDef
- PutInsightSelectorsRequestRequestTypeDef
- PutInsightSelectorsResponseTypeDef
- GetQueryResultsResponseTypeDef
- ListImportFailuresResponseTypeDef
- ImportSourceTypeDef
- ListImportsResponseTypeDef
- ListPublicKeysResponseTypeDef
- ListQueriesResponseTypeDef
- ListTrailsResponseTypeDef
- LookupEventsRequestLookupEventsPaginateTypeDef
- LookupEventsRequestRequestTypeDef
- ListTagsResponseTypeDef
- CreateEventDataStoreRequestRequestTypeDef
- CreateEventDataStoreResponseTypeDef
- EventDataStoreTypeDef
- GetEventDataStoreResponseTypeDef
- RestoreEventDataStoreResponseTypeDef
- SourceConfigTypeDef
- UpdateEventDataStoreRequestRequestTypeDef
- UpdateEventDataStoreResponseTypeDef
- GetEventSelectorsResponseTypeDef
- PutEventSelectorsRequestRequestTypeDef
- PutEventSelectorsResponseTypeDef
- LookupEventsResponseTypeDef
- GetImportResponseTypeDef
- StartImportRequestRequestTypeDef
- StartImportResponseTypeDef
- StopImportResponseTypeDef
- ListEventDataStoresResponseTypeDef
- GetChannelResponseTypeDef