archive-audit-events

subtitle

Archive audit events.

version

0.9.68

Description

This is used to trigger immediate audit event archiving based on input criteria. WARNING: This command is experimental and subject to backwards-incompatible change.

Synopsis

  archive-audit-events
--from-timestamp <value>
--to-timestamp <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options

--from-timestamp (datetime)

The beginning timestamp for the search range (inclusive).

--to-timestamp (datetime)

The ending timestamp for the search range (exclusive).

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

eventCount -> (integer)

The number of events archived.

eventBatches -> (array)

The details about the batches of events archived.

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.

taskId -> (string)

The id representing an asynchronous task.

Form Factors

public