We recommend new projects start with resources from the AWS provider.
aws-native.bedrock.Agent
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Definition of AWS::Bedrock::Agent Resource Type
Create Agent Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Agent(name: string, args?: AgentArgs, opts?: CustomResourceOptions);@overload
def Agent(resource_name: str,
          args: Optional[AgentArgs] = None,
          opts: Optional[ResourceOptions] = None)
@overload
def Agent(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          action_groups: Optional[Sequence[AgentActionGroupArgs]] = None,
          agent_collaboration: Optional[AgentCollaboration] = None,
          agent_collaborators: Optional[Sequence[AgentCollaboratorArgs]] = None,
          agent_name: Optional[str] = None,
          agent_resource_role_arn: Optional[str] = None,
          auto_prepare: Optional[bool] = None,
          custom_orchestration: Optional[AgentCustomOrchestrationArgs] = None,
          customer_encryption_key_arn: Optional[str] = None,
          description: Optional[str] = None,
          foundation_model: Optional[str] = None,
          guardrail_configuration: Optional[AgentGuardrailConfigurationArgs] = None,
          idle_session_ttl_in_seconds: Optional[float] = None,
          instruction: Optional[str] = None,
          knowledge_bases: Optional[Sequence[AgentKnowledgeBaseArgs]] = None,
          memory_configuration: Optional[AgentMemoryConfigurationArgs] = None,
          orchestration_type: Optional[AgentOrchestrationType] = None,
          prompt_override_configuration: Optional[AgentPromptOverrideConfigurationArgs] = None,
          skip_resource_in_use_check_on_delete: Optional[bool] = None,
          tags: Optional[Mapping[str, str]] = None,
          test_alias_tags: Optional[Mapping[str, str]] = None)func NewAgent(ctx *Context, name string, args *AgentArgs, opts ...ResourceOption) (*Agent, error)public Agent(string name, AgentArgs? args = null, CustomResourceOptions? opts = null)type: aws-native:bedrock:Agent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AgentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AgentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AgentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AgentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AgentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Agent Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Agent resource accepts the following input properties:
- ActionGroups List<Pulumi.Aws Native. Bedrock. Inputs. Agent Action Group> 
- List of ActionGroups
- AgentCollaboration Pulumi.Aws Native. Bedrock. Agent Collaboration 
- The agent's collaboration settings.
- AgentCollaborators List<Pulumi.Aws Native. Bedrock. Inputs. Agent Collaborator> 
- List of Agent Collaborators
- AgentName string
- Name for a resource.
- AgentResource stringRole Arn 
- ARN of a IAM role.
- AutoPrepare bool
- Specifies whether to automatically prepare after creating or updating the agent.
- CustomOrchestration Pulumi.Aws Native. Bedrock. Inputs. Agent Custom Orchestration 
- Contains custom orchestration configurations for the agent.
- CustomerEncryption stringKey Arn 
- A KMS key ARN
- Description string
- Description of the Resource.
- FoundationModel string
- The foundation model used for orchestration by the agent.
- GuardrailConfiguration Pulumi.Aws Native. Bedrock. Inputs. Agent Guardrail Configuration 
- Details about the guardrail associated with the agent.
- IdleSession doubleTtl In Seconds 
- Max Session Time.
- Instruction string
- Instruction for the agent.
- KnowledgeBases List<Pulumi.Aws Native. Bedrock. Inputs. Agent Knowledge Base> 
- List of Agent Knowledge Bases
- MemoryConfiguration Pulumi.Aws Native. Bedrock. Inputs. Agent Memory Configuration 
- Contains memory configuration for the agent.
- OrchestrationType Pulumi.Aws Native. Bedrock. Agent Orchestration Type 
- Specifies the orchestration strategy for the agent.
- PromptOverride Pulumi.Configuration Aws Native. Bedrock. Inputs. Agent Prompt Override Configuration 
- Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts .
- SkipResource boolIn Use Check On Delete 
- Specifies whether to allow deleting agent while it is in use.
- Dictionary<string, string>
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- Dictionary<string, string>
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- ActionGroups []AgentAction Group Args 
- List of ActionGroups
- AgentCollaboration AgentCollaboration 
- The agent's collaboration settings.
- AgentCollaborators []AgentCollaborator Args 
- List of Agent Collaborators
- AgentName string
- Name for a resource.
- AgentResource stringRole Arn 
- ARN of a IAM role.
- AutoPrepare bool
- Specifies whether to automatically prepare after creating or updating the agent.
- CustomOrchestration AgentCustom Orchestration Args 
- Contains custom orchestration configurations for the agent.
- CustomerEncryption stringKey Arn 
- A KMS key ARN
- Description string
- Description of the Resource.
- FoundationModel string
- The foundation model used for orchestration by the agent.
- GuardrailConfiguration AgentGuardrail Configuration Args 
- Details about the guardrail associated with the agent.
- IdleSession float64Ttl In Seconds 
- Max Session Time.
- Instruction string
- Instruction for the agent.
- KnowledgeBases []AgentKnowledge Base Args 
- List of Agent Knowledge Bases
- MemoryConfiguration AgentMemory Configuration Args 
- Contains memory configuration for the agent.
- OrchestrationType AgentOrchestration Type 
- Specifies the orchestration strategy for the agent.
- PromptOverride AgentConfiguration Prompt Override Configuration Args 
- Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts .
- SkipResource boolIn Use Check On Delete 
- Specifies whether to allow deleting agent while it is in use.
- map[string]string
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- map[string]string
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- actionGroups List<AgentAction Group> 
- List of ActionGroups
- agentCollaboration AgentCollaboration 
- The agent's collaboration settings.
- agentCollaborators List<AgentCollaborator> 
- List of Agent Collaborators
- agentName String
- Name for a resource.
- agentResource StringRole Arn 
- ARN of a IAM role.
- autoPrepare Boolean
- Specifies whether to automatically prepare after creating or updating the agent.
- customOrchestration AgentCustom Orchestration 
- Contains custom orchestration configurations for the agent.
- customerEncryption StringKey Arn 
- A KMS key ARN
- description String
- Description of the Resource.
- foundationModel String
- The foundation model used for orchestration by the agent.
- guardrailConfiguration AgentGuardrail Configuration 
- Details about the guardrail associated with the agent.
- idleSession DoubleTtl In Seconds 
- Max Session Time.
- instruction String
- Instruction for the agent.
- knowledgeBases List<AgentKnowledge Base> 
- List of Agent Knowledge Bases
- memoryConfiguration AgentMemory Configuration 
- Contains memory configuration for the agent.
- orchestrationType AgentOrchestration Type 
- Specifies the orchestration strategy for the agent.
- promptOverride AgentConfiguration Prompt Override Configuration 
- Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts .
- skipResource BooleanIn Use Check On Delete 
- Specifies whether to allow deleting agent while it is in use.
- Map<String,String>
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- Map<String,String>
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- actionGroups AgentAction Group[] 
- List of ActionGroups
- agentCollaboration AgentCollaboration 
- The agent's collaboration settings.
- agentCollaborators AgentCollaborator[] 
- List of Agent Collaborators
- agentName string
- Name for a resource.
- agentResource stringRole Arn 
- ARN of a IAM role.
- autoPrepare boolean
- Specifies whether to automatically prepare after creating or updating the agent.
- customOrchestration AgentCustom Orchestration 
- Contains custom orchestration configurations for the agent.
- customerEncryption stringKey Arn 
- A KMS key ARN
- description string
- Description of the Resource.
- foundationModel string
- The foundation model used for orchestration by the agent.
- guardrailConfiguration AgentGuardrail Configuration 
- Details about the guardrail associated with the agent.
- idleSession numberTtl In Seconds 
- Max Session Time.
- instruction string
- Instruction for the agent.
- knowledgeBases AgentKnowledge Base[] 
- List of Agent Knowledge Bases
- memoryConfiguration AgentMemory Configuration 
- Contains memory configuration for the agent.
- orchestrationType AgentOrchestration Type 
- Specifies the orchestration strategy for the agent.
- promptOverride AgentConfiguration Prompt Override Configuration 
- Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts .
- skipResource booleanIn Use Check On Delete 
- Specifies whether to allow deleting agent while it is in use.
- {[key: string]: string}
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- {[key: string]: string}
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- action_groups Sequence[AgentAction Group Args] 
- List of ActionGroups
- agent_collaboration AgentCollaboration 
- The agent's collaboration settings.
- agent_collaborators Sequence[AgentCollaborator Args] 
- List of Agent Collaborators
- agent_name str
- Name for a resource.
- agent_resource_ strrole_ arn 
- ARN of a IAM role.
- auto_prepare bool
- Specifies whether to automatically prepare after creating or updating the agent.
- custom_orchestration AgentCustom Orchestration Args 
- Contains custom orchestration configurations for the agent.
- customer_encryption_ strkey_ arn 
- A KMS key ARN
- description str
- Description of the Resource.
- foundation_model str
- The foundation model used for orchestration by the agent.
- guardrail_configuration AgentGuardrail Configuration Args 
- Details about the guardrail associated with the agent.
- idle_session_ floatttl_ in_ seconds 
- Max Session Time.
- instruction str
- Instruction for the agent.
- knowledge_bases Sequence[AgentKnowledge Base Args] 
- List of Agent Knowledge Bases
- memory_configuration AgentMemory Configuration Args 
- Contains memory configuration for the agent.
- orchestration_type AgentOrchestration Type 
- Specifies the orchestration strategy for the agent.
- prompt_override_ Agentconfiguration Prompt Override Configuration Args 
- Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts .
- skip_resource_ boolin_ use_ check_ on_ delete 
- Specifies whether to allow deleting agent while it is in use.
- Mapping[str, str]
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- Mapping[str, str]
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- actionGroups List<Property Map>
- List of ActionGroups
- agentCollaboration "DISABLED" | "SUPERVISOR" | "SUPERVISOR_ROUTER"
- The agent's collaboration settings.
- agentCollaborators List<Property Map>
- List of Agent Collaborators
- agentName String
- Name for a resource.
- agentResource StringRole Arn 
- ARN of a IAM role.
- autoPrepare Boolean
- Specifies whether to automatically prepare after creating or updating the agent.
- customOrchestration Property Map
- Contains custom orchestration configurations for the agent.
- customerEncryption StringKey Arn 
- A KMS key ARN
- description String
- Description of the Resource.
- foundationModel String
- The foundation model used for orchestration by the agent.
- guardrailConfiguration Property Map
- Details about the guardrail associated with the agent.
- idleSession NumberTtl In Seconds 
- Max Session Time.
- instruction String
- Instruction for the agent.
- knowledgeBases List<Property Map>
- List of Agent Knowledge Bases
- memoryConfiguration Property Map
- Contains memory configuration for the agent.
- orchestrationType "DEFAULT" | "CUSTOM_ORCHESTRATION"
- Specifies the orchestration strategy for the agent.
- promptOverride Property MapConfiguration 
- Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts .
- skipResource BooleanIn Use Check On Delete 
- Specifies whether to allow deleting agent while it is in use.
- Map<String>
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- Map<String>
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
Outputs
All input properties are implicitly available as output properties. Additionally, the Agent resource produces the following output properties:
- AgentArn string
- Arn representation of the Agent.
- AgentId string
- Identifier for a resource.
- AgentStatus Pulumi.Aws Native. Bedrock. Agent Status 
- 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
- Draft Agent Version.
- CreatedAt string
- Time Stamp.
- FailureReasons List<string>
- Failure Reasons for Error.
- Id string
- The provider-assigned unique ID for this managed resource.
- PreparedAt string
- Time Stamp.
- RecommendedActions List<string>
- The recommended actions users can take to resolve an error in failureReasons.
- UpdatedAt string
- Time Stamp.
- AgentArn string
- Arn representation of the Agent.
- AgentId string
- Identifier for a resource.
- AgentStatus AgentStatus 
- 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
- Draft Agent Version.
- CreatedAt string
- Time Stamp.
- FailureReasons []string
- Failure Reasons for Error.
- Id string
- The provider-assigned unique ID for this managed resource.
- PreparedAt string
- Time Stamp.
- RecommendedActions []string
- The recommended actions users can take to resolve an error in failureReasons.
- UpdatedAt string
- Time Stamp.
- agentArn String
- Arn representation of the Agent.
- agentId String
- Identifier for a resource.
- agentStatus AgentStatus 
- 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
- Draft Agent Version.
- createdAt String
- Time Stamp.
- failureReasons List<String>
- Failure Reasons for Error.
- id String
- The provider-assigned unique ID for this managed resource.
- preparedAt String
- Time Stamp.
- recommendedActions List<String>
- The recommended actions users can take to resolve an error in failureReasons.
- updatedAt String
- Time Stamp.
- agentArn string
- Arn representation of the Agent.
- agentId string
- Identifier for a resource.
- agentStatus AgentStatus 
- 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
- Draft Agent Version.
- createdAt string
- Time Stamp.
- failureReasons string[]
- Failure Reasons for Error.
- id string
- The provider-assigned unique ID for this managed resource.
- preparedAt string
- Time Stamp.
- recommendedActions string[]
- The recommended actions users can take to resolve an error in failureReasons.
- updatedAt string
- Time Stamp.
- agent_arn str
- Arn representation of the Agent.
- agent_id str
- Identifier for a resource.
- agent_status AgentStatus 
- 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.
 
- agent_version str
- Draft Agent Version.
- created_at str
- Time Stamp.
- failure_reasons Sequence[str]
- Failure Reasons for Error.
- id str
- The provider-assigned unique ID for this managed resource.
- prepared_at str
- Time Stamp.
- recommended_actions Sequence[str]
- The recommended actions users can take to resolve an error in failureReasons.
- updated_at str
- Time Stamp.
- agentArn String
- Arn representation of the Agent.
- agentId String
- Identifier for a resource.
- agentStatus "CREATING" | "PREPARING" | "PREPARED" | "NOT_PREPARED" | "DELETING" | "FAILED" | "VERSIONING" | "UPDATING"
- 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
- Draft Agent Version.
- createdAt String
- Time Stamp.
- failureReasons List<String>
- Failure Reasons for Error.
- id String
- The provider-assigned unique ID for this managed resource.
- preparedAt String
- Time Stamp.
- recommendedActions List<String>
- The recommended actions users can take to resolve an error in failureReasons.
- updatedAt String
- Time Stamp.
Supporting Types
AgentActionGroup, AgentActionGroupArgs      
- ActionGroup stringName 
- Name of the action group
- ActionGroup Pulumi.Executor Aws | Pulumi.Native. Bedrock. Inputs. Agent Action Group Executor0Properties Aws Native. Bedrock. Inputs. Agent Action Group Executor1Properties 
- The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
- ActionGroup Pulumi.State Aws Native. Bedrock. Agent Action Group State 
- Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
- ApiSchema Pulumi.Aws | Pulumi.Native. Bedrock. Inputs. Agent Api Schema0Properties Aws Native. Bedrock. Inputs. Agent Api Schema1Properties 
- Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas .
- Description string
- Description of action group
- FunctionSchema Pulumi.Aws Native. Bedrock. Inputs. Agent Function Schema 
- Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
- ParentAction Pulumi.Group Signature Aws Native. Bedrock. Agent Action Group Signature 
- If this field is set as - AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The- description,- apiSchema, and- actionGroupExecutorfields must be blank for this action group.- During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information. 
- SkipResource boolIn Use Check On Delete 
- Specifies whether to allow deleting action group while it is in use.
- ActionGroup stringName 
- Name of the action group
- ActionGroup AgentExecutor Action | AgentGroup Executor0Properties Action Group Executor1Properties 
- The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
- ActionGroup AgentState Action Group State 
- Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
- ApiSchema AgentApi | AgentSchema0Properties Api Schema1Properties 
- Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas .
- Description string
- Description of action group
- FunctionSchema AgentFunction Schema 
- Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
- ParentAction AgentGroup Signature Action Group Signature 
- If this field is set as - AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The- description,- apiSchema, and- actionGroupExecutorfields must be blank for this action group.- During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information. 
- SkipResource boolIn Use Check On Delete 
- Specifies whether to allow deleting action group while it is in use.
- actionGroup StringName 
- Name of the action group
- actionGroup AgentExecutor Action | AgentGroup Executor0Properties Action Group Executor1Properties 
- The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
- actionGroup AgentState Action Group State 
- Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
- apiSchema AgentApi | AgentSchema0Properties Api Schema1Properties 
- Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas .
- description String
- Description of action group
- functionSchema AgentFunction Schema 
- Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
- parentAction AgentGroup Signature Action Group Signature 
- If this field is set as - AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The- description,- apiSchema, and- actionGroupExecutorfields must be blank for this action group.- During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information. 
- skipResource BooleanIn Use Check On Delete 
- Specifies whether to allow deleting action group while it is in use.
- actionGroup stringName 
- Name of the action group
- actionGroup AgentExecutor Action | AgentGroup Executor0Properties Action Group Executor1Properties 
- The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
- actionGroup AgentState Action Group State 
- Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
- apiSchema AgentApi | AgentSchema0Properties Api Schema1Properties 
- Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas .
- description string
- Description of action group
- functionSchema AgentFunction Schema 
- Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
- parentAction AgentGroup Signature Action Group Signature 
- If this field is set as - AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The- description,- apiSchema, and- actionGroupExecutorfields must be blank for this action group.- During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information. 
- skipResource booleanIn Use Check On Delete 
- Specifies whether to allow deleting action group while it is in use.
- action_group_ strname 
- Name of the action group
- action_group_ Agentexecutor Action | AgentGroup Executor0Properties Action Group Executor1Properties 
- The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
- action_group_ Agentstate Action Group State 
- Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
- api_schema AgentApi | AgentSchema0Properties Api Schema1Properties 
- Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas .
- description str
- Description of action group
- function_schema AgentFunction Schema 
- Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
- parent_action_ Agentgroup_ signature Action Group Signature 
- If this field is set as - AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The- description,- apiSchema, and- actionGroupExecutorfields must be blank for this action group.- During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information. 
- skip_resource_ boolin_ use_ check_ on_ delete 
- Specifies whether to allow deleting action group while it is in use.
- actionGroup StringName 
- Name of the action group
- actionGroup Property Map | Property MapExecutor 
- The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
- actionGroup "ENABLED" | "DISABLED"State 
- Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
- apiSchema Property Map | Property Map
- Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas .
- description String
- Description of action group
- functionSchema Property Map
- Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
- parentAction "AMAZON.Group Signature User Input" | "AMAZON. Code Interpreter" 
- If this field is set as - AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The- description,- apiSchema, and- actionGroupExecutorfields must be blank for this action group.- During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information. 
- skipResource BooleanIn Use Check On Delete 
- Specifies whether to allow deleting action group while it is in use.
AgentActionGroupExecutor0Properties, AgentActionGroupExecutor0PropertiesArgs        
- Lambda string
- ARN of a Lambda.
- Lambda string
- ARN of a Lambda.
- lambda String
- ARN of a Lambda.
- lambda string
- ARN of a Lambda.
- lambda_ str
- ARN of a Lambda.
- lambda String
- ARN of a Lambda.
AgentActionGroupExecutor1Properties, AgentActionGroupExecutor1PropertiesArgs        
AgentActionGroupSignature, AgentActionGroupSignatureArgs        
- AmazonUser Input 
- AMAZON.UserInput
- AmazonCode Interpreter 
- AMAZON.CodeInterpreter
- AgentAction Group Signature Amazon User Input 
- AMAZON.UserInput
- AgentAction Group Signature Amazon Code Interpreter 
- AMAZON.CodeInterpreter
- AmazonUser Input 
- AMAZON.UserInput
- AmazonCode Interpreter 
- AMAZON.CodeInterpreter
- AmazonUser Input 
- AMAZON.UserInput
- AmazonCode Interpreter 
- AMAZON.CodeInterpreter
- AMAZON_USER_INPUT
- AMAZON.UserInput
- AMAZON_CODE_INTERPRETER
- AMAZON.CodeInterpreter
- "AMAZON.User Input" 
- AMAZON.UserInput
- "AMAZON.Code Interpreter" 
- AMAZON.CodeInterpreter
AgentActionGroupState, AgentActionGroupStateArgs        
- Enabled
- ENABLED
- Disabled
- DISABLED
- AgentAction Group State Enabled 
- ENABLED
- AgentAction Group State Disabled 
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- ENABLED
- ENABLED
- DISABLED
- DISABLED
- "ENABLED"
- ENABLED
- "DISABLED"
- DISABLED
AgentApiSchema0Properties, AgentApiSchema0PropertiesArgs      
AgentApiSchema1Properties, AgentApiSchema1PropertiesArgs      
- Payload string
- String OpenAPI Payload
- Payload string
- String OpenAPI Payload
- payload String
- String OpenAPI Payload
- payload string
- String OpenAPI Payload
- payload str
- String OpenAPI Payload
- payload String
- String OpenAPI Payload
AgentCollaboration, AgentCollaborationArgs    
- Disabled
- DISABLED
- Supervisor
- SUPERVISOR
- SupervisorRouter 
- SUPERVISOR_ROUTER
- AgentCollaboration Disabled 
- DISABLED
- AgentCollaboration Supervisor 
- SUPERVISOR
- AgentCollaboration Supervisor Router 
- SUPERVISOR_ROUTER
- Disabled
- DISABLED
- Supervisor
- SUPERVISOR
- SupervisorRouter 
- SUPERVISOR_ROUTER
- Disabled
- DISABLED
- Supervisor
- SUPERVISOR
- SupervisorRouter 
- SUPERVISOR_ROUTER
- DISABLED
- DISABLED
- SUPERVISOR
- SUPERVISOR
- SUPERVISOR_ROUTER
- SUPERVISOR_ROUTER
- "DISABLED"
- DISABLED
- "SUPERVISOR"
- SUPERVISOR
- "SUPERVISOR_ROUTER"
- SUPERVISOR_ROUTER
AgentCollaborator, AgentCollaboratorArgs    
- AgentDescriptor Pulumi.Aws Native. Bedrock. Inputs. Agent Collaborator Agent Descriptor Properties 
- Agent descriptor for agent collaborator
- CollaborationInstruction string
- Agent collaborator instruction
- CollaboratorName string
- Agent collaborator name
- RelayConversation Pulumi.History Aws Native. Bedrock. Agent Relay Conversation History 
- The collaborator's relay conversation history.
- AgentDescriptor AgentCollaborator Agent Descriptor Properties 
- Agent descriptor for agent collaborator
- CollaborationInstruction string
- Agent collaborator instruction
- CollaboratorName string
- Agent collaborator name
- RelayConversation AgentHistory Relay Conversation History 
- The collaborator's relay conversation history.
- agentDescriptor AgentCollaborator Agent Descriptor Properties 
- Agent descriptor for agent collaborator
- collaborationInstruction String
- Agent collaborator instruction
- collaboratorName String
- Agent collaborator name
- relayConversation AgentHistory Relay Conversation History 
- The collaborator's relay conversation history.
- agentDescriptor AgentCollaborator Agent Descriptor Properties 
- Agent descriptor for agent collaborator
- collaborationInstruction string
- Agent collaborator instruction
- collaboratorName string
- Agent collaborator name
- relayConversation AgentHistory Relay Conversation History 
- The collaborator's relay conversation history.
- agent_descriptor AgentCollaborator Agent Descriptor Properties 
- Agent descriptor for agent collaborator
- collaboration_instruction str
- Agent collaborator instruction
- collaborator_name str
- Agent collaborator name
- relay_conversation_ Agenthistory Relay Conversation History 
- The collaborator's relay conversation history.
- agentDescriptor Property Map
- Agent descriptor for agent collaborator
- collaborationInstruction String
- Agent collaborator instruction
- collaboratorName String
- Agent collaborator name
- relayConversation "TO_COLLABORATOR" | "DISABLED"History 
- The collaborator's relay conversation history.
AgentCollaboratorAgentDescriptorProperties, AgentCollaboratorAgentDescriptorPropertiesArgs          
- AliasArn string
- Alias ARN for agent descriptor
- AliasArn string
- Alias ARN for agent descriptor
- aliasArn String
- Alias ARN for agent descriptor
- aliasArn string
- Alias ARN for agent descriptor
- alias_arn str
- Alias ARN for agent descriptor
- aliasArn String
- Alias ARN for agent descriptor
AgentCreationMode, AgentCreationModeArgs      
- Default
- DEFAULT
- Overridden
- OVERRIDDEN
- AgentCreation Mode Default 
- DEFAULT
- AgentCreation Mode Overridden 
- OVERRIDDEN
- Default
- DEFAULT
- Overridden
- OVERRIDDEN
- Default
- DEFAULT
- Overridden
- OVERRIDDEN
- DEFAULT
- DEFAULT
- OVERRIDDEN
- OVERRIDDEN
- "DEFAULT"
- DEFAULT
- "OVERRIDDEN"
- OVERRIDDEN
AgentCustomControlMethod, AgentCustomControlMethodArgs        
- ReturnControl 
- RETURN_CONTROL
- AgentCustom Control Method Return Control 
- RETURN_CONTROL
- ReturnControl 
- RETURN_CONTROL
- ReturnControl 
- RETURN_CONTROL
- RETURN_CONTROL
- RETURN_CONTROL
- "RETURN_CONTROL"
- RETURN_CONTROL
AgentCustomOrchestration, AgentCustomOrchestrationArgs      
- Executor
Pulumi.Aws Native. Bedrock. Inputs. Agent Orchestration Executor 
- The structure of the executor invoking the actions in custom orchestration.
- Executor
AgentOrchestration Executor 
- The structure of the executor invoking the actions in custom orchestration.
- executor
AgentOrchestration Executor 
- The structure of the executor invoking the actions in custom orchestration.
- executor
AgentOrchestration Executor 
- The structure of the executor invoking the actions in custom orchestration.
- executor
AgentOrchestration Executor 
- The structure of the executor invoking the actions in custom orchestration.
- executor Property Map
- The structure of the executor invoking the actions in custom orchestration.
AgentFunction, AgentFunctionArgs    
- Name string
- Name for a resource.
- Description string
- Description of function
- Parameters
Dictionary<string, Pulumi.Aws Native. Bedrock. Inputs. Agent Parameter Detail> 
- The parameters that the agent elicits from the user to fulfill the function.
- RequireConfirmation Pulumi.Aws Native. Bedrock. Agent Require Confirmation 
- Contains information if user confirmation is required to invoke the function.
- Name string
- Name for a resource.
- Description string
- Description of function
- Parameters
map[string]AgentParameter Detail 
- The parameters that the agent elicits from the user to fulfill the function.
- RequireConfirmation AgentRequire Confirmation 
- Contains information if user confirmation is required to invoke the function.
- name String
- Name for a resource.
- description String
- Description of function
- parameters
Map<String,AgentParameter Detail> 
- The parameters that the agent elicits from the user to fulfill the function.
- requireConfirmation AgentRequire Confirmation 
- Contains information if user confirmation is required to invoke the function.
- name string
- Name for a resource.
- description string
- Description of function
- parameters
{[key: string]: AgentParameter Detail} 
- The parameters that the agent elicits from the user to fulfill the function.
- requireConfirmation AgentRequire Confirmation 
- Contains information if user confirmation is required to invoke the function.
- name str
- Name for a resource.
- description str
- Description of function
- parameters
Mapping[str, AgentParameter Detail] 
- The parameters that the agent elicits from the user to fulfill the function.
- require_confirmation AgentRequire Confirmation 
- Contains information if user confirmation is required to invoke the function.
- name String
- Name for a resource.
- description String
- Description of function
- parameters Map<Property Map>
- The parameters that the agent elicits from the user to fulfill the function.
- requireConfirmation "ENABLED" | "DISABLED"
- Contains information if user confirmation is required to invoke the function.
AgentFunctionSchema, AgentFunctionSchemaArgs      
- Functions
List<Pulumi.Aws Native. Bedrock. Inputs. Agent Function> 
- List of Function definitions
- Functions
[]AgentFunction 
- List of Function definitions
- functions
List<AgentFunction> 
- List of Function definitions
- functions
AgentFunction[] 
- List of Function definitions
- functions
Sequence[AgentFunction] 
- List of Function definitions
- functions List<Property Map>
- List of Function definitions
AgentGuardrailConfiguration, AgentGuardrailConfigurationArgs      
- GuardrailIdentifier string
- Identifier for the guardrail, could be the id or the arn
- GuardrailVersion string
- Version of the guardrail
- GuardrailIdentifier string
- Identifier for the guardrail, could be the id or the arn
- GuardrailVersion string
- Version of the guardrail
- guardrailIdentifier String
- Identifier for the guardrail, could be the id or the arn
- guardrailVersion String
- Version of the guardrail
- guardrailIdentifier string
- Identifier for the guardrail, could be the id or the arn
- guardrailVersion string
- Version of the guardrail
- guardrail_identifier str
- Identifier for the guardrail, could be the id or the arn
- guardrail_version str
- Version of the guardrail
- guardrailIdentifier String
- Identifier for the guardrail, could be the id or the arn
- guardrailVersion String
- Version of the guardrail
AgentInferenceConfiguration, AgentInferenceConfigurationArgs      
- MaximumLength double
- Maximum length of output
- StopSequences List<string>
- List of stop sequences
- Temperature double
- Controls randomness, higher values increase diversity
- TopK double
- Sample from the k most likely next tokens
- TopP double
- Cumulative probability cutoff for token selection
- MaximumLength float64
- Maximum length of output
- StopSequences []string
- List of stop sequences
- Temperature float64
- Controls randomness, higher values increase diversity
- TopK float64
- Sample from the k most likely next tokens
- TopP float64
- Cumulative probability cutoff for token selection
- maximumLength Double
- Maximum length of output
- stopSequences List<String>
- List of stop sequences
- temperature Double
- Controls randomness, higher values increase diversity
- topK Double
- Sample from the k most likely next tokens
- topP Double
- Cumulative probability cutoff for token selection
- maximumLength number
- Maximum length of output
- stopSequences string[]
- List of stop sequences
- temperature number
- Controls randomness, higher values increase diversity
- topK number
- Sample from the k most likely next tokens
- topP number
- Cumulative probability cutoff for token selection
- maximum_length float
- Maximum length of output
- stop_sequences Sequence[str]
- List of stop sequences
- temperature float
- Controls randomness, higher values increase diversity
- top_k float
- Sample from the k most likely next tokens
- top_p float
- Cumulative probability cutoff for token selection
- maximumLength Number
- Maximum length of output
- stopSequences List<String>
- List of stop sequences
- temperature Number
- Controls randomness, higher values increase diversity
- topK Number
- Sample from the k most likely next tokens
- topP Number
- Cumulative probability cutoff for token selection
AgentKnowledgeBase, AgentKnowledgeBaseArgs      
- Description string
- Description of the Resource.
- KnowledgeBase stringId 
- Identifier for a resource.
- KnowledgeBase Pulumi.State Aws Native. Bedrock. Agent Knowledge Base State 
- Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
- Description string
- Description of the Resource.
- KnowledgeBase stringId 
- Identifier for a resource.
- KnowledgeBase AgentState Knowledge Base State 
- Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
- description String
- Description of the Resource.
- knowledgeBase StringId 
- Identifier for a resource.
- knowledgeBase AgentState Knowledge Base State 
- Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
- description string
- Description of the Resource.
- knowledgeBase stringId 
- Identifier for a resource.
- knowledgeBase AgentState Knowledge Base State 
- Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
- description str
- Description of the Resource.
- knowledge_base_ strid 
- Identifier for a resource.
- knowledge_base_ Agentstate Knowledge Base State 
- Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
- description String
- Description of the Resource.
- knowledgeBase StringId 
- Identifier for a resource.
- knowledgeBase "ENABLED" | "DISABLED"State 
- Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
AgentKnowledgeBaseState, AgentKnowledgeBaseStateArgs        
- Enabled
- ENABLED
- Disabled
- DISABLED
- AgentKnowledge Base State Enabled 
- ENABLED
- AgentKnowledge Base State Disabled 
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- ENABLED
- ENABLED
- DISABLED
- DISABLED
- "ENABLED"
- ENABLED
- "DISABLED"
- DISABLED
AgentMemoryConfiguration, AgentMemoryConfigurationArgs      
- EnabledMemory List<Pulumi.Types Aws Native. Bedrock. Agent Memory Type> 
- The type of memory that is stored.
- SessionSummary Pulumi.Configuration Aws Native. Bedrock. Inputs. Agent Session Summary Configuration 
- Contains the configuration for SESSION_SUMMARY memory type enabled for the agent.
- StorageDays double
- Maximum number of days to store session details
- EnabledMemory []AgentTypes Memory Type 
- The type of memory that is stored.
- SessionSummary AgentConfiguration Session Summary Configuration 
- Contains the configuration for SESSION_SUMMARY memory type enabled for the agent.
- StorageDays float64
- Maximum number of days to store session details
- enabledMemory List<AgentTypes Memory Type> 
- The type of memory that is stored.
- sessionSummary AgentConfiguration Session Summary Configuration 
- Contains the configuration for SESSION_SUMMARY memory type enabled for the agent.
- storageDays Double
- Maximum number of days to store session details
- enabledMemory AgentTypes Memory Type[] 
- The type of memory that is stored.
- sessionSummary AgentConfiguration Session Summary Configuration 
- Contains the configuration for SESSION_SUMMARY memory type enabled for the agent.
- storageDays number
- Maximum number of days to store session details
- enabled_memory_ Sequence[Agenttypes Memory Type] 
- The type of memory that is stored.
- session_summary_ Agentconfiguration Session Summary Configuration 
- Contains the configuration for SESSION_SUMMARY memory type enabled for the agent.
- storage_days float
- Maximum number of days to store session details
- enabledMemory List<"SESSION_SUMMARY">Types 
- The type of memory that is stored.
- sessionSummary Property MapConfiguration 
- Contains the configuration for SESSION_SUMMARY memory type enabled for the agent.
- storageDays Number
- Maximum number of days to store session details
AgentMemoryType, AgentMemoryTypeArgs      
- SessionSummary 
- SESSION_SUMMARY
- AgentMemory Type Session Summary 
- SESSION_SUMMARY
- SessionSummary 
- SESSION_SUMMARY
- SessionSummary 
- SESSION_SUMMARY
- SESSION_SUMMARY
- SESSION_SUMMARY
- "SESSION_SUMMARY"
- SESSION_SUMMARY
AgentOrchestrationExecutor, AgentOrchestrationExecutorArgs      
- Lambda string
- ARN of a Lambda.
- Lambda string
- ARN of a Lambda.
- lambda String
- ARN of a Lambda.
- lambda string
- ARN of a Lambda.
- lambda_ str
- ARN of a Lambda.
- lambda String
- ARN of a Lambda.
AgentOrchestrationType, AgentOrchestrationTypeArgs      
- Default
- DEFAULT
- CustomOrchestration 
- CUSTOM_ORCHESTRATION
- AgentOrchestration Type Default 
- DEFAULT
- AgentOrchestration Type Custom Orchestration 
- CUSTOM_ORCHESTRATION
- Default
- DEFAULT
- CustomOrchestration 
- CUSTOM_ORCHESTRATION
- Default
- DEFAULT
- CustomOrchestration 
- CUSTOM_ORCHESTRATION
- DEFAULT
- DEFAULT
- CUSTOM_ORCHESTRATION
- CUSTOM_ORCHESTRATION
- "DEFAULT"
- DEFAULT
- "CUSTOM_ORCHESTRATION"
- CUSTOM_ORCHESTRATION
AgentParameterDetail, AgentParameterDetailArgs      
- Type
Pulumi.Aws Native. Bedrock. Agent Type 
- The data type of the parameter.
- Description string
- Description of function parameter.
- Required bool
- Information about if a parameter is required for function call. Default to false.
- Type
AgentType 
- The data type of the parameter.
- Description string
- Description of function parameter.
- Required bool
- Information about if a parameter is required for function call. Default to false.
- type
AgentType 
- The data type of the parameter.
- description String
- Description of function parameter.
- required Boolean
- Information about if a parameter is required for function call. Default to false.
- type
AgentType 
- The data type of the parameter.
- description string
- Description of function parameter.
- required boolean
- Information about if a parameter is required for function call. Default to false.
- type
AgentType 
- The data type of the parameter.
- description str
- Description of function parameter.
- required bool
- Information about if a parameter is required for function call. Default to false.
- type "string" | "number" | "integer" | "boolean" | "array"
- The data type of the parameter.
- description String
- Description of function parameter.
- required Boolean
- Information about if a parameter is required for function call. Default to false.
AgentPromptConfiguration, AgentPromptConfigurationArgs      
- AdditionalModel Pulumi.Request Fields Aws Native. Bedrock. Inputs. Agent Additional Model Request Fields 
- If the Converse or ConverseStream operations support the model, - additionalModelRequestFieldscontains additional inference parameters, beyond the base set of inference parameters in the- inferenceConfigurationfield.- For more information, see Inference request parameters and response fields for foundation models . 
- BasePrompt stringTemplate 
- Base Prompt Template.
- FoundationModel string
- The agent's foundation model.
- InferenceConfiguration Pulumi.Aws Native. Bedrock. Inputs. Agent Inference Configuration 
- 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 .
- ParserMode Pulumi.Aws Native. Bedrock. Agent Creation Mode 
- 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 asOVERRIDDEN, theoverrideLambdafield in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
- PromptCreation Pulumi.Mode Aws Native. Bedrock. Agent Creation Mode 
- Specifies whether to override the default prompt template for this promptType. Set this value toOVERRIDDENto use the prompt that you provide in thebasePromptTemplate. If you leave it asDEFAULT, the agent uses a default prompt template.
- PromptState Pulumi.Aws Native. Bedrock. Agent Prompt State 
- Specifies whether to allow the inline agent to carry out the step specified in the promptType. If you set this value toDISABLED, the agent skips that step. The default state for eachpromptTypeis as follows.- PRE_PROCESSING–- ENABLED
- ORCHESTRATION–- ENABLED
- KNOWLEDGE_BASE_RESPONSE_GENERATION–- ENABLED
- POST_PROCESSING–- DISABLED
 
- PromptType Pulumi.Aws Native. Bedrock. Agent Prompt Type 
- The step in the agent sequence that this prompt configuration applies to.
- AdditionalModel AgentRequest Fields Additional Model Request Fields 
- If the Converse or ConverseStream operations support the model, - additionalModelRequestFieldscontains additional inference parameters, beyond the base set of inference parameters in the- inferenceConfigurationfield.- For more information, see Inference request parameters and response fields for foundation models . 
- BasePrompt stringTemplate 
- Base Prompt Template.
- FoundationModel string
- The agent's foundation model.
- InferenceConfiguration AgentInference Configuration 
- 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 .
- ParserMode AgentCreation Mode 
- 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 asOVERRIDDEN, theoverrideLambdafield in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
- PromptCreation AgentMode Creation Mode 
- Specifies whether to override the default prompt template for this promptType. Set this value toOVERRIDDENto use the prompt that you provide in thebasePromptTemplate. If you leave it asDEFAULT, the agent uses a default prompt template.
- PromptState AgentPrompt State 
- Specifies whether to allow the inline agent to carry out the step specified in the promptType. If you set this value toDISABLED, the agent skips that step. The default state for eachpromptTypeis as follows.- PRE_PROCESSING–- ENABLED
- ORCHESTRATION–- ENABLED
- KNOWLEDGE_BASE_RESPONSE_GENERATION–- ENABLED
- POST_PROCESSING–- DISABLED
 
- PromptType AgentPrompt Type 
- The step in the agent sequence that this prompt configuration applies to.
- additionalModel AgentRequest Fields Additional Model Request Fields 
- If the Converse or ConverseStream operations support the model, - additionalModelRequestFieldscontains additional inference parameters, beyond the base set of inference parameters in the- inferenceConfigurationfield.- For more information, see Inference request parameters and response fields for foundation models . 
- basePrompt StringTemplate 
- Base Prompt Template.
- foundationModel String
- The agent's foundation model.
- inferenceConfiguration AgentInference Configuration 
- 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 .
- parserMode AgentCreation Mode 
- 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 asOVERRIDDEN, theoverrideLambdafield in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
- promptCreation AgentMode Creation Mode 
- Specifies whether to override the default prompt template for this promptType. Set this value toOVERRIDDENto use the prompt that you provide in thebasePromptTemplate. If you leave it asDEFAULT, the agent uses a default prompt template.
- promptState AgentPrompt State 
- Specifies whether to allow the inline agent to carry out the step specified in the promptType. If you set this value toDISABLED, the agent skips that step. The default state for eachpromptTypeis as follows.- PRE_PROCESSING–- ENABLED
- ORCHESTRATION–- ENABLED
- KNOWLEDGE_BASE_RESPONSE_GENERATION–- ENABLED
- POST_PROCESSING–- DISABLED
 
- promptType AgentPrompt Type 
- The step in the agent sequence that this prompt configuration applies to.
- additionalModel AgentRequest Fields Additional Model Request Fields 
- If the Converse or ConverseStream operations support the model, - additionalModelRequestFieldscontains additional inference parameters, beyond the base set of inference parameters in the- inferenceConfigurationfield.- For more information, see Inference request parameters and response fields for foundation models . 
- basePrompt stringTemplate 
- Base Prompt Template.
- foundationModel string
- The agent's foundation model.
- inferenceConfiguration AgentInference Configuration 
- 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 .
- parserMode AgentCreation Mode 
- 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 asOVERRIDDEN, theoverrideLambdafield in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
- promptCreation AgentMode Creation Mode 
- Specifies whether to override the default prompt template for this promptType. Set this value toOVERRIDDENto use the prompt that you provide in thebasePromptTemplate. If you leave it asDEFAULT, the agent uses a default prompt template.
- promptState AgentPrompt State 
- Specifies whether to allow the inline agent to carry out the step specified in the promptType. If you set this value toDISABLED, the agent skips that step. The default state for eachpromptTypeis as follows.- PRE_PROCESSING–- ENABLED
- ORCHESTRATION–- ENABLED
- KNOWLEDGE_BASE_RESPONSE_GENERATION–- ENABLED
- POST_PROCESSING–- DISABLED
 
- promptType AgentPrompt Type 
- The step in the agent sequence that this prompt configuration applies to.
- additional_model_ Agentrequest_ fields Additional Model Request Fields 
- If the Converse or ConverseStream operations support the model, - additionalModelRequestFieldscontains additional inference parameters, beyond the base set of inference parameters in the- inferenceConfigurationfield.- For more information, see Inference request parameters and response fields for foundation models . 
- base_prompt_ strtemplate 
- Base Prompt Template.
- foundation_model str
- The agent's foundation model.
- inference_configuration AgentInference Configuration 
- 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 .
- parser_mode AgentCreation Mode 
- 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 asOVERRIDDEN, theoverrideLambdafield in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
- prompt_creation_ Agentmode Creation Mode 
- Specifies whether to override the default prompt template for this promptType. Set this value toOVERRIDDENto use the prompt that you provide in thebasePromptTemplate. If you leave it asDEFAULT, the agent uses a default prompt template.
- prompt_state AgentPrompt State 
- Specifies whether to allow the inline agent to carry out the step specified in the promptType. If you set this value toDISABLED, the agent skips that step. The default state for eachpromptTypeis as follows.- PRE_PROCESSING–- ENABLED
- ORCHESTRATION–- ENABLED
- KNOWLEDGE_BASE_RESPONSE_GENERATION–- ENABLED
- POST_PROCESSING–- DISABLED
 
- prompt_type AgentPrompt Type 
- The step in the agent sequence that this prompt configuration applies to.
- additionalModel Property MapRequest Fields 
- If the Converse or ConverseStream operations support the model, - additionalModelRequestFieldscontains additional inference parameters, beyond the base set of inference parameters in the- inferenceConfigurationfield.- For more information, see Inference request parameters and response fields for foundation models . 
- basePrompt StringTemplate 
- Base Prompt Template.
- foundationModel String
- The agent's foundation model.
- inferenceConfiguration Property Map
- 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 .
- parserMode "DEFAULT" | "OVERRIDDEN"
- 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 asOVERRIDDEN, theoverrideLambdafield in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
- promptCreation "DEFAULT" | "OVERRIDDEN"Mode 
- Specifies whether to override the default prompt template for this promptType. Set this value toOVERRIDDENto use the prompt that you provide in thebasePromptTemplate. If you leave it asDEFAULT, the agent uses a default prompt template.
- promptState "ENABLED" | "DISABLED"
- Specifies whether to allow the inline agent to carry out the step specified in the promptType. If you set this value toDISABLED, the agent skips that step. The default state for eachpromptTypeis as follows.- PRE_PROCESSING–- ENABLED
- ORCHESTRATION–- ENABLED
- KNOWLEDGE_BASE_RESPONSE_GENERATION–- ENABLED
- POST_PROCESSING–- DISABLED
 
- promptType "PRE_PROCESSING" | "ORCHESTRATION" | "POST_PROCESSING" | "ROUTING_CLASSIFIER" | "MEMORY_SUMMARIZATION" | "KNOWLEDGE_BASE_RESPONSE_GENERATION"
- The step in the agent sequence that this prompt configuration applies to.
AgentPromptOverrideConfiguration, AgentPromptOverrideConfigurationArgs        
- PromptConfigurations List<Pulumi.Aws Native. Bedrock. Inputs. Agent Prompt Configuration> 
- List of BasePromptConfiguration
- OverrideLambda string
- ARN of a Lambda.
- PromptConfigurations []AgentPrompt Configuration 
- List of BasePromptConfiguration
- OverrideLambda string
- ARN of a Lambda.
- promptConfigurations List<AgentPrompt Configuration> 
- List of BasePromptConfiguration
- overrideLambda String
- ARN of a Lambda.
- promptConfigurations AgentPrompt Configuration[] 
- List of BasePromptConfiguration
- overrideLambda string
- ARN of a Lambda.
- prompt_configurations Sequence[AgentPrompt Configuration] 
- List of BasePromptConfiguration
- override_lambda str
- ARN of a Lambda.
- promptConfigurations List<Property Map>
- List of BasePromptConfiguration
- overrideLambda String
- ARN of a Lambda.
AgentPromptState, AgentPromptStateArgs      
- Enabled
- ENABLED
- Disabled
- DISABLED
- AgentPrompt State Enabled 
- ENABLED
- AgentPrompt State Disabled 
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- ENABLED
- ENABLED
- DISABLED
- DISABLED
- "ENABLED"
- ENABLED
- "DISABLED"
- DISABLED
AgentPromptType, AgentPromptTypeArgs      
- PreProcessing 
- PRE_PROCESSING
- Orchestration
- ORCHESTRATION
- PostProcessing 
- POST_PROCESSING
- RoutingClassifier 
- ROUTING_CLASSIFIER
- MemorySummarization 
- MEMORY_SUMMARIZATION
- KnowledgeBase Response Generation 
- KNOWLEDGE_BASE_RESPONSE_GENERATION
- AgentPrompt Type Pre Processing 
- PRE_PROCESSING
- AgentPrompt Type Orchestration 
- ORCHESTRATION
- AgentPrompt Type Post Processing 
- POST_PROCESSING
- AgentPrompt Type Routing Classifier 
- ROUTING_CLASSIFIER
- AgentPrompt Type Memory Summarization 
- MEMORY_SUMMARIZATION
- AgentPrompt Type Knowledge Base Response Generation 
- KNOWLEDGE_BASE_RESPONSE_GENERATION
- PreProcessing 
- PRE_PROCESSING
- Orchestration
- ORCHESTRATION
- PostProcessing 
- POST_PROCESSING
- RoutingClassifier 
- ROUTING_CLASSIFIER
- MemorySummarization 
- MEMORY_SUMMARIZATION
- KnowledgeBase Response Generation 
- KNOWLEDGE_BASE_RESPONSE_GENERATION
- PreProcessing 
- PRE_PROCESSING
- Orchestration
- ORCHESTRATION
- PostProcessing 
- POST_PROCESSING
- RoutingClassifier 
- ROUTING_CLASSIFIER
- MemorySummarization 
- MEMORY_SUMMARIZATION
- KnowledgeBase Response Generation 
- KNOWLEDGE_BASE_RESPONSE_GENERATION
- PRE_PROCESSING
- PRE_PROCESSING
- ORCHESTRATION
- ORCHESTRATION
- POST_PROCESSING
- POST_PROCESSING
- ROUTING_CLASSIFIER
- ROUTING_CLASSIFIER
- MEMORY_SUMMARIZATION
- MEMORY_SUMMARIZATION
- KNOWLEDGE_BASE_RESPONSE_GENERATION
- KNOWLEDGE_BASE_RESPONSE_GENERATION
- "PRE_PROCESSING"
- PRE_PROCESSING
- "ORCHESTRATION"
- ORCHESTRATION
- "POST_PROCESSING"
- POST_PROCESSING
- "ROUTING_CLASSIFIER"
- ROUTING_CLASSIFIER
- "MEMORY_SUMMARIZATION"
- MEMORY_SUMMARIZATION
- "KNOWLEDGE_BASE_RESPONSE_GENERATION"
- KNOWLEDGE_BASE_RESPONSE_GENERATION
AgentRelayConversationHistory, AgentRelayConversationHistoryArgs        
- ToCollaborator 
- TO_COLLABORATOR
- Disabled
- DISABLED
- AgentRelay Conversation History To Collaborator 
- TO_COLLABORATOR
- AgentRelay Conversation History Disabled 
- DISABLED
- ToCollaborator 
- TO_COLLABORATOR
- Disabled
- DISABLED
- ToCollaborator 
- TO_COLLABORATOR
- Disabled
- DISABLED
- TO_COLLABORATOR
- TO_COLLABORATOR
- DISABLED
- DISABLED
- "TO_COLLABORATOR"
- TO_COLLABORATOR
- "DISABLED"
- DISABLED
AgentRequireConfirmation, AgentRequireConfirmationArgs      
- Enabled
- ENABLED
- Disabled
- DISABLED
- AgentRequire Confirmation Enabled 
- ENABLED
- AgentRequire Confirmation Disabled 
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- ENABLED
- ENABLED
- DISABLED
- DISABLED
- "ENABLED"
- ENABLED
- "DISABLED"
- DISABLED
AgentS3Identifier, AgentS3IdentifierArgs    
- S3BucketName string
- A bucket in S3.
- S3ObjectKey string
- A object key in S3.
- S3BucketName string
- A bucket in S3.
- S3ObjectKey string
- A object key in S3.
- s3BucketName String
- A bucket in S3.
- s3ObjectKey String
- A object key in S3.
- s3BucketName string
- A bucket in S3.
- s3ObjectKey string
- A object key in S3.
- s3_bucket_ strname 
- A bucket in S3.
- s3_object_ strkey 
- A object key in S3.
- s3BucketName String
- A bucket in S3.
- s3ObjectKey String
- A object key in S3.
AgentSessionSummaryConfiguration, AgentSessionSummaryConfigurationArgs        
- MaxRecent doubleSessions 
- Maximum number of Sessions to Summarize
- MaxRecent float64Sessions 
- Maximum number of Sessions to Summarize
- maxRecent DoubleSessions 
- Maximum number of Sessions to Summarize
- maxRecent numberSessions 
- Maximum number of Sessions to Summarize
- max_recent_ floatsessions 
- Maximum number of Sessions to Summarize
- maxRecent NumberSessions 
- Maximum number of Sessions to Summarize
AgentStatus, AgentStatusArgs    
- Creating
- CREATING
- Preparing
- PREPARING
- Prepared
- PREPARED
- NotPrepared 
- NOT_PREPARED
- Deleting
- DELETING
- Failed
- FAILED
- Versioning
- VERSIONING
- Updating
- UPDATING
- AgentStatus Creating 
- CREATING
- AgentStatus Preparing 
- PREPARING
- AgentStatus Prepared 
- PREPARED
- AgentStatus Not Prepared 
- NOT_PREPARED
- AgentStatus Deleting 
- DELETING
- AgentStatus Failed 
- FAILED
- AgentStatus Versioning 
- VERSIONING
- AgentStatus Updating 
- UPDATING
- Creating
- CREATING
- Preparing
- PREPARING
- Prepared
- PREPARED
- NotPrepared 
- NOT_PREPARED
- Deleting
- DELETING
- Failed
- FAILED
- Versioning
- VERSIONING
- Updating
- UPDATING
- Creating
- CREATING
- Preparing
- PREPARING
- Prepared
- PREPARED
- NotPrepared 
- NOT_PREPARED
- Deleting
- DELETING
- Failed
- FAILED
- Versioning
- VERSIONING
- Updating
- UPDATING
- CREATING
- CREATING
- PREPARING
- PREPARING
- PREPARED
- PREPARED
- NOT_PREPARED
- NOT_PREPARED
- DELETING
- DELETING
- FAILED
- FAILED
- VERSIONING
- VERSIONING
- UPDATING
- UPDATING
- "CREATING"
- CREATING
- "PREPARING"
- PREPARING
- "PREPARED"
- PREPARED
- "NOT_PREPARED"
- NOT_PREPARED
- "DELETING"
- DELETING
- "FAILED"
- FAILED
- "VERSIONING"
- VERSIONING
- "UPDATING"
- UPDATING
AgentType, AgentTypeArgs    
- String
- string
- Number
- number
- Integer
- integer
- Boolean
- boolean
- Array
- array
- AgentType String 
- string
- AgentType Number 
- number
- AgentType Integer 
- integer
- AgentType Boolean 
- boolean
- AgentType Array 
- array
- String
- string
- Number
- number
- Integer
- integer
- Boolean
- boolean
- Array
- array
- String
- string
- Number
- number
- Integer
- integer
- Boolean
- boolean
- Array
- array
- STRING
- string
- NUMBER
- number
- INTEGER
- integer
- BOOLEAN
- boolean
- ARRAY
- array
- "string"
- string
- "number"
- number
- "integer"
- integer
- "boolean"
- boolean
- "array"
- array
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.