get-assistant¶
Description¶
Retrieves information about an assistant.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-assistant
--assistant-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--assistant-id (string)
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
--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.
See ‘aws help’ for descriptions of global parameters.
Output¶
assistant -> (structure)
Information about the assistant.
assistantArn -> (string)
The Amazon Resource Name (ARN) of the Wisdom assistant.
assistantId -> (string)
The identifier of the Wisdom assistant.
description -> (string)
The description.
name -> (string)
The name.
serverSideEncryptionConfiguration -> (structure)
The KMS key used for encryption.
kmsKeyId -> (string)
The KMS key. For information about valid ID values, see Key identifiers (KeyId) .
status -> (string)
The status of the assistant.
tags -> (map)
The tags used to organize, track, or control access for this resource.
key -> (string)
value -> (string)
type -> (string)
The type of assistant.