get-batch-events-for-archiving-status

subtitle

Get the status of creating batches of audit events to be archived.

version

0.9.68

Description

Get the status of creating batches of audit events to be archived. If automated archiving is configured, then this operation is disabled.

Synopsis

  get-batch-events-for-archiving-status
[--task-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options

--task-id (string)

The ID of the asynchronous task to monitor.

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

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output

status -> (string)

Archive task status. OPEN - Task is still in progress COMPLETED - Task has completed successfully FAILED - Task has failed CANCELED - Task was canceled TERMINATED - Task as terminated CONTINUED_AS_NEW - Task was rerun as a new task TIMED_OUT - The task has timed out

eventBatches -> (array)

The details about the created batches, if the task completed successfully.

item -> (object)

Information about a batch of audit events that were archived.

accountId -> (string)

The account ID for which events were archived.

eventCount -> (integer)

The number of events archived. A negative number indicates that the count is not available.

archiveId -> (string)

The archive ID of the batch.

archiveTimestamp -> (integer)

The archive timestamp of the batch.

Form Factors

public