Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . quicksight ]

list-users-index-capacity

Description

Lists per-user index capacity consumption for an account.

See also: AWS API Documentation

Synopsis

  list-users-index-capacity
--aws-account-id <value>
[--namespace <value>]
[--filters <value>]
[--sort-by <value>]
[--sort-order <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--aws-account-id (string)

The ID of the Amazon Web Services account that contains the index capacity data.

--namespace (string)

The namespace to scope the user search to. Required when the userNameOrEmail filter is present.

--filters (list)

Filters to apply. Only one filter is supported per request. The userNameOrEmail and totalCapacityBytes filters are mutually exclusive.

(tagged union structure)

A filter for user index capacity queries. Only one filter type can be specified per request.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: userNameOrEmail, totalCapacityBytes.

userNameOrEmail -> (structure)

Filter users by username or email prefix.

prefix -> (string)

The prefix to match against username or email (starts-with match).

totalCapacityBytes -> (structure)

Filter users by total capacity range in bytes.

minBytes -> (long)

The minimum capacity in bytes (inclusive). At least one of minBytes or maxBytes is required.

maxBytes -> (long)

The maximum capacity in bytes (inclusive). At least one of minBytes or maxBytes is required.

Shorthand Syntax:

userNameOrEmail={prefix=string},totalCapacityBytes={minBytes=long,maxBytes=long} ...

JSON Syntax:

[
  {
    "userNameOrEmail": {
      "prefix": "string"
    },
    "totalCapacityBytes": {
      "minBytes": long,
      "maxBytes": long
    }
  }
  ...
]

--sort-by (string)

The field to sort results by.

Possible values:

• TOTAL_CAPACITY_BYTES

--sort-order (string)

The sort order for results. Defaults to DESC if not specified.

Possible values:

• ASC
• DESC

--max-results (integer)

The maximum number of results to return per page.

--next-token (string)

The token for the next set of results, received from a previous call.

--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. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

users -> (list)

The list of users with their index capacity metrics.

(structure)

A summary of a user’s index capacity consumption.

userArn -> (string)

The ARN of the user.

userName -> (string)

The username of the user.

email -> (string)

The email address of the user.

role -> (string)

The role of the user.

totalCapacityBytes -> (long)

The total index capacity consumed by the user in bytes.

totalKBCapacityBytes -> (long)

The total index capacity consumed by the user’s knowledge bases in bytes.

totalSpaceCapacityBytes -> (long)

The total index capacity consumed by the user’s spaces in bytes.

kbCount -> (integer)

The number of knowledge bases owned by the user.

spaceCount -> (integer)

The number of spaces owned by the user.

nextToken -> (string)

The token for the next set of results, or null if there are no more results.

requestId -> (string)

The Amazon Web Services request ID for this operation.