CreateImportTask
Starts an import from a data source to CloudWatch Log and creates a managed log group as the destination for the imported data. Currently, CloudTrail Event Data Store is the only supported data source.
The import task must satisfy the following constraints:
-
The specified source must be in an ACTIVE state.
-
The API caller must have permissions to access the data in the provided source and to perform iam:PassRole on the provided import role which has the same permissions, as described below.
-
The provided IAM role must trust the "cloudtrail.amazonaws.com" principal and have the following permissions:
-
cloudtrail:GetEventDataStoreData
-
logs:CreateLogGroup
-
logs:CreateLogStream
-
logs:PutResourcePolicy
-
(If source has an associated AWS KMS Key) kms:Decrypt
-
(If source has an associated AWS KMS Key) kms:GenerateDataKey
Example IAM policy for provided import role:
[ { "Effect": "Allow", "Action": "iam:PassRole", "Resource": "arn:aws:iam::123456789012:role/apiCallerCredentials", "Condition": { "StringLike": { "iam:AssociatedResourceARN": "arn:aws:logs:us-east-1:123456789012:log-group:aws/cloudtrail/f1d45bff-d0e3-4868-b5d9-2eb678aa32fb:*" } } }, { "Effect": "Allow", "Action": [ "cloudtrail:GetEventDataStoreData" ], "Resource": [ "arn:aws:cloudtrail:us-east-1:123456789012:eventdatastore/f1d45bff-d0e3-4868-b5d9-2eb678aa32fb" ] }, { "Effect": "Allow", "Action": [ "logs:CreateImportTask", "logs:CreateLogGroup", "logs:CreateLogStream", "logs:PutResourcePolicy" ], "Resource": [ "arn:aws:logs:us-east-1:123456789012:log-group:/aws/cloudtrail/*" ] }, { "Effect": "Allow", "Action": [ "kms:Decrypt", "kms:GenerateDataKey" ], "Resource": [ "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012" ] } ] -
-
If the import source has a customer managed key, the "cloudtrail.amazonaws.com" principal needs permissions to perform kms:Decrypt and kms:GenerateDataKey.
-
There can be no more than 3 active imports per account at a given time.
-
The startEventTime must be less than or equal to endEventTime.
-
The data being imported must be within the specified source's retention period.
Request Syntax
{
"importFilter": {
"endEventTime": number,
"startEventTime": number
},
"importRoleArn": "string",
"importSourceArn": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- importFilter
-
Optional filters to constrain the import by CloudTrail event time. Times are specified in Unix timestamp milliseconds. The range of data being imported must be within the specified source's retention period.
Type: ImportFilter object
Required: No
- importRoleArn
-
The ARN of the IAM role that grants CloudWatch Logs permission to import from the CloudTrail Lake Event Data Store.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
- importSourceArn
-
The ARN of the source to import from.
Type: String
Required: Yes
Response Syntax
{
"creationTime": number,
"importDestinationArn": "string",
"importId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- creationTime
-
The timestamp when the import task was created, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
Type: Long
Valid Range: Minimum value of 0.
- importDestinationArn
-
The ARN of the CloudWatch Logs log group created as the destination for the imported events.
Type: String
- importId
-
A unique identifier for the import task.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\-a-zA-Z0-9]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient permissions to perform this action.
HTTP Status Code: 400
- ConflictException
-
This operation attempted to create a resource that already exists.
HTTP Status Code: 400
- InvalidOperationException
-
The operation is not valid on the specified resource.
HTTP Status Code: 400
- InvalidParameterException
-
A parameter is specified incorrectly.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 400
- ThrottlingException
-
The request was throttled because of quota limits.
HTTP Status Code: 400
- ValidationException
-
One of the parameters for the request is not valid.
HTTP Status Code: 400
Examples
To create an import task from CloudTrail Lake to CloudWatch Logs
The following example creates an import task with time-based filters.
Sample Request
POST / HTTP/1.1
Host: logs.<region>.<domain>
X-Amz-Target: Logs_20140328.CreateImportTask
{
"importSourceArn": "arn:aws:cloudtrail:us-east-1:123456789012:eventdatastore/f1d45bff-d0e3-4868-b5d9-2eb678aa32fb",
"importRoleArn": "arn:aws:iam::123456789012:role/CloudWatchLogsImportRole",
"importFilter": {
"startEventTime": 1640995200000,
"endEventTime": 1641081600000
}
}Sample Response
HTTP/1.1 200 OK
{
"importId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"importDestinationArn": "arn:aws:logs:us-east-1:123456789012:log-group:aws/cloudtrail/f1d45bff-d0e3-4868-b5d9-2eb678aa32fb",
"creationTime": 1641168000000
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
