Agent

bedrockagent.services.k8s.aws/v1alpha1

Type	Link
GoDoc	bedrockagent-controller/apis/v1alpha1#Agent

Metadata

Property	Value
Scope	Namespaced
Kind	`Agent`
ListKind	`AgentList`
Plural	`agents`
Singular	`agent`

Contains details about an agent.

Spec

agentCollaboration: string
agentName: string
agentResourceRoleARN: string
agentResourceRoleRef: 
  from: 
    name: string
    namespace: string
customOrchestration: 
  executor: 
    lambda: string
customerEncryptionKeyARN: string
description: string
foundationModel: string
guardrailConfiguration: 
  guardrailIdentifier: string
  guardrailVersion: string
idleSessionTTLInSeconds: integer
instruction: string
memoryConfiguration: 
  enabledMemoryTypes:
  - string
  sessionSummaryConfiguration: 
    maxRecentSessions: integer
  storageDays: integer
orchestrationType: string
promptOverrideConfiguration: 
  overrideLambda: string
  promptConfigurations:
  - basePromptTemplate: string
    foundationModel: string
    inferenceConfiguration: 
      maximumLength: integer
      stopSequences:
      - string
      temperature: number
      topK: integer
      topP: number
    parserMode: string
    promptCreationMode: string
    promptState: string
    promptType: string
tags: {}

Field	Description
agentCollaboration Optional	string The agent’s collaboration role.
agentName Required	string A name for the agent that you create.
agentResourceRoleARN Optional	string The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
agentResourceRoleRef Optional	object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: from: name: my-api
agentResourceRoleRef.from Optional	object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)
agentResourceRoleRef.from.name Optional	string
agentResourceRoleRef.from.namespace Optional	string
customOrchestration Optional	object Contains details of the custom orchestration configured for the agent.
customOrchestration.executor Optional	object Contains details about the Lambda function containing the orchestration logic carried out upon invoking the custom orchestration.
customOrchestration.executor.lambda Optional	string
customerEncryptionKeyARN Optional	string The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
description Optional	string A description of the agent.
foundationModel Optional	string The identifier for the model that you want to be used for orchestration by the agent you create. The modelId to provide depends on the type of model or throughput that you use: * If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) (https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns) in the Amazon Bedrock User Guide. * If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference (https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html) in the Amazon Bedrock User Guide. * If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html) in the Amazon Bedrock User Guide. * If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html) in the Amazon Bedrock User Guide. * If you use an imported model (https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html), specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html) or from the Imported models page in the Amazon Bedrock console.
guardrailConfiguration Optional	object The unique Guardrail configuration assigned to the agent when it is created.
guardrailConfiguration.guardrailIdentifier Optional	string
guardrailConfiguration.guardrailVersion Optional	string
idleSessionTTLInSeconds Optional	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 Optional	string Instructions that tell the agent what it should do and how it should interact with users.
memoryConfiguration Optional	object Contains the details of the memory configured for the agent.
memoryConfiguration.enabledMemoryTypes Optional	array
memoryConfiguration.enabledMemoryTypes.[] Required	string
memoryConfiguration.sessionSummaryConfiguration.maxRecentSessions Optional	integer
memoryConfiguration.storageDays Optional	integer
orchestrationType Optional	string Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
promptOverrideConfiguration Optional	object Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html).
promptOverrideConfiguration.overrideLambda Optional	string
promptOverrideConfiguration.promptConfigurations Optional	array
promptOverrideConfiguration.promptConfigurations.[] Required	object 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).
promptOverrideConfiguration.promptConfigurations.[].foundationModel Optional	string
promptOverrideConfiguration.promptConfigurations.[].inferenceConfiguration Optional	object 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).
promptOverrideConfiguration.promptConfigurations.[].inferenceConfiguration.maximumLength Optional	integer
promptOverrideConfiguration.promptConfigurations.[].inferenceConfiguration.stopSequences Optional	array
promptOverrideConfiguration.promptConfigurations.[].inferenceConfiguration.stopSequences.[] Required	string
promptOverrideConfiguration.promptConfigurations.[].inferenceConfiguration.topK Optional	integer
promptOverrideConfiguration.promptConfigurations.[].inferenceConfiguration.topP Optional	number
promptOverrideConfiguration.promptConfigurations.[].parserMode Optional	string
promptOverrideConfiguration.promptConfigurations.[].promptCreationMode Optional	string
promptOverrideConfiguration.promptConfigurations.[].promptState Optional	string
promptOverrideConfiguration.promptConfigurations.[].promptType Optional	string
tags Optional	object An object containing key-value pairs that define the tags to attach to the resource.

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
agentID: string
agentStatus: string
agentVersion: string
clientToken: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
createdAt: string
failureReasons:
- string
preparedAt: string
recommendedActions:
- string
updatedAt: string

Field	Description
ackResourceMetadata Optional	object All CRs managed by ACK have a common `Status.ACKResourceMetadata` member that is used to contain resource sync state, account ownership, constructed ARN for the resource
ackResourceMetadata.arn Optional	string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID Required	string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.
ackResourceMetadata.region Required	string Region is the AWS region in which the resource exists or will exist.
agentID Optional	string The unique identifier of the agent.
agentStatus Optional	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 Optional	string The version of the agent.
clientToken Optional	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).
conditions Optional	array All CRs managed by ACK have a common `Status.Conditions` member that contains a collection of `ackv1alpha1.Condition` objects that describe the various terminal states of the CR and its backend AWS service API resource
conditions.[] Required	object Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
conditions.[].message Optional	string A human readable message indicating details about the transition.
conditions.[].reason Optional	string The reason for the condition’s last transition.
conditions.[].status Optional	string Status of the condition, one of True, False, Unknown.
conditions.[].type Optional	string Type is the type of the Condition
createdAt Optional	string The time at which the agent was created.
failureReasons Optional	array Contains reasons that the agent-related API that you invoked failed.
failureReasons.[] Required	string
recommendedActions Optional	array Contains recommended actions to take for the agent-related API that you invoked to succeed.
recommendedActions.[] Required	string

Agent

Metadata#

Spec#

Status#

Metadata

Spec

Status