CloudTrail module#
Index > CloudTrail
Auto-generated documentation for CloudTrail type annotations stubs module types-aiobotocore-cloudtrail.
How to install#
Generate locally (recommended)#
You can generate type annotations for aiobotocore
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'aiobotocore==2.23.0' mypy-boto3-builder
- Select
aiobotocore
AWS SDK. - Add
CloudTrail
service. - Use provided commands to install generated packages.
From PyPI with pip#
Install types-aiobotocore
for CloudTrail
service.
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[cloudtrail]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[cloudtrail]'
# standalone installation
python -m pip install types-aiobotocore-cloudtrail
How to uninstall#
python -m pip uninstall -y types-aiobotocore-cloudtrail
Usage#
Code samples can be found in Examples.
CloudTrailClient#
Type annotations and code completion for session.create_client("cloudtrail")
as CloudTrailClient
boto3 documentation
# CloudTrailClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_cloudtrail.client import CloudTrailClient
session = get_session()
async with session.create_client("cloudtrail") as client:
client: CloudTrailClient
Paginators#
Type annotations and code completion for
paginators
from session.create_client("cloudtrail").get_paginator("...")
.
# ListImportFailuresPaginator usage example
from types_aiobotocore_cloudtrail.paginator import ListImportFailuresPaginator
def get_list_import_failures_paginator() -> ListImportFailuresPaginator:
return client.get_paginator("list_import_failures"))
- ListImportFailuresPaginator
- ListImportsPaginator
- ListPublicKeysPaginator
- ListTagsPaginator
- ListTrailsPaginator
- LookupEventsPaginator
Literals#
Type annotations for literals used in methods and schema.
# BillingModeType usage example
from types_aiobotocore_cloudtrail.literals import BillingModeType
def get_value() -> BillingModeType:
return "EXTENDABLE_RETENTION_PRICING"
- BillingModeType
- DashboardStatusType
- DashboardTypeType
- DeliveryStatusType
- DestinationTypeType
- EventCategoryType
- EventDataStoreStatusType
- FederationStatusType
- ImportFailureStatusType
- ImportStatusType
- InsightTypeType
- InsightsMetricDataTypeType
- ListImportFailuresPaginatorName
- ListImportsPaginatorName
- ListPublicKeysPaginatorName
- ListTagsPaginatorName
- ListTrailsPaginatorName
- LookupAttributeKeyType
- LookupEventsPaginatorName
- MaxEventSizeType
- QueryStatusType
- ReadWriteTypeType
- RefreshScheduleFrequencyUnitType
- RefreshScheduleStatusType
- TypeType
- CloudTrailServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- TagTypeDef
- AdvancedFieldSelectorOutputTypeDef
- AdvancedFieldSelectorTypeDef
- CancelQueryRequestTypeDef
- ResponseMetadataTypeDef
- ChannelTypeDef
- ContextKeySelectorOutputTypeDef
- ContextKeySelectorTypeDef
- DestinationTypeDef
- RequestWidgetTypeDef
- WidgetTypeDef
- DashboardDetailTypeDef
- DataResourceOutputTypeDef
- DataResourceTypeDef
- DeleteChannelRequestTypeDef
- DeleteDashboardRequestTypeDef
- DeleteEventDataStoreRequestTypeDef
- DeleteResourcePolicyRequestTypeDef
- DeleteTrailRequestTypeDef
- DeregisterOrganizationDelegatedAdminRequestTypeDef
- DescribeQueryRequestTypeDef
- QueryStatisticsForDescribeQueryTypeDef
- DescribeTrailsRequestTypeDef
- TrailTypeDef
- DisableFederationRequestTypeDef
- EnableFederationRequestTypeDef
- ResourceTypeDef
- GenerateQueryRequestTypeDef
- GetChannelRequestTypeDef
- IngestionStatusTypeDef
- GetDashboardRequestTypeDef
- GetEventConfigurationRequestTypeDef
- GetEventDataStoreRequestTypeDef
- PartitionKeyTypeDef
- GetEventSelectorsRequestTypeDef
- GetImportRequestTypeDef
- ImportStatisticsTypeDef
- GetInsightSelectorsRequestTypeDef
- InsightSelectorTypeDef
- GetQueryResultsRequestTypeDef
- QueryStatisticsTypeDef
- GetResourcePolicyRequestTypeDef
- GetTrailRequestTypeDef
- GetTrailStatusRequestTypeDef
- ImportFailureListItemTypeDef
- S3ImportSourceTypeDef
- ImportsListItemTypeDef
- ListChannelsRequestTypeDef
- ListDashboardsRequestTypeDef
- ListEventDataStoresRequestTypeDef
- PaginatorConfigTypeDef
- ListImportFailuresRequestTypeDef
- ListImportsRequestTypeDef
- TimestampTypeDef
- PublicKeyTypeDef
- QueryTypeDef
- ListTagsRequestTypeDef
- ListTrailsRequestTypeDef
- TrailInfoTypeDef
- LookupAttributeTypeDef
- PutResourcePolicyRequestTypeDef
- RefreshScheduleFrequencyTypeDef
- RegisterOrganizationDelegatedAdminRequestTypeDef
- RestoreEventDataStoreRequestTypeDef
- SearchSampleQueriesRequestTypeDef
- SearchSampleQueriesSearchResultTypeDef
- StartDashboardRefreshRequestTypeDef
- StartEventDataStoreIngestionRequestTypeDef
- StartLoggingRequestTypeDef
- StartQueryRequestTypeDef
- StopEventDataStoreIngestionRequestTypeDef
- StopImportRequestTypeDef
- StopLoggingRequestTypeDef
- UpdateTrailRequestTypeDef
- AddTagsRequestTypeDef
- CreateTrailRequestTypeDef
- RemoveTagsRequestTypeDef
- ResourceTagTypeDef
- AdvancedEventSelectorOutputTypeDef
- AdvancedFieldSelectorUnionTypeDef
- CancelQueryResponseTypeDef
- CreateTrailResponseTypeDef
- DisableFederationResponseTypeDef
- EnableFederationResponseTypeDef
- GenerateQueryResponseTypeDef
- GetResourcePolicyResponseTypeDef
- GetTrailStatusResponseTypeDef
- ListInsightsMetricDataResponseTypeDef
- PutResourcePolicyResponseTypeDef
- StartDashboardRefreshResponseTypeDef
- StartQueryResponseTypeDef
- UpdateTrailResponseTypeDef
- ListChannelsResponseTypeDef
- GetEventConfigurationResponseTypeDef
- PutEventConfigurationResponseTypeDef
- ContextKeySelectorUnionTypeDef
- CreateChannelRequestTypeDef
- CreateChannelResponseTypeDef
- UpdateChannelRequestTypeDef
- UpdateChannelResponseTypeDef
- ListDashboardsResponseTypeDef
- EventSelectorOutputTypeDef
- DataResourceUnionTypeDef
- DescribeQueryResponseTypeDef
- DescribeTrailsResponseTypeDef
- GetTrailResponseTypeDef
- EventTypeDef
- GetInsightSelectorsResponseTypeDef
- PutInsightSelectorsRequestTypeDef
- PutInsightSelectorsResponseTypeDef
- GetQueryResultsResponseTypeDef
- ListImportFailuresResponseTypeDef
- ImportSourceTypeDef
- ListImportsResponseTypeDef
- ListImportFailuresRequestPaginateTypeDef
- ListImportsRequestPaginateTypeDef
- ListTagsRequestPaginateTypeDef
- ListTrailsRequestPaginateTypeDef
- ListInsightsMetricDataRequestTypeDef
- ListPublicKeysRequestPaginateTypeDef
- ListPublicKeysRequestTypeDef
- ListQueriesRequestTypeDef
- ListPublicKeysResponseTypeDef
- ListQueriesResponseTypeDef
- ListTrailsResponseTypeDef
- LookupEventsRequestPaginateTypeDef
- LookupEventsRequestTypeDef
- RefreshScheduleTypeDef
- SearchSampleQueriesResponseTypeDef
- ListTagsResponseTypeDef
- CreateEventDataStoreResponseTypeDef
- EventDataStoreTypeDef
- GetEventDataStoreResponseTypeDef
- RestoreEventDataStoreResponseTypeDef
- SourceConfigTypeDef
- UpdateEventDataStoreResponseTypeDef
- AdvancedEventSelectorTypeDef
- PutEventConfigurationRequestTypeDef
- GetEventSelectorsResponseTypeDef
- PutEventSelectorsResponseTypeDef
- EventSelectorTypeDef
- LookupEventsResponseTypeDef
- GetImportResponseTypeDef
- StartImportRequestTypeDef
- StartImportResponseTypeDef
- StopImportResponseTypeDef
- CreateDashboardRequestTypeDef
- CreateDashboardResponseTypeDef
- GetDashboardResponseTypeDef
- UpdateDashboardRequestTypeDef
- UpdateDashboardResponseTypeDef
- ListEventDataStoresResponseTypeDef
- GetChannelResponseTypeDef
- AdvancedEventSelectorUnionTypeDef
- EventSelectorUnionTypeDef
- CreateEventDataStoreRequestTypeDef
- UpdateEventDataStoreRequestTypeDef
- PutEventSelectorsRequestTypeDef