Skip to content

CloudTrailClient

Index > CloudTrail > CloudTrailClient

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

CloudTrailClient

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

Usage example
from boto3.session import Session
from mypy_boto3_cloudtrail.client import CloudTrailClient

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

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("cloudtrail").exceptions structure.

Usage example
client = boto3.client("cloudtrail")

try:
    do_something(client)
except (
    client.AccountHasOngoingImportException,
    client.ChannelARNInvalidException,
    client.ChannelNotFoundException,
    client.ClientError,
    client.CloudTrailARNInvalidException,
    client.CloudTrailAccessNotEnabledException,
    client.CloudTrailInvalidClientTokenIdException,
    client.CloudWatchLogsDeliveryUnavailableException,
    client.ConflictException,
    client.EventDataStoreARNInvalidException,
    client.EventDataStoreAlreadyExistsException,
    client.EventDataStoreHasOngoingImportException,
    client.EventDataStoreMaxLimitExceededException,
    client.EventDataStoreNotFoundException,
    client.EventDataStoreTerminationProtectedException,
    client.ImportNotFoundException,
    client.InactiveEventDataStoreException,
    client.InactiveQueryException,
    client.InsightNotEnabledException,
    client.InsufficientDependencyServiceAccessPermissionException,
    client.InsufficientEncryptionPolicyException,
    client.InsufficientS3BucketPolicyException,
    client.InsufficientSnsTopicPolicyException,
    client.InvalidCloudWatchLogsLogGroupArnException,
    client.InvalidCloudWatchLogsRoleArnException,
    client.InvalidDateRangeException,
    client.InvalidEventCategoryException,
    client.InvalidEventDataStoreCategoryException,
    client.InvalidEventDataStoreStatusException,
    client.InvalidEventSelectorsException,
    client.InvalidHomeRegionException,
    client.InvalidImportSourceException,
    client.InvalidInsightSelectorsException,
    client.InvalidKmsKeyIdException,
    client.InvalidLookupAttributesException,
    client.InvalidMaxResultsException,
    client.InvalidNextTokenException,
    client.InvalidParameterCombinationException,
    client.InvalidParameterException,
    client.InvalidQueryStatementException,
    client.InvalidQueryStatusException,
    client.InvalidS3BucketNameException,
    client.InvalidS3PrefixException,
    client.InvalidSnsTopicNameException,
    client.InvalidTagParameterException,
    client.InvalidTimeRangeException,
    client.InvalidTokenException,
    client.InvalidTrailNameException,
    client.KmsException,
    client.KmsKeyDisabledException,
    client.KmsKeyNotFoundException,
    client.MaxConcurrentQueriesException,
    client.MaximumNumberOfTrailsExceededException,
    client.NotOrganizationMasterAccountException,
    client.OperationNotPermittedException,
    client.OrganizationNotInAllFeaturesModeException,
    client.OrganizationsNotInUseException,
    client.QueryIdNotFoundException,
    client.ResourceNotFoundException,
    client.ResourceTypeNotSupportedException,
    client.S3BucketDoesNotExistException,
    client.TagsLimitExceededException,
    client.TrailAlreadyExistsException,
    client.TrailNotFoundException,
    client.TrailNotProvidedException,
    client.UnsupportedOperationException,
) as e:
    print(e)
Type checking example
from mypy_boto3_cloudtrail.client import Exceptions

def handle_error(exc: Exceptions.AccountHasOngoingImportException) -> None:
    ...

Methods

add_tags

Adds one or more tags to a trail or event data store, up to a limit of 50.

Type annotations and code completion for boto3.client("cloudtrail").add_tags method. boto3 documentation

Method definition
def add_tags(
    self,
    *,
    ResourceId: str,
    TagsList: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: AddTagsRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "TagsList": ...,
}

parent.add_tags(**kwargs)
  1. See AddTagsRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("cloudtrail").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_query

Cancels a query if the query is not in a terminated state, such as CANCELLED , FAILED , TIMED_OUT , or FINISHED.

Type annotations and code completion for boto3.client("cloudtrail").cancel_query method. boto3 documentation

Method definition
def cancel_query(
    self,
    *,
    EventDataStore: str,
    QueryId: str,
) -> CancelQueryResponseTypeDef:  # (1)
    ...
  1. See CancelQueryResponseTypeDef
Usage example with kwargs
kwargs: CancelQueryRequestRequestTypeDef = {  # (1)
    "EventDataStore": ...,
    "QueryId": ...,
}

parent.cancel_query(**kwargs)
  1. See CancelQueryRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("cloudtrail").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

create_event_data_store

Creates a new event data store.

Type annotations and code completion for boto3.client("cloudtrail").create_event_data_store method. boto3 documentation

Method definition
def create_event_data_store(
    self,
    *,
    Name: str,
    AdvancedEventSelectors: Sequence[AdvancedEventSelectorTypeDef] = ...,  # (1)
    MultiRegionEnabled: bool = ...,
    OrganizationEnabled: bool = ...,
    RetentionPeriod: int = ...,
    TerminationProtectionEnabled: bool = ...,
    TagsList: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateEventDataStoreResponseTypeDef:  # (3)
    ...
  1. See AdvancedEventSelectorTypeDef
  2. See TagTypeDef
  3. See CreateEventDataStoreResponseTypeDef
Usage example with kwargs
kwargs: CreateEventDataStoreRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_event_data_store(**kwargs)
  1. See CreateEventDataStoreRequestRequestTypeDef

create_trail

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

Type annotations and code completion for boto3.client("cloudtrail").create_trail method. boto3 documentation

Method definition
def create_trail(
    self,
    *,
    Name: str,
    S3BucketName: str,
    S3KeyPrefix: str = ...,
    SnsTopicName: str = ...,
    IncludeGlobalServiceEvents: bool = ...,
    IsMultiRegionTrail: bool = ...,
    EnableLogFileValidation: bool = ...,
    CloudWatchLogsLogGroupArn: str = ...,
    CloudWatchLogsRoleArn: str = ...,
    KmsKeyId: str = ...,
    IsOrganizationTrail: bool = ...,
    TagsList: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateTrailResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateTrailResponseTypeDef
Usage example with kwargs
kwargs: CreateTrailRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "S3BucketName": ...,
}

parent.create_trail(**kwargs)
  1. See CreateTrailRequestRequestTypeDef

delete_event_data_store

Disables the event data store specified by EventDataStore , which accepts an event data store ARN.

Type annotations and code completion for boto3.client("cloudtrail").delete_event_data_store method. boto3 documentation

Method definition
def delete_event_data_store(
    self,
    *,
    EventDataStore: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteEventDataStoreRequestRequestTypeDef = {  # (1)
    "EventDataStore": ...,
}

parent.delete_event_data_store(**kwargs)
  1. See DeleteEventDataStoreRequestRequestTypeDef

delete_trail

Deletes a trail.

Type annotations and code completion for boto3.client("cloudtrail").delete_trail method. boto3 documentation

Method definition
def delete_trail(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteTrailRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_trail(**kwargs)
  1. See DeleteTrailRequestRequestTypeDef

describe_query

Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status.

Type annotations and code completion for boto3.client("cloudtrail").describe_query method. boto3 documentation

Method definition
def describe_query(
    self,
    *,
    EventDataStore: str,
    QueryId: str,
) -> DescribeQueryResponseTypeDef:  # (1)
    ...
  1. See DescribeQueryResponseTypeDef
Usage example with kwargs
kwargs: DescribeQueryRequestRequestTypeDef = {  # (1)
    "EventDataStore": ...,
    "QueryId": ...,
}

parent.describe_query(**kwargs)
  1. See DescribeQueryRequestRequestTypeDef

describe_trails

Retrieves settings for one or more trails associated with the current region for your account.

Type annotations and code completion for boto3.client("cloudtrail").describe_trails method. boto3 documentation

Method definition
def describe_trails(
    self,
    *,
    trailNameList: Sequence[str] = ...,
    includeShadowTrails: bool = ...,
) -> DescribeTrailsResponseTypeDef:  # (1)
    ...
  1. See DescribeTrailsResponseTypeDef
Usage example with kwargs
kwargs: DescribeTrailsRequestRequestTypeDef = {  # (1)
    "trailNameList": ...,
}

parent.describe_trails(**kwargs)
  1. See DescribeTrailsRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("cloudtrail").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_channel

Returns the specified CloudTrail service-linked channel.

Type annotations and code completion for boto3.client("cloudtrail").get_channel method. boto3 documentation

Method definition
def get_channel(
    self,
    *,
    Channel: str,
) -> GetChannelResponseTypeDef:  # (1)
    ...
  1. See GetChannelResponseTypeDef
Usage example with kwargs
kwargs: GetChannelRequestRequestTypeDef = {  # (1)
    "Channel": ...,
}

parent.get_channel(**kwargs)
  1. See GetChannelRequestRequestTypeDef

get_event_data_store

Returns information about an event data store specified as either an ARN or the ID portion of the ARN.

Type annotations and code completion for boto3.client("cloudtrail").get_event_data_store method. boto3 documentation

Method definition
def get_event_data_store(
    self,
    *,
    EventDataStore: str,
) -> GetEventDataStoreResponseTypeDef:  # (1)
    ...
  1. See GetEventDataStoreResponseTypeDef
Usage example with kwargs
kwargs: GetEventDataStoreRequestRequestTypeDef = {  # (1)
    "EventDataStore": ...,
}

parent.get_event_data_store(**kwargs)
  1. See GetEventDataStoreRequestRequestTypeDef

get_event_selectors

Describes the settings for the event selectors that you configured for your trail.

Type annotations and code completion for boto3.client("cloudtrail").get_event_selectors method. boto3 documentation

Method definition
def get_event_selectors(
    self,
    *,
    TrailName: str,
) -> GetEventSelectorsResponseTypeDef:  # (1)
    ...
  1. See GetEventSelectorsResponseTypeDef
Usage example with kwargs
kwargs: GetEventSelectorsRequestRequestTypeDef = {  # (1)
    "TrailName": ...,
}

parent.get_event_selectors(**kwargs)
  1. See GetEventSelectorsRequestRequestTypeDef

get_import

Returns information for the specified import.

Type annotations and code completion for boto3.client("cloudtrail").get_import method. boto3 documentation

Method definition
def get_import(
    self,
    *,
    ImportId: str,
) -> GetImportResponseTypeDef:  # (1)
    ...
  1. See GetImportResponseTypeDef
Usage example with kwargs
kwargs: GetImportRequestRequestTypeDef = {  # (1)
    "ImportId": ...,
}

parent.get_import(**kwargs)
  1. See GetImportRequestRequestTypeDef

get_insight_selectors

Describes the settings for the Insights event selectors that you configured for your trail.

Type annotations and code completion for boto3.client("cloudtrail").get_insight_selectors method. boto3 documentation

Method definition
def get_insight_selectors(
    self,
    *,
    TrailName: str,
) -> GetInsightSelectorsResponseTypeDef:  # (1)
    ...
  1. See GetInsightSelectorsResponseTypeDef
Usage example with kwargs
kwargs: GetInsightSelectorsRequestRequestTypeDef = {  # (1)
    "TrailName": ...,
}

parent.get_insight_selectors(**kwargs)
  1. See GetInsightSelectorsRequestRequestTypeDef

get_query_results

Gets event data results of a query.

Type annotations and code completion for boto3.client("cloudtrail").get_query_results method. boto3 documentation

Method definition
def get_query_results(
    self,
    *,
    EventDataStore: str,
    QueryId: str,
    NextToken: str = ...,
    MaxQueryResults: int = ...,
) -> GetQueryResultsResponseTypeDef:  # (1)
    ...
  1. See GetQueryResultsResponseTypeDef
Usage example with kwargs
kwargs: GetQueryResultsRequestRequestTypeDef = {  # (1)
    "EventDataStore": ...,
    "QueryId": ...,
}

parent.get_query_results(**kwargs)
  1. See GetQueryResultsRequestRequestTypeDef

get_trail

Returns settings information for a specified trail.

Type annotations and code completion for boto3.client("cloudtrail").get_trail method. boto3 documentation

Method definition
def get_trail(
    self,
    *,
    Name: str,
) -> GetTrailResponseTypeDef:  # (1)
    ...
  1. See GetTrailResponseTypeDef
Usage example with kwargs
kwargs: GetTrailRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.get_trail(**kwargs)
  1. See GetTrailRequestRequestTypeDef

get_trail_status

Returns a JSON-formatted list of information about the specified trail.

Type annotations and code completion for boto3.client("cloudtrail").get_trail_status method. boto3 documentation

Method definition
def get_trail_status(
    self,
    *,
    Name: str,
) -> GetTrailStatusResponseTypeDef:  # (1)
    ...
  1. See GetTrailStatusResponseTypeDef
Usage example with kwargs
kwargs: GetTrailStatusRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.get_trail_status(**kwargs)
  1. See GetTrailStatusRequestRequestTypeDef

list_channels

Returns all CloudTrail channels.

Type annotations and code completion for boto3.client("cloudtrail").list_channels method. boto3 documentation

Method definition
def list_channels(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListChannelsResponseTypeDef:  # (1)
    ...
  1. See ListChannelsResponseTypeDef
Usage example with kwargs
kwargs: ListChannelsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_channels(**kwargs)
  1. See ListChannelsRequestRequestTypeDef

list_event_data_stores

Returns information about all event data stores in the account, in the current region.

Type annotations and code completion for boto3.client("cloudtrail").list_event_data_stores method. boto3 documentation

Method definition
def list_event_data_stores(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEventDataStoresResponseTypeDef:  # (1)
    ...
  1. See ListEventDataStoresResponseTypeDef
Usage example with kwargs
kwargs: ListEventDataStoresRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_event_data_stores(**kwargs)
  1. See ListEventDataStoresRequestRequestTypeDef

list_import_failures

Returns a list of failures for the specified import.

Type annotations and code completion for boto3.client("cloudtrail").list_import_failures method. boto3 documentation

Method definition
def list_import_failures(
    self,
    *,
    ImportId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListImportFailuresResponseTypeDef:  # (1)
    ...
  1. See ListImportFailuresResponseTypeDef
Usage example with kwargs
kwargs: ListImportFailuresRequestRequestTypeDef = {  # (1)
    "ImportId": ...,
}

parent.list_import_failures(**kwargs)
  1. See ListImportFailuresRequestRequestTypeDef

list_imports

Returns information on all imports, or a select set of imports by ImportStatus or Destination .

Type annotations and code completion for boto3.client("cloudtrail").list_imports method. boto3 documentation

Method definition
def list_imports(
    self,
    *,
    MaxResults: int = ...,
    Destination: str = ...,
    ImportStatus: ImportStatusType = ...,  # (1)
    NextToken: str = ...,
) -> ListImportsResponseTypeDef:  # (2)
    ...
  1. See ImportStatusType
  2. See ListImportsResponseTypeDef
Usage example with kwargs
kwargs: ListImportsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_imports(**kwargs)
  1. See ListImportsRequestRequestTypeDef

list_public_keys

Returns all public keys whose private keys were used to sign the digest files within the specified time range.

Type annotations and code completion for boto3.client("cloudtrail").list_public_keys method. boto3 documentation

Method definition
def list_public_keys(
    self,
    *,
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    NextToken: str = ...,
) -> ListPublicKeysResponseTypeDef:  # (1)
    ...
  1. See ListPublicKeysResponseTypeDef
Usage example with kwargs
kwargs: ListPublicKeysRequestRequestTypeDef = {  # (1)
    "StartTime": ...,
}

parent.list_public_keys(**kwargs)
  1. See ListPublicKeysRequestRequestTypeDef

list_queries

Returns a list of queries and query statuses for the past seven days.

Type annotations and code completion for boto3.client("cloudtrail").list_queries method. boto3 documentation

Method definition
def list_queries(
    self,
    *,
    EventDataStore: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    QueryStatus: QueryStatusType = ...,  # (1)
) -> ListQueriesResponseTypeDef:  # (2)
    ...
  1. See QueryStatusType
  2. See ListQueriesResponseTypeDef
Usage example with kwargs
kwargs: ListQueriesRequestRequestTypeDef = {  # (1)
    "EventDataStore": ...,
}

parent.list_queries(**kwargs)
  1. See ListQueriesRequestRequestTypeDef

list_tags

Lists the tags for the trail or event data store in the current region.

Type annotations and code completion for boto3.client("cloudtrail").list_tags method. boto3 documentation

Method definition
def list_tags(
    self,
    *,
    ResourceIdList: Sequence[str],
    NextToken: str = ...,
) -> ListTagsResponseTypeDef:  # (1)
    ...
  1. See ListTagsResponseTypeDef
Usage example with kwargs
kwargs: ListTagsRequestRequestTypeDef = {  # (1)
    "ResourceIdList": ...,
}

parent.list_tags(**kwargs)
  1. See ListTagsRequestRequestTypeDef

list_trails

Lists trails that are in the current account.

Type annotations and code completion for boto3.client("cloudtrail").list_trails method. boto3 documentation

Method definition
def list_trails(
    self,
    *,
    NextToken: str = ...,
) -> ListTrailsResponseTypeDef:  # (1)
    ...
  1. See ListTrailsResponseTypeDef
Usage example with kwargs
kwargs: ListTrailsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_trails(**kwargs)
  1. See ListTrailsRequestRequestTypeDef

lookup_events

Looks up management events_ or CloudTrail Insights events <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail- concepts.html#cloudtrail-concepts-insigh....

Type annotations and code completion for boto3.client("cloudtrail").lookup_events method. boto3 documentation

Method definition
def lookup_events(
    self,
    *,
    LookupAttributes: Sequence[LookupAttributeTypeDef] = ...,  # (1)
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    EventCategory: EventCategoryType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> LookupEventsResponseTypeDef:  # (3)
    ...
  1. See LookupAttributeTypeDef
  2. See EventCategoryType
  3. See LookupEventsResponseTypeDef
Usage example with kwargs
kwargs: LookupEventsRequestRequestTypeDef = {  # (1)
    "LookupAttributes": ...,
}

parent.lookup_events(**kwargs)
  1. See LookupEventsRequestRequestTypeDef

put_event_selectors

Configures an event selector or advanced event selectors for your trail.

Type annotations and code completion for boto3.client("cloudtrail").put_event_selectors method. boto3 documentation

Method definition
def put_event_selectors(
    self,
    *,
    TrailName: str,
    EventSelectors: Sequence[EventSelectorTypeDef] = ...,  # (1)
    AdvancedEventSelectors: Sequence[AdvancedEventSelectorTypeDef] = ...,  # (2)
) -> PutEventSelectorsResponseTypeDef:  # (3)
    ...
  1. See EventSelectorTypeDef
  2. See AdvancedEventSelectorTypeDef
  3. See PutEventSelectorsResponseTypeDef
Usage example with kwargs
kwargs: PutEventSelectorsRequestRequestTypeDef = {  # (1)
    "TrailName": ...,
}

parent.put_event_selectors(**kwargs)
  1. See PutEventSelectorsRequestRequestTypeDef

put_insight_selectors

Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.

Type annotations and code completion for boto3.client("cloudtrail").put_insight_selectors method. boto3 documentation

Method definition
def put_insight_selectors(
    self,
    *,
    TrailName: str,
    InsightSelectors: Sequence[InsightSelectorTypeDef],  # (1)
) -> PutInsightSelectorsResponseTypeDef:  # (2)
    ...
  1. See InsightSelectorTypeDef
  2. See PutInsightSelectorsResponseTypeDef
Usage example with kwargs
kwargs: PutInsightSelectorsRequestRequestTypeDef = {  # (1)
    "TrailName": ...,
    "InsightSelectors": ...,
}

parent.put_insight_selectors(**kwargs)
  1. See PutInsightSelectorsRequestRequestTypeDef

remove_tags

Removes the specified tags from a trail or event data store.

Type annotations and code completion for boto3.client("cloudtrail").remove_tags method. boto3 documentation

Method definition
def remove_tags(
    self,
    *,
    ResourceId: str,
    TagsList: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: RemoveTagsRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "TagsList": ...,
}

parent.remove_tags(**kwargs)
  1. See RemoveTagsRequestRequestTypeDef

restore_event_data_store

Restores a deleted event data store specified by EventDataStore , which accepts an event data store ARN.

Type annotations and code completion for boto3.client("cloudtrail").restore_event_data_store method. boto3 documentation

Method definition
def restore_event_data_store(
    self,
    *,
    EventDataStore: str,
) -> RestoreEventDataStoreResponseTypeDef:  # (1)
    ...
  1. See RestoreEventDataStoreResponseTypeDef
Usage example with kwargs
kwargs: RestoreEventDataStoreRequestRequestTypeDef = {  # (1)
    "EventDataStore": ...,
}

parent.restore_event_data_store(**kwargs)
  1. See RestoreEventDataStoreRequestRequestTypeDef

start_import

Starts an import of logged trail events from a source S3 bucket to a destination event data store.

Type annotations and code completion for boto3.client("cloudtrail").start_import method. boto3 documentation

Method definition
def start_import(
    self,
    *,
    Destinations: Sequence[str] = ...,
    ImportSource: ImportSourceTypeDef = ...,  # (1)
    StartEventTime: Union[datetime, str] = ...,
    EndEventTime: Union[datetime, str] = ...,
    ImportId: str = ...,
) -> StartImportResponseTypeDef:  # (2)
    ...
  1. See ImportSourceTypeDef
  2. See StartImportResponseTypeDef
Usage example with kwargs
kwargs: StartImportRequestRequestTypeDef = {  # (1)
    "Destinations": ...,
}

parent.start_import(**kwargs)
  1. See StartImportRequestRequestTypeDef

start_logging

Starts the recording of Amazon Web Services API calls and log file delivery for a trail.

Type annotations and code completion for boto3.client("cloudtrail").start_logging method. boto3 documentation

Method definition
def start_logging(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: StartLoggingRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.start_logging(**kwargs)
  1. See StartLoggingRequestRequestTypeDef

start_query

Starts a CloudTrail Lake query.

Type annotations and code completion for boto3.client("cloudtrail").start_query method. boto3 documentation

Method definition
def start_query(
    self,
    *,
    QueryStatement: str,
) -> StartQueryResponseTypeDef:  # (1)
    ...
  1. See StartQueryResponseTypeDef
Usage example with kwargs
kwargs: StartQueryRequestRequestTypeDef = {  # (1)
    "QueryStatement": ...,
}

parent.start_query(**kwargs)
  1. See StartQueryRequestRequestTypeDef

stop_import

Stops a specified import.

Type annotations and code completion for boto3.client("cloudtrail").stop_import method. boto3 documentation

Method definition
def stop_import(
    self,
    *,
    ImportId: str,
) -> StopImportResponseTypeDef:  # (1)
    ...
  1. See StopImportResponseTypeDef
Usage example with kwargs
kwargs: StopImportRequestRequestTypeDef = {  # (1)
    "ImportId": ...,
}

parent.stop_import(**kwargs)
  1. See StopImportRequestRequestTypeDef

stop_logging

Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail.

Type annotations and code completion for boto3.client("cloudtrail").stop_logging method. boto3 documentation

Method definition
def stop_logging(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: StopLoggingRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.stop_logging(**kwargs)
  1. See StopLoggingRequestRequestTypeDef

update_event_data_store

Updates an event data store.

Type annotations and code completion for boto3.client("cloudtrail").update_event_data_store method. boto3 documentation

Method definition
def update_event_data_store(
    self,
    *,
    EventDataStore: str,
    Name: str = ...,
    AdvancedEventSelectors: Sequence[AdvancedEventSelectorTypeDef] = ...,  # (1)
    MultiRegionEnabled: bool = ...,
    OrganizationEnabled: bool = ...,
    RetentionPeriod: int = ...,
    TerminationProtectionEnabled: bool = ...,
) -> UpdateEventDataStoreResponseTypeDef:  # (2)
    ...
  1. See AdvancedEventSelectorTypeDef
  2. See UpdateEventDataStoreResponseTypeDef
Usage example with kwargs
kwargs: UpdateEventDataStoreRequestRequestTypeDef = {  # (1)
    "EventDataStore": ...,
}

parent.update_event_data_store(**kwargs)
  1. See UpdateEventDataStoreRequestRequestTypeDef

update_trail

Updates trail settings that control what events you are logging, and how to handle log files.

Type annotations and code completion for boto3.client("cloudtrail").update_trail method. boto3 documentation

Method definition
def update_trail(
    self,
    *,
    Name: str,
    S3BucketName: str = ...,
    S3KeyPrefix: str = ...,
    SnsTopicName: str = ...,
    IncludeGlobalServiceEvents: bool = ...,
    IsMultiRegionTrail: bool = ...,
    EnableLogFileValidation: bool = ...,
    CloudWatchLogsLogGroupArn: str = ...,
    CloudWatchLogsRoleArn: str = ...,
    KmsKeyId: str = ...,
    IsOrganizationTrail: bool = ...,
) -> UpdateTrailResponseTypeDef:  # (1)
    ...
  1. See UpdateTrailResponseTypeDef
Usage example with kwargs
kwargs: UpdateTrailRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.update_trail(**kwargs)
  1. See UpdateTrailRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("cloudtrail").get_paginator method with overloads.