GetImport
Returns information about a specific import.
Request Syntax
{
"ImportId": "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.
- ImportId
-
The ID for the import.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-f0-9\-]+$Required: Yes
Response Syntax
{
"CreatedTimestamp": number,
"Destinations": [ "string" ],
"EndEventTime": number,
"ImportId": "string",
"ImportSource": {
"S3": {
"S3BucketAccessRoleArn": "string",
"S3BucketRegion": "string",
"S3LocationUri": "string"
}
},
"ImportStatistics": {
"EventsCompleted": number,
"FailedEntries": number,
"FilesCompleted": number,
"PrefixesCompleted": number,
"PrefixesFound": number
},
"ImportStatus": "string",
"StartEventTime": number,
"UpdatedTimestamp": number
}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.
- CreatedTimestamp
-
The timestamp of the import's creation.
Type: Timestamp
- Destinations
-
The ARN of the destination event data store.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 3. Maximum length of 256.
Pattern:
^[a-zA-Z0-9._/\-:]+$ - EndEventTime
-
Used with
StartEventTimeto bound aStartImportrequest, and limit imported trail events to only those events logged within a specified time period.Type: Timestamp
- ImportId
-
The ID of the import.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-f0-9\-]+$ - ImportSource
-
The source S3 bucket.
Type: ImportSource object
- ImportStatistics
-
Provides statistics for the import. CloudTrail does not update import statistics in real-time. Returned values for parameters such as
EventsCompletedmay be lower than the actual value, because CloudTrail updates statistics incrementally over the course of the import.Type: ImportStatistics object
- ImportStatus
-
The status of the import.
Type: String
Valid Values:
INITIALIZING | IN_PROGRESS | FAILED | STOPPED | COMPLETED - StartEventTime
-
Used with
EndEventTimeto bound aStartImportrequest, and limit imported trail events to only those events logged within a specified time period.Type: Timestamp
- UpdatedTimestamp
-
The timestamp of when the import was updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- ImportNotFoundException
-
The specified import was not found.
HTTP Status Code: 400
- InvalidParameterException
-
The request includes a parameter that is not valid.
HTTP Status Code: 400
- OperationNotPermittedException
-
This exception is thrown when the requested operation is not permitted.
HTTP Status Code: 400
- UnsupportedOperationException
-
This exception is thrown when the requested operation is not supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
