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 . bedrock-agent ]

get-agent

Description

Gets information about an agent.

See also: AWS API Documentation

Synopsis

  get-agent
--agent-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

--agent-id (string)

The unique identifier of the agent.

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

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

agent -> (structure)

Contains details about the agent.

agentArn -> (string)

The Amazon Resource Name (ARN) of the agent.

agentId -> (string)

The unique identifier of the agent.

agentName -> (string)

The name of the agent.

agentResourceRoleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

agentStatus -> (string)

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.

agentVersion -> (string)

The version of the agent.

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 .

createdAt -> (timestamp)

The time at which the agent was created.

customerEncryptionKeyArn -> (string)

The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.

description -> (string)

The description of the agent.

failureReasons -> (list)

Contains reasons that the agent-related API that you invoked failed.

(string)

foundationModel -> (string)

The foundation model used for orchestration by the agent.

guardrailConfiguration -> (structure)

Details about the guardrail associated with the agent.

guardrailIdentifier -> (string)

The unique identifier of the guardrail.

guardrailVersion -> (string)

The version of the guardrail.

idleSessionTTLInSeconds -> (integer)

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.

instruction -> (string)

Instructions that tell the agent what it should do and how it should interact with users.

memoryConfiguration -> (structure)

Contains memory configuration for the agent.

enabledMemoryTypes -> (list)

The type of memory that is stored.

(string)

storageDays -> (integer)

The number of days the agent is configured to retain the conversational context.

preparedAt -> (timestamp)

The time at which the agent was last prepared.

promptOverrideConfiguration -> (structure)

Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts .

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 .

promptConfigurations -> (list)

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts .

(structure)

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts .

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 . For more information, see Configure the prompt templates .

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 .

maximumLength -> (integer)

The maximum number of tokens to allow in the generated response.

stopSequences -> (list)

A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

(string)

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.

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.

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 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.

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 OVERRIDEN , the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.

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.

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 – ENABLED
  • ORCHESTRATION – ENABLED
  • KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
  • POST_PROCESSING – DISABLED

promptType -> (string)

The step in the agent sequence that this prompt configuration applies to.

recommendedActions -> (list)

Contains recommended actions to take for the agent-related API that you invoked to succeed.

(string)

updatedAt -> (timestamp)

The time at which the agent was last updated.