start_import
async
¶
start_import(
*,
config_overrides: Optional[AsyncCloudTrailClientConfig] = None,
destinations: Optional[ImportDestinations] = None,
import_source: Optional[ImportSource] = None,
start_event_time: Optional[Date] = None,
end_event_time: Optional[Date] = None,
import_id: Optional[UUID] = None,
) -> StartImportResponse
CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.
Starts an import of logged trail events from a source S3 bucket to a destination event data store. By default, CloudTrail only imports events contained in the S3 bucket's CloudTrail prefix and the prefixes inside the CloudTrail prefix, and does not check prefixes for other Amazon Web Services services. If you want to import CloudTrail events contained in another prefix, you must include the prefix in the S3LocationUri. For more considerations about importing trail events, see Considerations for copying trail events in the CloudTrail User Guide.
When you start a new import, the Destinations and ImportSource parameters are required. Before starting a new import, disable any access control lists (ACLs) attached to the source S3 bucket. For more information about disabling ACLs, see Controlling ownership of objects and disabling ACLs for your bucket.
When you retry an import, the ImportID parameter is required.
If the destination event data store is for an organization, you must use the management account to import trail events. You cannot use the delegated administrator account for the organization.
Parameters:
-
destinations(Optional[ImportDestinations], default:None) –The ARN of the destination event data store. Use this parameter for a new import.
-
import_source(Optional[ImportSource], default:None) –The source S3 bucket for the import. Use this parameter for a new import.
-
start_event_time(Optional[Date], default:None) –Use with
EndEventTimeto bound aStartImportrequest, and limit imported trail events to only those events logged within a specified time period. When you specify a time range, CloudTrail checks the prefix and log file names to verify the names contain a date between the specifiedStartEventTimeandEndEventTimebefore attempting to import events. -
end_event_time(Optional[Date], default:None) –Use with
StartEventTimeto bound aStartImportrequest, and limit imported trail events to only those events logged within a specified time period. When you specify a time range, CloudTrail checks the prefix and log file names to verify the names contain a date between the specifiedStartEventTimeandEndEventTimebefore attempting to import events. -
import_id(Optional[UUID], default:None) –The ID of the import. Use this parameter when you are retrying an import.
Raises:
-
AccountHasOngoingImportException–This exception is thrown when you start a new import and a previous import is still in progress.
-
EventDataStoreARNInvalidException–The specified event data store ARN is not valid or does not map to an event data store in your account.
-
EventDataStoreNotFoundException–The specified event data store was not found.
-
ImportNotFoundException–The specified import was not found.
-
InactiveEventDataStoreException–The event data store is inactive.
-
InsufficientEncryptionPolicyException–For the
CreateTrailPutInsightSelectors,UpdateTrail,StartQuery, andStartImportoperations, this exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.For all other operations, this exception is thrown when the policy for the KMS key does not have sufficient permissions for the operation.
-
InvalidEventDataStoreCategoryException–This exception is thrown when event categories of specified event data stores are not valid.
-
InvalidEventDataStoreStatusException–The event data store is not in a status that supports the operation.
-
InvalidImportSourceException–This exception is thrown when the provided source S3 bucket is not valid for import.
-
InvalidParameterException–The request includes a parameter that is not valid.
-
OperationNotPermittedException–This exception is thrown when the requested operation is not permitted.
-
UnsupportedOperationException–This exception is thrown when the requested operation is not supported.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_cloudtrail/_services/async_cloud_trail.py
3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 | |