CloudTrailClient#
Index > CloudTrail > CloudTrailClient
Auto-generated documentation for CloudTrail type annotations stubs module types-aiobotocore-cloudtrail.
CloudTrailClient#
Type annotations and code completion for session.create_client("cloudtrail")
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: CloudTrailClientExceptions#
aiobotocore client exceptions are generated in runtime.
This class provides code completion for session.create_client("cloudtrail").exceptions structure.
CloudTrailClient.exceptions usage example
async with session.create_client("cloudtrail") as client:
try:
do_something(client)
except (
client.AccountHasOngoingImportException,
client.AccountNotFoundException,
client.AccountNotRegisteredException,
client.AccountRegisteredException,
client.CannotDelegateManagementAccountException,
client.ChannelARNInvalidException,
client.ChannelAlreadyExistsException,
client.ChannelExistsForEDSException,
client.ChannelMaxLimitExceededException,
client.ChannelNotFoundException,
client.ClientError,
client.CloudTrailARNInvalidException,
client.CloudTrailAccessNotEnabledException,
client.CloudTrailInvalidClientTokenIdException,
client.CloudWatchLogsDeliveryUnavailableException,
client.ConflictException,
client.DelegatedAdminAccountLimitExceededException,
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.InvalidSourceException,
client.InvalidTagParameterException,
client.InvalidTimeRangeException,
client.InvalidTokenException,
client.InvalidTrailNameException,
client.KmsException,
client.KmsKeyDisabledException,
client.KmsKeyNotFoundException,
client.MaxConcurrentQueriesException,
client.MaximumNumberOfTrailsExceededException,
client.NoManagementAccountSLRExistsException,
client.NotOrganizationManagementAccountException,
client.NotOrganizationMasterAccountException,
client.OperationNotPermittedException,
client.OrganizationNotInAllFeaturesModeException,
client.OrganizationsNotInUseException,
client.QueryIdNotFoundException,
client.ResourceARNNotValidException,
client.ResourceNotFoundException,
client.ResourcePolicyNotFoundException,
client.ResourcePolicyNotValidException,
client.ResourceTypeNotSupportedException,
client.S3BucketDoesNotExistException,
client.TagsLimitExceededException,
client.TrailAlreadyExistsException,
client.TrailNotFoundException,
client.TrailNotProvidedException,
client.UnsupportedOperationException,
) as e:
print(e)CloudTrailClient usage type checking example
from types_aiobotocore_cloudtrail.client import Exceptions
def handle_error(exc: Exceptions.AccountHasOngoingImportException) -> None:
...Methods#
add_tags#
Adds one or more tags to a trail, event data store, or channel, up to a limit of 50.
Type annotations and code completion for session.create_client("cloudtrail").add_tags method.
boto3 documentation
# add_tags method definition
await def add_tags(
self,
*,
ResourceId: str,
TagsList: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...- See TagTypeDef
# add_tags method usage example with argument unpacking
kwargs: AddTagsRequestRequestTypeDef = { # (1)
"ResourceId": ...,
"TagsList": ...,
}
parent.add_tags(**kwargs)can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.create_client("cloudtrail").can_paginate method.
boto3 documentation
# can_paginate 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 session.create_client("cloudtrail").cancel_query method.
boto3 documentation
# cancel_query method definition
await def cancel_query(
self,
*,
QueryId: str,
EventDataStore: str = ...,
) -> CancelQueryResponseTypeDef: # (1)
...# cancel_query method usage example with argument unpacking
kwargs: CancelQueryRequestRequestTypeDef = { # (1)
"QueryId": ...,
}
parent.cancel_query(**kwargs)close#
Closes underlying endpoint connections.
Type annotations and code completion for session.create_client("cloudtrail").close method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...create_channel#
Creates a channel for CloudTrail to ingest events from a partner or external source.
Type annotations and code completion for session.create_client("cloudtrail").create_channel method.
boto3 documentation
# create_channel method definition
await def create_channel(
self,
*,
Name: str,
Source: str,
Destinations: Sequence[DestinationTypeDef], # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateChannelResponseTypeDef: # (3)
...- See DestinationTypeDef
- See TagTypeDef
- See CreateChannelResponseTypeDef
# create_channel method usage example with argument unpacking
kwargs: CreateChannelRequestRequestTypeDef = { # (1)
"Name": ...,
"Source": ...,
"Destinations": ...,
}
parent.create_channel(**kwargs)create_event_data_store#
Creates a new event data store.
Type annotations and code completion for session.create_client("cloudtrail").create_event_data_store method.
boto3 documentation
# create_event_data_store method definition
await def create_event_data_store(
self,
*,
Name: str,
AdvancedEventSelectors: Sequence[AdvancedEventSelectorTypeDef] = ..., # (1)
MultiRegionEnabled: bool = ...,
OrganizationEnabled: bool = ...,
RetentionPeriod: int = ...,
TerminationProtectionEnabled: bool = ...,
TagsList: Sequence[TagTypeDef] = ..., # (2)
KmsKeyId: str = ...,
StartIngestion: bool = ...,
) -> CreateEventDataStoreResponseTypeDef: # (3)
...# create_event_data_store method usage example with argument unpacking
kwargs: CreateEventDataStoreRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_event_data_store(**kwargs)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 session.create_client("cloudtrail").create_trail method.
boto3 documentation
# create_trail method definition
await 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)
...- See TagTypeDef
- See CreateTrailResponseTypeDef
# create_trail method usage example with argument unpacking
kwargs: CreateTrailRequestRequestTypeDef = { # (1)
"Name": ...,
"S3BucketName": ...,
}
parent.create_trail(**kwargs)delete_channel#
Deletes a channel.
Type annotations and code completion for session.create_client("cloudtrail").delete_channel method.
boto3 documentation
# delete_channel method definition
await def delete_channel(
self,
*,
Channel: str,
) -> Dict[str, Any]:
...# delete_channel method usage example with argument unpacking
kwargs: DeleteChannelRequestRequestTypeDef = { # (1)
"Channel": ...,
}
parent.delete_channel(**kwargs)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 session.create_client("cloudtrail").delete_event_data_store method.
boto3 documentation
# delete_event_data_store method definition
await def delete_event_data_store(
self,
*,
EventDataStore: str,
) -> Dict[str, Any]:
...# delete_event_data_store method usage example with argument unpacking
kwargs: DeleteEventDataStoreRequestRequestTypeDef = { # (1)
"EventDataStore": ...,
}
parent.delete_event_data_store(**kwargs)delete_resource_policy#
Deletes the resource-based policy attached to the CloudTrail channel.
Type annotations and code completion for session.create_client("cloudtrail").delete_resource_policy method.
boto3 documentation
# delete_resource_policy method definition
await def delete_resource_policy(
self,
*,
ResourceArn: str,
) -> Dict[str, Any]:
...# delete_resource_policy method usage example with argument unpacking
kwargs: DeleteResourcePolicyRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.delete_resource_policy(**kwargs)delete_trail#
Deletes a trail.
Type annotations and code completion for session.create_client("cloudtrail").delete_trail method.
boto3 documentation
# delete_trail method definition
await def delete_trail(
self,
*,
Name: str,
) -> Dict[str, Any]:
...# delete_trail method usage example with argument unpacking
kwargs: DeleteTrailRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_trail(**kwargs)deregister_organization_delegated_admin#
Removes CloudTrail delegated administrator permissions from a member account in an organization.
Type annotations and code completion for session.create_client("cloudtrail").deregister_organization_delegated_admin method.
boto3 documentation
# deregister_organization_delegated_admin method definition
await def deregister_organization_delegated_admin(
self,
*,
DelegatedAdminAccountId: str,
) -> Dict[str, Any]:
...# deregister_organization_delegated_admin method usage example with argument unpacking
kwargs: DeregisterOrganizationDelegatedAdminRequestRequestTypeDef = { # (1)
"DelegatedAdminAccountId": ...,
}
parent.deregister_organization_delegated_admin(**kwargs)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 session.create_client("cloudtrail").describe_query method.
boto3 documentation
# describe_query method definition
await def describe_query(
self,
*,
EventDataStore: str = ...,
QueryId: str = ...,
QueryAlias: str = ...,
) -> DescribeQueryResponseTypeDef: # (1)
...# describe_query method usage example with argument unpacking
kwargs: DescribeQueryRequestRequestTypeDef = { # (1)
"EventDataStore": ...,
}
parent.describe_query(**kwargs)describe_trails#
Retrieves settings for one or more trails associated with the current Region for your account.
Type annotations and code completion for session.create_client("cloudtrail").describe_trails method.
boto3 documentation
# describe_trails method definition
await def describe_trails(
self,
*,
trailNameList: Sequence[str] = ...,
includeShadowTrails: bool = ...,
) -> DescribeTrailsResponseTypeDef: # (1)
...# describe_trails method usage example with argument unpacking
kwargs: DescribeTrailsRequestRequestTypeDef = { # (1)
"trailNameList": ...,
}
parent.describe_trails(**kwargs)generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("cloudtrail").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...get_channel#
Returns information about a specific channel.
Type annotations and code completion for session.create_client("cloudtrail").get_channel method.
boto3 documentation
# get_channel method definition
await def get_channel(
self,
*,
Channel: str,
) -> GetChannelResponseTypeDef: # (1)
...# get_channel method usage example with argument unpacking
kwargs: GetChannelRequestRequestTypeDef = { # (1)
"Channel": ...,
}
parent.get_channel(**kwargs)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 session.create_client("cloudtrail").get_event_data_store method.
boto3 documentation
# get_event_data_store method definition
await def get_event_data_store(
self,
*,
EventDataStore: str,
) -> GetEventDataStoreResponseTypeDef: # (1)
...# get_event_data_store method usage example with argument unpacking
kwargs: GetEventDataStoreRequestRequestTypeDef = { # (1)
"EventDataStore": ...,
}
parent.get_event_data_store(**kwargs)get_event_selectors#
Describes the settings for the event selectors that you configured for your trail.
Type annotations and code completion for session.create_client("cloudtrail").get_event_selectors method.
boto3 documentation
# get_event_selectors method definition
await def get_event_selectors(
self,
*,
TrailName: str,
) -> GetEventSelectorsResponseTypeDef: # (1)
...# get_event_selectors method usage example with argument unpacking
kwargs: GetEventSelectorsRequestRequestTypeDef = { # (1)
"TrailName": ...,
}
parent.get_event_selectors(**kwargs)get_import#
Returns information about a specific import.
Type annotations and code completion for session.create_client("cloudtrail").get_import method.
boto3 documentation
# get_import method definition
await def get_import(
self,
*,
ImportId: str,
) -> GetImportResponseTypeDef: # (1)
...# get_import method usage example with argument unpacking
kwargs: GetImportRequestRequestTypeDef = { # (1)
"ImportId": ...,
}
parent.get_import(**kwargs)get_insight_selectors#
Describes the settings for the Insights event selectors that you configured for your trail.
Type annotations and code completion for session.create_client("cloudtrail").get_insight_selectors method.
boto3 documentation
# get_insight_selectors method definition
await def get_insight_selectors(
self,
*,
TrailName: str,
) -> GetInsightSelectorsResponseTypeDef: # (1)
...# get_insight_selectors method usage example with argument unpacking
kwargs: GetInsightSelectorsRequestRequestTypeDef = { # (1)
"TrailName": ...,
}
parent.get_insight_selectors(**kwargs)get_query_results#
Gets event data results of a query.
Type annotations and code completion for session.create_client("cloudtrail").get_query_results method.
boto3 documentation
# get_query_results method definition
await def get_query_results(
self,
*,
QueryId: str,
EventDataStore: str = ...,
NextToken: str = ...,
MaxQueryResults: int = ...,
) -> GetQueryResultsResponseTypeDef: # (1)
...# get_query_results method usage example with argument unpacking
kwargs: GetQueryResultsRequestRequestTypeDef = { # (1)
"QueryId": ...,
}
parent.get_query_results(**kwargs)get_resource_policy#
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
Type annotations and code completion for session.create_client("cloudtrail").get_resource_policy method.
boto3 documentation
# get_resource_policy method definition
await def get_resource_policy(
self,
*,
ResourceArn: str,
) -> GetResourcePolicyResponseTypeDef: # (1)
...# get_resource_policy method usage example with argument unpacking
kwargs: GetResourcePolicyRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.get_resource_policy(**kwargs)get_trail#
Returns settings information for a specified trail.
Type annotations and code completion for session.create_client("cloudtrail").get_trail method.
boto3 documentation
# get_trail method definition
await def get_trail(
self,
*,
Name: str,
) -> GetTrailResponseTypeDef: # (1)
...# get_trail method usage example with argument unpacking
kwargs: GetTrailRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.get_trail(**kwargs)get_trail_status#
Returns a JSON-formatted list of information about the specified trail.
Type annotations and code completion for session.create_client("cloudtrail").get_trail_status method.
boto3 documentation
# get_trail_status method definition
await def get_trail_status(
self,
*,
Name: str,
) -> GetTrailStatusResponseTypeDef: # (1)
...# get_trail_status method usage example with argument unpacking
kwargs: GetTrailStatusRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.get_trail_status(**kwargs)list_channels#
Lists the channels in the current account, and their source names.
Type annotations and code completion for session.create_client("cloudtrail").list_channels method.
boto3 documentation
# list_channels method definition
await def list_channels(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListChannelsResponseTypeDef: # (1)
...# list_channels method usage example with argument unpacking
kwargs: ListChannelsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_channels(**kwargs)list_event_data_stores#
Returns information about all event data stores in the account, in the current Region.
Type annotations and code completion for session.create_client("cloudtrail").list_event_data_stores method.
boto3 documentation
# list_event_data_stores method definition
await def list_event_data_stores(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListEventDataStoresResponseTypeDef: # (1)
...# list_event_data_stores method usage example with argument unpacking
kwargs: ListEventDataStoresRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_event_data_stores(**kwargs)list_import_failures#
Returns a list of failures for the specified import.
Type annotations and code completion for session.create_client("cloudtrail").list_import_failures method.
boto3 documentation
# list_import_failures method definition
await def list_import_failures(
self,
*,
ImportId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListImportFailuresResponseTypeDef: # (1)
...# list_import_failures method usage example with argument unpacking
kwargs: ListImportFailuresRequestRequestTypeDef = { # (1)
"ImportId": ...,
}
parent.list_import_failures(**kwargs)list_imports#
Returns information on all imports, or a select set of imports by ImportStatus
or Destination.
Type annotations and code completion for session.create_client("cloudtrail").list_imports method.
boto3 documentation
# list_imports method definition
await def list_imports(
self,
*,
MaxResults: int = ...,
Destination: str = ...,
ImportStatus: ImportStatusType = ..., # (1)
NextToken: str = ...,
) -> ListImportsResponseTypeDef: # (2)
...# list_imports method usage example with argument unpacking
kwargs: ListImportsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_imports(**kwargs)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 session.create_client("cloudtrail").list_public_keys method.
boto3 documentation
# list_public_keys method definition
await def list_public_keys(
self,
*,
StartTime: Union[datetime, str] = ...,
EndTime: Union[datetime, str] = ...,
NextToken: str = ...,
) -> ListPublicKeysResponseTypeDef: # (1)
...# list_public_keys method usage example with argument unpacking
kwargs: ListPublicKeysRequestRequestTypeDef = { # (1)
"StartTime": ...,
}
parent.list_public_keys(**kwargs)list_queries#
Returns a list of queries and query statuses for the past seven days.
Type annotations and code completion for session.create_client("cloudtrail").list_queries method.
boto3 documentation
# list_queries method definition
await def list_queries(
self,
*,
EventDataStore: str,
NextToken: str = ...,
MaxResults: int = ...,
StartTime: Union[datetime, str] = ...,
EndTime: Union[datetime, str] = ...,
QueryStatus: QueryStatusType = ..., # (1)
) -> ListQueriesResponseTypeDef: # (2)
...# list_queries method usage example with argument unpacking
kwargs: ListQueriesRequestRequestTypeDef = { # (1)
"EventDataStore": ...,
}
parent.list_queries(**kwargs)list_tags#
Lists the tags for the specified trails, event data stores, or channels in the current Region.
Type annotations and code completion for session.create_client("cloudtrail").list_tags method.
boto3 documentation
# list_tags method definition
await def list_tags(
self,
*,
ResourceIdList: Sequence[str],
NextToken: str = ...,
) -> ListTagsResponseTypeDef: # (1)
...# list_tags method usage example with argument unpacking
kwargs: ListTagsRequestRequestTypeDef = { # (1)
"ResourceIdList": ...,
}
parent.list_tags(**kwargs)list_trails#
Lists trails that are in the current account.
Type annotations and code completion for session.create_client("cloudtrail").list_trails method.
boto3 documentation
# list_trails method definition
await def list_trails(
self,
*,
NextToken: str = ...,
) -> ListTrailsResponseTypeDef: # (1)
...# list_trails method usage example with argument unpacking
kwargs: ListTrailsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_trails(**kwargs)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 session.create_client("cloudtrail").lookup_events method.
boto3 documentation
# lookup_events method definition
await 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)
...# lookup_events method usage example with argument unpacking
kwargs: LookupEventsRequestRequestTypeDef = { # (1)
"LookupAttributes": ...,
}
parent.lookup_events(**kwargs)put_event_selectors#
Configures an event selector or advanced event selectors for your trail.
Type annotations and code completion for session.create_client("cloudtrail").put_event_selectors method.
boto3 documentation
# put_event_selectors method definition
await def put_event_selectors(
self,
*,
TrailName: str,
EventSelectors: Sequence[EventSelectorTypeDef] = ..., # (1)
AdvancedEventSelectors: Sequence[AdvancedEventSelectorTypeDef] = ..., # (2)
) -> PutEventSelectorsResponseTypeDef: # (3)
...# put_event_selectors method usage example with argument unpacking
kwargs: PutEventSelectorsRequestRequestTypeDef = { # (1)
"TrailName": ...,
}
parent.put_event_selectors(**kwargs)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 session.create_client("cloudtrail").put_insight_selectors method.
boto3 documentation
# put_insight_selectors method definition
await def put_insight_selectors(
self,
*,
TrailName: str,
InsightSelectors: Sequence[InsightSelectorTypeDef], # (1)
) -> PutInsightSelectorsResponseTypeDef: # (2)
...# put_insight_selectors method usage example with argument unpacking
kwargs: PutInsightSelectorsRequestRequestTypeDef = { # (1)
"TrailName": ...,
"InsightSelectors": ...,
}
parent.put_insight_selectors(**kwargs)put_resource_policy#
Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event source outside of Amazon Web Services.
Type annotations and code completion for session.create_client("cloudtrail").put_resource_policy method.
boto3 documentation
# put_resource_policy method definition
await def put_resource_policy(
self,
*,
ResourceArn: str,
ResourcePolicy: str,
) -> PutResourcePolicyResponseTypeDef: # (1)
...# put_resource_policy method usage example with argument unpacking
kwargs: PutResourcePolicyRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"ResourcePolicy": ...,
}
parent.put_resource_policy(**kwargs)register_organization_delegated_admin#
Registers an organization’s member account as the CloudTrail delegated administrator.
Type annotations and code completion for session.create_client("cloudtrail").register_organization_delegated_admin method.
boto3 documentation
# register_organization_delegated_admin method definition
await def register_organization_delegated_admin(
self,
*,
MemberAccountId: str,
) -> Dict[str, Any]:
...# register_organization_delegated_admin method usage example with argument unpacking
kwargs: RegisterOrganizationDelegatedAdminRequestRequestTypeDef = { # (1)
"MemberAccountId": ...,
}
parent.register_organization_delegated_admin(**kwargs)remove_tags#
Removes the specified tags from a trail, event data store, or channel.
Type annotations and code completion for session.create_client("cloudtrail").remove_tags method.
boto3 documentation
# remove_tags method definition
await def remove_tags(
self,
*,
ResourceId: str,
TagsList: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...- See TagTypeDef
# remove_tags method usage example with argument unpacking
kwargs: RemoveTagsRequestRequestTypeDef = { # (1)
"ResourceId": ...,
"TagsList": ...,
}
parent.remove_tags(**kwargs)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 session.create_client("cloudtrail").restore_event_data_store method.
boto3 documentation
# restore_event_data_store method definition
await def restore_event_data_store(
self,
*,
EventDataStore: str,
) -> RestoreEventDataStoreResponseTypeDef: # (1)
...# restore_event_data_store method usage example with argument unpacking
kwargs: RestoreEventDataStoreRequestRequestTypeDef = { # (1)
"EventDataStore": ...,
}
parent.restore_event_data_store(**kwargs)start_event_data_store_ingestion#
Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN.
Type annotations and code completion for session.create_client("cloudtrail").start_event_data_store_ingestion method.
boto3 documentation
# start_event_data_store_ingestion method definition
await def start_event_data_store_ingestion(
self,
*,
EventDataStore: str,
) -> Dict[str, Any]:
...# start_event_data_store_ingestion method usage example with argument unpacking
kwargs: StartEventDataStoreIngestionRequestRequestTypeDef = { # (1)
"EventDataStore": ...,
}
parent.start_event_data_store_ingestion(**kwargs)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 session.create_client("cloudtrail").start_import method.
boto3 documentation
# start_import method definition
await def start_import(
self,
*,
Destinations: Sequence[str] = ...,
ImportSource: ImportSourceTypeDef = ..., # (1)
StartEventTime: Union[datetime, str] = ...,
EndEventTime: Union[datetime, str] = ...,
ImportId: str = ...,
) -> StartImportResponseTypeDef: # (2)
...# start_import method usage example with argument unpacking
kwargs: StartImportRequestRequestTypeDef = { # (1)
"Destinations": ...,
}
parent.start_import(**kwargs)start_logging#
Starts the recording of Amazon Web Services API calls and log file delivery for a trail.
Type annotations and code completion for session.create_client("cloudtrail").start_logging method.
boto3 documentation
# start_logging method definition
await def start_logging(
self,
*,
Name: str,
) -> Dict[str, Any]:
...# start_logging method usage example with argument unpacking
kwargs: StartLoggingRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.start_logging(**kwargs)start_query#
Starts a CloudTrail Lake query.
Type annotations and code completion for session.create_client("cloudtrail").start_query method.
boto3 documentation
# start_query method definition
await def start_query(
self,
*,
QueryStatement: str = ...,
DeliveryS3Uri: str = ...,
QueryAlias: str = ...,
QueryParameters: Sequence[str] = ...,
) -> StartQueryResponseTypeDef: # (1)
...# start_query method usage example with argument unpacking
kwargs: StartQueryRequestRequestTypeDef = { # (1)
"QueryStatement": ...,
}
parent.start_query(**kwargs)stop_event_data_store_ingestion#
Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN.
Type annotations and code completion for session.create_client("cloudtrail").stop_event_data_store_ingestion method.
boto3 documentation
# stop_event_data_store_ingestion method definition
await def stop_event_data_store_ingestion(
self,
*,
EventDataStore: str,
) -> Dict[str, Any]:
...# stop_event_data_store_ingestion method usage example with argument unpacking
kwargs: StopEventDataStoreIngestionRequestRequestTypeDef = { # (1)
"EventDataStore": ...,
}
parent.stop_event_data_store_ingestion(**kwargs)stop_import#
Stops a specified import.
Type annotations and code completion for session.create_client("cloudtrail").stop_import method.
boto3 documentation
# stop_import method definition
await def stop_import(
self,
*,
ImportId: str,
) -> StopImportResponseTypeDef: # (1)
...# stop_import method usage example with argument unpacking
kwargs: StopImportRequestRequestTypeDef = { # (1)
"ImportId": ...,
}
parent.stop_import(**kwargs)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 session.create_client("cloudtrail").stop_logging method.
boto3 documentation
# stop_logging method definition
await def stop_logging(
self,
*,
Name: str,
) -> Dict[str, Any]:
...# stop_logging method usage example with argument unpacking
kwargs: StopLoggingRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.stop_logging(**kwargs)update_channel#
Updates a channel specified by a required channel ARN or UUID.
Type annotations and code completion for session.create_client("cloudtrail").update_channel method.
boto3 documentation
# update_channel method definition
await def update_channel(
self,
*,
Channel: str,
Destinations: Sequence[DestinationTypeDef] = ..., # (1)
Name: str = ...,
) -> UpdateChannelResponseTypeDef: # (2)
...# update_channel method usage example with argument unpacking
kwargs: UpdateChannelRequestRequestTypeDef = { # (1)
"Channel": ...,
}
parent.update_channel(**kwargs)update_event_data_store#
Updates an event data store.
Type annotations and code completion for session.create_client("cloudtrail").update_event_data_store method.
boto3 documentation
# update_event_data_store method definition
await def update_event_data_store(
self,
*,
EventDataStore: str,
Name: str = ...,
AdvancedEventSelectors: Sequence[AdvancedEventSelectorTypeDef] = ..., # (1)
MultiRegionEnabled: bool = ...,
OrganizationEnabled: bool = ...,
RetentionPeriod: int = ...,
TerminationProtectionEnabled: bool = ...,
KmsKeyId: str = ...,
) -> UpdateEventDataStoreResponseTypeDef: # (2)
...# update_event_data_store method usage example with argument unpacking
kwargs: UpdateEventDataStoreRequestRequestTypeDef = { # (1)
"EventDataStore": ...,
}
parent.update_event_data_store(**kwargs)update_trail#
Updates trail settings that control what events you are logging, and how to handle log files.
Type annotations and code completion for session.create_client("cloudtrail").update_trail method.
boto3 documentation
# update_trail method definition
await 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)
...# update_trail method usage example with argument unpacking
kwargs: UpdateTrailRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.update_trail(**kwargs)__aenter__#
Type annotations and code completion for session.create_client("cloudtrail").__aenter__ method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> CloudTrailClient:
...__aexit__#
Type annotations and code completion for session.create_client("cloudtrail").__aexit__ method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...get_paginator#
Type annotations and code completion for session.create_client("cloudtrail").get_paginator method with overloads.
client.get_paginator("list_import_failures")-> ListImportFailuresPaginatorclient.get_paginator("list_imports")-> ListImportsPaginatorclient.get_paginator("list_public_keys")-> ListPublicKeysPaginatorclient.get_paginator("list_tags")-> ListTagsPaginatorclient.get_paginator("list_trails")-> ListTrailsPaginatorclient.get_paginator("lookup_events")-> LookupEventsPaginator