[ aws . qbusiness ]

get-index

Description

Gets information about an existing Amazon Q Business index.

See also: AWS API Documentation

Synopsis

  get-index
--application-id <value>
--index-id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--application-id (string)

The identifier of the Amazon Q Business application connected to the index.

--index-id (string)

The identifier of the Amazon Q Business index you want information on.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
• yaml
• yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

applicationId -> (string)

The identifier of the Amazon Q Business application associated with the index.

indexId -> (string)

The identifier of the Amazon Q Business index.

displayName -> (string)

The name of the Amazon Q Business index.

indexArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Q Business index.

status -> (string)

The current status of the index. When the value is ACTIVE , the index is ready for use. If the Status field value is FAILED , the ErrorMessage field contains a message that explains why.

type -> (string)

The type of index attached to your Amazon Q Business application.

description -> (string)

The description for the Amazon Q Business index.

createdAt -> (timestamp)

The Unix timestamp when the Amazon Q Business index was created.

updatedAt -> (timestamp)

The Unix timestamp when the Amazon Q Business index was last updated.

capacityConfiguration -> (structure)

The storage capacity units chosen for your Amazon Q Business index.

units -> (integer)

The number of storage units configured for an Amazon Q Business index.

documentAttributeConfigurations -> (list)

Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes .

(structure)

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes .

name -> (string)

The name of the document attribute.

type -> (string)

The type of document attribute.

search -> (string)

Information about whether the document attribute can be used by an end user to search for information on their web experience.

error -> (structure)

When the Status field value is FAILED , the ErrorMessage field contains a message that explains why.

errorMessage -> (string)

The message explaining the Amazon Q Business request error.

errorCode -> (string)

The code associated with the Amazon Q Business request error.

indexStatistics -> (structure)

Provides information about the number of documents indexed.

textDocumentStatistics -> (structure)

The number of documents indexed.

indexedTextBytes -> (long)

The total size, in bytes, of the indexed documents.

indexedTextDocumentCount -> (integer)

The number of text documents indexed.