describe-agent¶

Description¶

Describes an agent.

Synopsis¶

  describe-agent
--agent-id <value>
--aws-account-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]
[--cli-error-format <value>]

Options¶

--agent-id (string) [required]

The unique identifier for the agent.

Constraints:

min: 1

max: 256

pattern: [0-9a-zA-Z-_.+]+

--aws-account-id (string) [required]

The ID of the Amazon Web Services account that contains the agent.

Constraints:

min: 12

max: 12

pattern: ^[0-9]{12}$

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

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

Agent -> (structure)

The full details of the agent, including its configuration, status, and associations.

Spaces -> (list)

The Amazon Resource Names (ARNs) of the spaces attached to the agent.

Constraints:

min: 0

max: 10

(string)

ActionConnectors -> (list)

The Amazon Resource Names (ARNs) of the action connectors attached to the agent.

Constraints:

min: 0

max: 10

(string)

Description -> (string)

A description of the agent.

Constraints:

min: 0

max: 1000

pattern: \P{C}*

IconId -> (string)

The icon identifier for the agent.

Constraints:

min: 1

max: 200

Name -> (string) [required]

The name of the agent.

Constraints:

min: 1

max: 50

pattern: (?!\s*$).+

StarterPrompts -> (list)

A list of starter prompts that are displayed to users when they begin interacting with the agent.

Constraints:

min: 0

max: 3

(string)

Constraints:

min: 0

max: 100

WelcomeMessage -> (string)

The welcome message that is displayed when a user starts a conversation with the agent.

Constraints:

min: 0

max: 300

Arn -> (string) [required]

The Amazon Resource Name (ARN) of the agent.

Constraints:

min: 0

max: 1284

pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

AgentId -> (string) [required]

The unique identifier for the agent.

Constraints:

min: 1

max: 256

pattern: [0-9a-zA-Z-_.+]+

AgentLifecycle -> (string) [required]

The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED .

Possible values:

PREVIEW

PUBLISHED

AgentStatus -> (string) [required]

The status of the agent.

Possible values:

ACTIVE

UPDATING

FAILED

CREATING

CreatedAt -> (timestamp) [required]

The date and time that the agent was created.

Creator -> (string) [required]

The identity of the user who created the agent.

CustomPromptInterface -> (structure)

The custom prompt interface configuration for the agent.

ModelProfileId -> (string) [required]

The identifier of the model profile.

Constraints:

min: 36

max: 36

pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

SubscriptionId -> (string) [required]

The subscription identifier.

Constraints:

min: 32

max: 32

pattern: [a-z0-9]+

QbsAwsAccountId -> (string) [required]

The Amazon Web Services account ID for the Q Business service.

Constraints:

min: 15

max: 15

pattern: QBS[0-9]{12}

ResponseLength -> (string)

Instructions for the desired response length.

Constraints:

min: 5

max: 350000

pattern: [\s\S]*

OutputStyle -> (string)

Instructions for the desired output style.

Constraints:

min: 5

max: 350000

pattern: [\s\S]*

Identity -> (string)

Instructions that define the agent’s identity and persona.

Constraints:

min: 5

max: 350000

pattern: [\s\S]*

Tone -> (string)

Instructions for the desired tone of responses.

Constraints:

min: 5

max: 350000

pattern: [\s\S]*

CustomInstructions -> (string)

Custom instructions for the agent’s behavior.

Constraints:

min: 5

max: 350000

pattern: [\s\S]*

promptSummary -> (string)

A summary of the custom prompt configuration.

ErrorMessage -> (string)

An error message associated with the agent, if applicable.

UpdatedAt -> (timestamp) [required]

The date and time that the agent was last updated.

RequestId -> (string)

The Amazon Web Services request ID for this operation.

Table of Contents

Feedback

User Guide