Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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

describe-faq

Description

Gets information about an FAQ list.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-faq
--id <value>
--index-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--id (string)

The unique identifier of the FAQ.

--index-id (string)

The identifier of the index that contains the FAQ.

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

See 'aws help' for descriptions of global parameters.

Output

Id -> (string)

The identifier of the FAQ.

IndexId -> (string)

The identifier of the index that contains the FAQ.

Name -> (string)

The name that you gave the FAQ when it was created.

Description -> (string)

The description of the FAQ that you provided when it was created.

CreatedAt -> (timestamp)

The date and time that the FAQ was created.

UpdatedAt -> (timestamp)

The date and time that the FAQ was last updated.

S3Path -> (structure)

Information required to find a specific file in an Amazon S3 bucket.

Bucket -> (string)

The name of the S3 bucket that contains the file.

Key -> (string)

The name of the file.

Status -> (string)

The status of the FAQ. It is ready to use when the status is ACTIVE .

RoleArn -> (string)

The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.

ErrorMessage -> (string)

If the Status field is FAILED , the ErrorMessage field contains the reason why the FAQ failed.