Skip to content

Gets detailed information about the individual batches within an import task, including their status and any error messages

Description

Gets detailed information about the individual batches within an import task, including their status and any error messages. For CloudTrail Event Data Store sources, a batch refers to a subset of stored events grouped by their eventTime.

Usage

cloudwatchlogs_describe_import_task_batches(importId, batchImportStatus,
  limit, nextToken)

Arguments

  • importId

    [required] The ID of the import task to get batch information for.

  • batchImportStatus

    Optional filter to list import batches by their status. Accepts multiple status values: IN_PROGRESS, CANCELLED, COMPLETED and FAILED.

  • limit

    The maximum number of import batches to return in the response. Default: 10

  • nextToken

    The pagination token for the next set of results.

Value

A list with the following syntax:

list(
  importSourceArn = "string",
  importId = "string",
  importBatches = list(
    list(
      batchId = "string",
      status = "IN_PROGRESS"|"CANCELLED"|"COMPLETED"|"FAILED",
      errorMessage = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$describe_import_task_batches(
  importId = "string",
  batchImportStatus = list(
    "IN_PROGRESS"|"CANCELLED"|"COMPLETED"|"FAILED"
  ),
  limit = 123,
  nextToken = "string"
)