AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . qapps ]

get-library-item

Description

Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.

See also: AWS API Documentation

Synopsis

  get-library-item
--instance-id <value>
--library-item-id <value>
[--app-id <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>]

Options

--instance-id (string)

The unique identifier of the Amazon Q Business application environment instance.

--library-item-id (string)

The unique identifier of the library item to retrieve.

--app-id (string)

The unique identifier of the Amazon Q App associated with the library item.

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

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

Output

libraryItemId -> (string)

The unique identifier of the library item.

appId -> (string)

The unique identifier of the Q App associated with the library item.

appVersion -> (integer)

The version of the Q App associated with the library item.

categories -> (list)

The categories associated with the library item for discovery.

(structure)

A category used to classify and filter library items for Amazon Q Apps.

id -> (string)

The unique identifier of the category.

title -> (string)

The title or name of the category.

status -> (string)

The status of the library item, such as "Published".

createdAt -> (timestamp)

The date and time the library item was created.

createdBy -> (string)

The user who created the library item.

updatedAt -> (timestamp)

The date and time the library item was last updated.

updatedBy -> (string)

The user who last updated the library item.

ratingCount -> (integer)

The number of ratings the library item has received from users.

isRatedByUser -> (boolean)

Whether the current user has rated the library item.

userCount -> (integer)

The number of users who have associated the Q App with their account.