Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . logs ]

describe-import-tasks

Description

Lists and describes import tasks, with optional filtering by import status and source ARN.

See also: AWS API Documentation

Synopsis

  describe-import-tasks
[--import-id <value>]
[--import-status <value>]
[--import-source-arn <value>]
[--limit <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--import-id (string)

Optional filter to describe a specific import task by its ID.

--import-status (string)

Optional filter to list imports by their status. Valid values are IN_PROGRESS, CANCELLED, COMPLETED and FAILED.

Possible values:

• IN_PROGRESS
• CANCELLED
• COMPLETED
• FAILED

--import-source-arn (string)

Optional filter to list imports from a specific source

--limit (integer)

The maximum number of import tasks to return in the response. Default: 50

--next-token (string)

The pagination token for the next set of results.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

imports -> (list)

The list of import tasks that match the request filters.

(structure)

An import job to move data from CloudTrail Event Data Store to CloudWatch.

importId -> (string)

The unique identifier of the import task.

importSourceArn -> (string)

The ARN of the CloudTrail Lake Event Data Store being imported from.

importStatus -> (string)

The current status of the import task. Valid values are IN_PROGRESS, CANCELLED, COMPLETED and FAILED.

importDestinationArn -> (string)

The ARN of the managed CloudWatch Logs log group where the events are being imported to.

importStatistics -> (structure)

Statistics about the import progress

bytesImported -> (long)

The total number of bytes that have been imported to the managed log group.

importFilter -> (structure)

The filter criteria used for this import task.

startEventTime -> (long)

The start of the time range for events to import, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

endEventTime -> (long)

The end of the time range for events to import, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

creationTime -> (long)

The timestamp when the import task was created, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

lastUpdatedTime -> (long)

The timestamp when the import task was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

errorMessage -> (string)

Error message related to any failed imports

nextToken -> (string)

The token to use when requesting the next set of results. Not present if there are no additional results to retrieve.