Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeImportTasks

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

Request Syntax


{
   "importId": "string",
   "importSourceArn": "string",
   "importStatus": "string",
   "limit": number,
   "nextToken": "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

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\-a-zA-Z0-9]+

Required: No

importSourceArn

Optional filter to list imports from a specific source

Type: String

Required: No

importStatus

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

Type: String

Valid Values: IN_PROGRESS | CANCELLED | COMPLETED | FAILED

Required: No

limit

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

nextToken

The pagination token for the next set of results.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax


{
   "imports": [ 
      { 
         "creationTime": number,
         "errorMessage": "string",
         "importDestinationArn": "string",
         "importFilter": { 
            "endEventTime": number,
            "startEventTime": number
         },
         "importId": "string",
         "importSourceArn": "string",
         "importStatistics": { 
            "bytesImported": number
         },
         "importStatus": "string",
         "lastUpdatedTime": number
      }
   ],
   "nextToken": "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.

imports

The list of import tasks that match the request filters.

Type: Array of Import objects

nextToken

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

Type: String

Length Constraints: Minimum length of 1.

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

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

Examples

To describe import tasks

The following example retrieves a list of import tasks with filters.

Sample Request


POST / HTTP/1.1
          Host: logs.<region>.<domain>
          X-Amz-Target: Logs_20140328.DescribeImportTasks
          {
          "importId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "importStatus": "IN_PROGRESS",
          "importSourceArn": "arn:aws:cloudtrail:us-west-2:123456789012:eventdatastore/f1d45bff-d0e3-4868-b5d9-2eb678aa32fb",
          "limit": 50,
          "nextToken": "eyJOZXh0VG9rZW4iOiJudWxsIiwiYm90b190cnVuY2F0ZV9hbW91bnQiOjF9"
          }

Sample Response


HTTP/1.1 200 OK
          {
          "imports": [
          {
          "importId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "importSourceArn": "arn:aws:cloudtrail:us-east-1:123456789012:eventdatastore/f1d45bff-d0e3-4868-b5d9-2eb678aa32fb",
          "importStatus": "IN_PROGRESS",
          "importDestinationArn": "arn:aws:logs:us-east-1:123456789012:log-group:aws/cloudtrail/f1d45bff-d0e3-4868-b5d9-2eb678aa32fb",
          "importStatistics": {
          "bytesImported": 1048576
          },
          "importFilter": {
          "startEventTime": 1640995200000,
          "endEventTime": 1641081600000
          },
          "creationTime": 1641168000000,
          "lastUpdatedTime": 1641171600000
          }
          ],
          "nextToken": "eyJOZXh0VG9rZW4iOiJudWxsIiwiYm90b190cnVuY2F0ZV9hbW91bnQiOjJ9"
          }