Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

get_import

get_import(**kwargs)

Returns information about a specific import.

See also: AWS API Documentation

Request Syntax

response = client.get_import(
    ImportId='string'
)
Parameters
ImportId (string) --

[REQUIRED]

The ID for the import.

Return type
dict
Returns
Response Syntax
{
    'ImportId': 'string',
    'Destinations': [
        'string',
    ],
    'ImportSource': {
        'S3': {
            'S3LocationUri': 'string',
            'S3BucketRegion': 'string',
            'S3BucketAccessRoleArn': 'string'
        }
    },
    'StartEventTime': datetime(2015, 1, 1),
    'EndEventTime': datetime(2015, 1, 1),
    'ImportStatus': 'INITIALIZING'|'IN_PROGRESS'|'FAILED'|'STOPPED'|'COMPLETED',
    'CreatedTimestamp': datetime(2015, 1, 1),
    'UpdatedTimestamp': datetime(2015, 1, 1),
    'ImportStatistics': {
        'PrefixesFound': 123,
        'PrefixesCompleted': 123,
        'FilesCompleted': 123,
        'EventsCompleted': 123,
        'FailedEntries': 123
    }
}

Response Structure

  • (dict) --
    • ImportId (string) --

      The ID of the import.

    • Destinations (list) --

      The ARN of the destination event data store.

      • (string) --
    • ImportSource (dict) --

      The source S3 bucket.

      • S3 (dict) --

        The source S3 bucket.

        • S3LocationUri (string) --

          The URI for the source S3 bucket.

        • S3BucketRegion (string) --

          The region associated with the source S3 bucket.

        • S3BucketAccessRoleArn (string) --

          The IAM ARN role used to access the source S3 bucket.

    • StartEventTime (datetime) --

      Used with EndEventTime to bound a StartImport request, and limit imported trail events to only those events logged within a specified time period.

    • EndEventTime (datetime) --

      Used with StartEventTime to bound a StartImport request, and limit imported trail events to only those events logged within a specified time period.

    • ImportStatus (string) --

      The status of the import.

    • CreatedTimestamp (datetime) --

      The timestamp of the import's creation.

    • UpdatedTimestamp (datetime) --

      The timestamp of when the import was updated.

    • ImportStatistics (dict) --

      Provides statistics for the import. CloudTrail does not update import statistics in real-time. Returned values for parameters such as EventsCompleted may be lower than the actual value, because CloudTrail updates statistics incrementally over the course of the import.

      • PrefixesFound (integer) --

        The number of S3 prefixes found for the import.

      • PrefixesCompleted (integer) --

        The number of S3 prefixes that completed import.

      • FilesCompleted (integer) --

        The number of log files that completed import.

      • EventsCompleted (integer) --

        The number of trail events imported into the event data store.

      • FailedEntries (integer) --

        The number of failed entries.

Exceptions

  • CloudTrail.Client.exceptions.ImportNotFoundException
  • CloudTrail.Client.exceptions.InvalidParameterException
  • CloudTrail.Client.exceptions.OperationNotPermittedException
  • CloudTrail.Client.exceptions.UnsupportedOperationException