# get-agent ## Description Gets information about an agent. See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgent) `get-agent` uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type `document` must be provided as JSON. Shorthand syntax does not support document types. ## Synopsis ``` get-agent --agent-id [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton ] [--debug] [--endpoint-url ] [--no-verify-ssl] [--no-paginate] [--output ] [--query ] [--profile ] [--region ] [--version ] [--color ] [--no-sign-request] [--ca-bundle ] [--cli-read-timeout ] [--cli-connect-timeout ] [--cli-binary-format ] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt] [--cli-error-format ] [--help] ``` ## Options `--agent-id` (string) [required] > The unique identifier of the agent. > Constraints: > * pattern: `[0-9a-zA-Z]{10}` `--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 `--help` (boolean) Display help for the command/subcommand. ## Output agent -> (structure) > Contains details about the agent. > agentId -> (string) [required] > > The unique identifier of the agent. > > Constraints: > > * pattern: `[0-9a-zA-Z]{10}` > agentName -> (string) [required] > > The name of the agent. > > Constraints: > > * pattern: `([0-9a-zA-Z][_-]?){1,100}` > agentArn -> (string) [required] > > The Amazon Resource Name (ARN) of the agent. > > Constraints: > > * min: `0` > > * max: `2048` > > * pattern: `arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}` > agentVersion -> (string) [required] > > The version of the agent. > > Constraints: > > * min: `5` > > * max: `5` > > * pattern: `DRAFT` > clientToken -> (string) > > A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) . > > Constraints: > > * min: `33` > > * max: `256` > > * pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}` > instruction -> (string) > > Instructions that tell the agent what it should do and how it should interact with users. > > Constraints: > > * min: `40` > > * max: `4000` > agentStatus -> (string) [required] > > The status of the agent and whether it is ready for use. The following statuses are possible: > > * CREATING – The agent is being created. > > * PREPARING – The agent is being prepared. > > * PREPARED – The agent is prepared and ready to be invoked. > > * NOT_PREPARED – The agent has been created but not yet prepared. > > * FAILED – The agent API operation failed. > > * UPDATING – The agent is being updated. > > * DELETING – The agent is being deleted. > > Possible values: > > * `CREATING` > > * `PREPARING` > > * `PREPARED` > > * `NOT_PREPARED` > > * `DELETING` > > * `FAILED` > > * `VERSIONING` > > * `UPDATING` > foundationModel -> (string) > > The foundation model used for orchestration by the agent. > > Constraints: > > * min: `1` > > * max: `2048` > > * pattern: `(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?` > description -> (string) > > The description of the agent. > > Constraints: > > * min: `1` > > * max: `200` > orchestrationType -> (string) > > Specifies the orchestration strategy for the agent. > > Possible values: > > * `DEFAULT` > > * `CUSTOM_ORCHESTRATION` > customOrchestration -> (structure) > > Contains custom orchestration configurations for the agent. > > executor -> (tagged union structure) > > > The structure of the executor invoking the actions in custom orchestration. > > > #### NOTE > > > This is a Tagged Union structure. Only one of the following top level keys can be set: `lambda`. > > > lambda -> (string) > > > > The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action. > > > > Constraints: > > > > * min: `0` > > > > * max: `2048` > > > > * pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?` > idleSessionTTLInSeconds -> (integer) [required] > > The number of seconds for which Amazon Bedrock keeps information about a user’s conversation with the agent. > > A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout. > > Constraints: > > * min: `60` > > * max: `5400` > agentResourceRoleArn -> (string) [required] > > The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent. > > Constraints: > > * min: `0` > > * max: `2048` > > * pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+` > customerEncryptionKeyArn -> (string) > > The Amazon Resource Name (ARN) of the KMS key that encrypts the agent. > > Constraints: > > * min: `1` > > * max: `2048` > > * pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` > createdAt -> (timestamp) [required] > > The time at which the agent was created. > updatedAt -> (timestamp) [required] > > The time at which the agent was last updated. > preparedAt -> (timestamp) > > The time at which the agent was last prepared. > failureReasons -> (list) > > Contains reasons that the agent-related API that you invoked failed. > > Constraints: > > * min: `0` > > * max: `2048` > > (string) > > > Constraints: > > > * min: `0` > > > * max: `2048` > recommendedActions -> (list) > > Contains recommended actions to take for the agent-related API that you invoked to succeed. > > Constraints: > > * min: `0` > > * max: `2048` > > (string) > > > Constraints: > > > * min: `0` > > > * max: `2048` > promptOverrideConfiguration -> (structure) > > Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html) . > > promptConfigurations -> (list) [required] > > > Contains configurations to override a prompt template in one part of an agent sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html) . > > > Constraints: > > > * min: `0` > > > * max: `10` > > > (structure) > > > > Contains configurations to override a prompt template in one part of an agent sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html) . > > > > promptType -> (string) > > > > > The step in the agent sequence that this prompt configuration applies to. > > > > > Possible values: > > > > > * `PRE_PROCESSING` > > > > > * `ORCHESTRATION` > > > > > * `POST_PROCESSING` > > > > > * `KNOWLEDGE_BASE_RESPONSE_GENERATION` > > > > > * `MEMORY_SUMMARIZATION` > > > > promptCreationMode -> (string) > > > > > Specifies whether to override the default prompt template for this `promptType` . Set this value to `OVERRIDDEN` to use the prompt that you provide in the `basePromptTemplate` . If you leave it as `DEFAULT` , the agent uses a default prompt template. > > > > > Possible values: > > > > > * `DEFAULT` > > > > > * `OVERRIDDEN` > > > > promptState -> (string) > > > > > Specifies whether to allow the agent to carry out the step specified in the `promptType` . If you set this value to `DISABLED` , the agent skips that step. The default state for each `promptType` is as follows. > > > > > * `PRE_PROCESSING` – `DISABLED` > > > > > * `ORCHESTRATION` – `ENABLED` > > > > > * `KNOWLEDGE_BASE_RESPONSE_GENERATION` – `ENABLED` > > > > > * `POST_PROCESSING` – `DISABLED` > > > > > Possible values: > > > > > * `ENABLED` > > > > > * `DISABLED` > > > > basePromptTemplate -> (string) > > > > > Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see [Prompt template placeholder variables](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html) . For more information, see [Configure the prompt templates](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts-configure.html) . > > > > > Constraints: > > > > > * min: `1` > > > > > * max: `100000` > > > > inferenceConfiguration -> (structure) > > > > > Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the `promptType` . For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html) . > > > > > temperature -> (float) > > > > > > The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options. > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `1` > > > > > topP -> (float) > > > > > > While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for `Top P` determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set `topP` to 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens. > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `1` > > > > > topK -> (integer) > > > > > > While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for `topK` is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set `topK` to 50, the model selects the next token from among the top 50 most likely choices. > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `500` > > > > > maximumLength -> (integer) > > > > > > The maximum number of tokens to allow in the generated response. > > > > > > Constraints: > > > > > > * min: `0` > > > > > stopSequences -> (list) > > > > > > A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response. > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `4` > > > > > > (string) > > > > parserMode -> (string) > > > > > Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the `promptType` . If you set the field as `OVERRIDDEN` , the `overrideLambda` field in the [PromptOverrideConfiguration](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) must be specified with the ARN of a Lambda function. > > > > > Possible values: > > > > > * `DEFAULT` > > > > > * `OVERRIDDEN` > > > > foundationModel -> (string) > > > > > The agent’s foundation model. > > > > > Constraints: > > > > > * min: `1` > > > > > * max: `2048` > > > > > * pattern: `(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?` > > > > additionalModelRequestFields -> (document) > > > > > If the Converse or ConverseStream operations support the model, `additionalModelRequestFields` contains additional inference parameters, beyond the base set of inference parameters in the `inferenceConfiguration` field. > > > > > For more information, see *Inference request parameters and response fields for foundation models* in the Amazon Bedrock user guide. > > overrideLambda -> (string) > > > The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the `promptConfigurations` must contain a `parserMode` value that is set to `OVERRIDDEN` . For more information, see [Parser Lambda function in Amazon Bedrock Agents](https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html) . > > > Constraints: > > > * min: `0` > > > * max: `2048` > > > * pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?` > guardrailConfiguration -> (structure) > > Details about the guardrail associated with the agent. > > guardrailIdentifier -> (string) > > > The unique identifier of the guardrail. > > > Constraints: > > > * min: `0` > > > * max: `2048` > > > * pattern: `(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))` > > guardrailVersion -> (string) > > > The version of the guardrail. > > > Constraints: > > > * pattern: `(([0-9]{1,8})|(DRAFT))` > memoryConfiguration -> (structure) > > Contains memory configuration for the agent. > > enabledMemoryTypes -> (list) [required] > > > The type of memory that is stored. > > > Constraints: > > > * min: `1` > > > * max: `1` > > > (string) > > > > Possible values: > > > > * `SESSION_SUMMARY` > > storageDays -> (integer) > > > The number of days the agent is configured to retain the conversational context. > > > Constraints: > > > * min: `0` > > > * max: `365` > > sessionSummaryConfiguration -> (structure) > > > Contains the configuration for SESSION_SUMMARY memory type enabled for the agent. > > > maxRecentSessions -> (integer) > > > > Maximum number of recent session summaries to include in the agent’s prompt context. > > > > Constraints: > > > > * min: `1` > agentCollaboration -> (string) > > The agent’s collaboration settings. > > Possible values: > > * `SUPERVISOR` > > * `SUPERVISOR_ROUTER` > > * `DISABLED`