CloudTrail / Client / stop_import

stop_import#

CloudTrail.Client.stop_import(**kwargs)#

Stops a specified import.

See also: AWS API Documentation

Request Syntax

response = client.stop_import(
    ImportId='string'
)
Parameters:

ImportId (string) –

[REQUIRED]

The ID of the import.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • ImportId (string) –

      The ID for the import.

    • ImportSource (dict) –

      The source S3 bucket for the import.

      • 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.

    • Destinations (list) –

      The ARN of the destination event data store.

      • (string) –

    • ImportStatus (string) –

      The status of the import.

    • CreatedTimestamp (datetime) –

      The timestamp of the import’s creation.

    • UpdatedTimestamp (datetime) –

      The timestamp of the import’s last update.

    • 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.

    • ImportStatistics (dict) –

      Returns information on the stopped 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