list-access-keys¶

Description¶

Lists access keys.

list-access-keys 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-access-keys
[--access-key-ids <value>]
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--access-key-ids (array)

The access key IDs or CRNs of the access keys.

Syntax:

"string" "string" ...

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

accessKeys -> (array)

The access keys.

item -> (object)

Information about a Cloudera CDP access key.

accessKeyId -> (string)

The ID of the access key.

crn -> (string)

The CRN of the access key.

actorCrn -> (string)

The CRN of the actor with which this access key is associated.

creationDate -> (datetime)

The date when the access key was created.

status -> (string)

The status of an access key.

type -> (string)

The version of an access key. V1 - Deprecated, use RSA as the request signing algorithm. V2 - Use ED25519 as the request signing algorithm. V3 - Use ECDSA as the request signing algorithm. DEFAULT - Use the system default signing algorithm (V3 in GovCloud, V2 in other regions).

lastUsage -> (object)

Information on the last time an access key was used.

lastUsageDate -> (datetime)

The date when the access key was last used.

serviceName -> (string)

The name of the service with which this access key was most recently used.

nextToken -> (string)

The token to use when requesting the next set of results. If not present, there are no additional results.

Form Factors¶

public, private