list-outstanding-archive-batches

subtitle

List outstanding (unarchived) archive batches.

version

0.9.68

Description

Lists archive batches that have not yet been marked as successfully archived. Their contents remain available for listing. If automated archiving is configured, then this operation is disabled.

list-outstanding-archive-batches is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.

Synopsis

  list-outstanding-archive-batches
[--from-timestamp <value>]
[--to-timestamp <value>]
[--max-items <value>]
[--starting-token <value>]
[--page-size <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).

--max-items (integer)

The total number of items to return. If the total number of items available is more than the value specified in max-items then a nextToken will be provided in the output that you can use to resume pagination. This nextToken response element should not be used directly outside of the CDP CLI. This option cannnot be combined with the no-paginate CLI option. If no max-items value is specified, then a default value of 20 is used.

--starting-token (string)

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

--page-size (integer)

The size of each page. Generally this does not need to be set and the default page size used is appropriate.

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

eventBatches -> (array)

The details about the outstanding batches of events.

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.

nextPageToken -> (string)

The page token for requesting the next page of results.

Form Factors

public