Start Import
cloudtrail_start_import | R Documentation |
Starts an import of logged trail events from a source S3 bucket to a destination event data store¶
Description¶
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.
Usage¶
Arguments¶
Destinations
The ARN of the destination event data store. Use this parameter for a new import.
ImportSource
The source S3 bucket for the import. Use this parameter for a new import.
StartEventTime
Use with
EndEventTime
to bound astart_import
request, 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 specifiedStartEventTime
andEndEventTime
before attempting to import events.EndEventTime
Use with
StartEventTime
to bound astart_import
request, 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 specifiedStartEventTime
andEndEventTime
before attempting to import events.ImportId
The ID of the import. Use this parameter when you are retrying an import.
Value¶
A list with the following syntax:
list(
ImportId = "string",
Destinations = list(
"string"
),
ImportSource = list(
S3 = list(
S3LocationUri = "string",
S3BucketRegion = "string",
S3BucketAccessRoleArn = "string"
)
),
StartEventTime = as.POSIXct(
"2015-01-01"
),
EndEventTime = as.POSIXct(
"2015-01-01"
),
ImportStatus = "INITIALIZING"|"IN_PROGRESS"|"FAILED"|"STOPPED"|"COMPLETED",
CreatedTimestamp = as.POSIXct(
"2015-01-01"
),
UpdatedTimestamp = as.POSIXct(
"2015-01-01"
)
)