Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. wisdom
  5. AiAgent

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.wisdom.AiAgent

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Definition of AWS::Wisdom::AIAgent Resource Type

Create AiAgent Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AiAgent(name: string, args: AiAgentArgs, opts?: CustomResourceOptions);
@overload
def AiAgent(resource_name: str,
            args: AiAgentArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def AiAgent(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            assistant_id: Optional[str] = None,
            configuration: Optional[Union[AiAgentAiAgentConfiguration0PropertiesArgs, AiAgentAiAgentConfiguration1PropertiesArgs, AiAgentAiAgentConfiguration2PropertiesArgs]] = None,
            type: Optional[AiAgentAiAgentType] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
func NewAiAgent(ctx *Context, name string, args AiAgentArgs, opts ...ResourceOption) (*AiAgent, error)
public AiAgent(string name, AiAgentArgs args, CustomResourceOptions? opts = null)
public AiAgent(String name, AiAgentArgs args)
public AiAgent(String name, AiAgentArgs args, CustomResourceOptions options)

type: aws-native:wisdom:AiAgent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AiAgentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AiAgentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AiAgentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AiAgentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AiAgentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

AiAgent 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 AiAgent resource accepts the following input properties:

AssistantId This property is required. string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Configuration This property is required. Pulumi.AwsNative.Wisdom.Inputs.AiAgentAiAgentConfiguration0Properties | Pulumi.AwsNative.Wisdom.Inputs.AiAgentAiAgentConfiguration1Properties | Pulumi.AwsNative.Wisdom.Inputs.AiAgentAiAgentConfiguration2Properties
Configuration for the AI Agent.
Type This property is required. Pulumi.AwsNative.Wisdom.AiAgentAiAgentType
The type of the AI Agent.
Description string
The description of the AI Agent.
Name string
The name of the AI Agent.
Tags Dictionary<string, string>
The tags used to organize, track, or control access for this resource.
AssistantId This property is required. string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Configuration This property is required. AiAgentAiAgentConfiguration0PropertiesArgs | AiAgentAiAgentConfiguration1PropertiesArgs | AiAgentAiAgentConfiguration2PropertiesArgs
Configuration for the AI Agent.
Type This property is required. AiAgentAiAgentType
The type of the AI Agent.
Description string
The description of the AI Agent.
Name string
The name of the AI Agent.
Tags map[string]string
The tags used to organize, track, or control access for this resource.
assistantId This property is required. String
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
configuration This property is required. AiAgentAiAgentConfiguration0Properties | AiAgentAiAgentConfiguration1Properties | AiAgentAiAgentConfiguration2Properties
Configuration for the AI Agent.
type This property is required. AiAgentAiAgentType
The type of the AI Agent.
description String
The description of the AI Agent.
name String
The name of the AI Agent.
tags Map<String,String>
The tags used to organize, track, or control access for this resource.
assistantId This property is required. string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
configuration This property is required. AiAgentAiAgentConfiguration0Properties | AiAgentAiAgentConfiguration1Properties | AiAgentAiAgentConfiguration2Properties
Configuration for the AI Agent.
type This property is required. AiAgentAiAgentType
The type of the AI Agent.
description string
The description of the AI Agent.
name string
The name of the AI Agent.
tags {[key: string]: string}
The tags used to organize, track, or control access for this resource.
assistant_id This property is required. str
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
configuration This property is required. AiAgentAiAgentConfiguration0PropertiesArgs | AiAgentAiAgentConfiguration1PropertiesArgs | AiAgentAiAgentConfiguration2PropertiesArgs
Configuration for the AI Agent.
type This property is required. AiAgentAiAgentType
The type of the AI Agent.
description str
The description of the AI Agent.
name str
The name of the AI Agent.
tags Mapping[str, str]
The tags used to organize, track, or control access for this resource.
assistantId This property is required. String
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
configuration This property is required. Property Map | Property Map | Property Map
Configuration for the AI Agent.
type This property is required. "MANUAL_SEARCH" | "ANSWER_RECOMMENDATION" | "SELF_SERVICE"
The type of the AI Agent.
description String
The description of the AI Agent.
name String
The name of the AI Agent.
tags Map<String>
The tags used to organize, track, or control access for this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the AiAgent resource produces the following output properties:

AiAgentArn string
The Amazon Resource Name (ARN) of the AI agent.
AiAgentId string
The identifier of the AI Agent.
AssistantArn string
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
Id string
The provider-assigned unique ID for this managed resource.
ModifiedTimeSeconds double
AiAgentArn string
The Amazon Resource Name (ARN) of the AI agent.
AiAgentId string
The identifier of the AI Agent.
AssistantArn string
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
Id string
The provider-assigned unique ID for this managed resource.
ModifiedTimeSeconds float64
aiAgentArn String
The Amazon Resource Name (ARN) of the AI agent.
aiAgentId String
The identifier of the AI Agent.
assistantArn String
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
id String
The provider-assigned unique ID for this managed resource.
modifiedTimeSeconds Double
aiAgentArn string
The Amazon Resource Name (ARN) of the AI agent.
aiAgentId string
The identifier of the AI Agent.
assistantArn string
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
id string
The provider-assigned unique ID for this managed resource.
modifiedTimeSeconds number
ai_agent_arn str
The Amazon Resource Name (ARN) of the AI agent.
ai_agent_id str
The identifier of the AI Agent.
assistant_arn str
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
id str
The provider-assigned unique ID for this managed resource.
modified_time_seconds float
aiAgentArn String
The Amazon Resource Name (ARN) of the AI agent.
aiAgentId String
The identifier of the AI Agent.
assistantArn String
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
id String
The provider-assigned unique ID for this managed resource.
modifiedTimeSeconds Number

Supporting Types

AiAgentAiAgentAssociationConfigurationType
, AiAgentAiAgentAssociationConfigurationTypeArgs

KnowledgeBase
KNOWLEDGE_BASE
AiAgentAiAgentAssociationConfigurationTypeKnowledgeBase
KNOWLEDGE_BASE
KnowledgeBase
KNOWLEDGE_BASE
KnowledgeBase
KNOWLEDGE_BASE
KNOWLEDGE_BASE
KNOWLEDGE_BASE
"KNOWLEDGE_BASE"
KNOWLEDGE_BASE

AiAgentAiAgentConfiguration0Properties
, AiAgentAiAgentConfiguration0PropertiesArgs

AiAgentAiAgentConfiguration1Properties
, AiAgentAiAgentConfiguration1PropertiesArgs

AiAgentAiAgentConfiguration2Properties
, AiAgentAiAgentConfiguration2PropertiesArgs

AiAgentAiAgentType
, AiAgentAiAgentTypeArgs

ManualSearch
MANUAL_SEARCH
AnswerRecommendation
ANSWER_RECOMMENDATION
SelfService
SELF_SERVICE
AiAgentAiAgentTypeManualSearch
MANUAL_SEARCH
AiAgentAiAgentTypeAnswerRecommendation
ANSWER_RECOMMENDATION
AiAgentAiAgentTypeSelfService
SELF_SERVICE
ManualSearch
MANUAL_SEARCH
AnswerRecommendation
ANSWER_RECOMMENDATION
SelfService
SELF_SERVICE
ManualSearch
MANUAL_SEARCH
AnswerRecommendation
ANSWER_RECOMMENDATION
SelfService
SELF_SERVICE
MANUAL_SEARCH
MANUAL_SEARCH
ANSWER_RECOMMENDATION
ANSWER_RECOMMENDATION
SELF_SERVICE
SELF_SERVICE
"MANUAL_SEARCH"
MANUAL_SEARCH
"ANSWER_RECOMMENDATION"
ANSWER_RECOMMENDATION
"SELF_SERVICE"
SELF_SERVICE

AiAgentAnswerRecommendationAiAgentConfiguration
, AiAgentAnswerRecommendationAiAgentConfigurationArgs

AiAgentAssociationConfiguration
, AiAgentAssociationConfigurationArgs

AiAgentAssociationConfigurationDataProperties
, AiAgentAssociationConfigurationDataPropertiesArgs

AiAgentKnowledgeBaseAssociationConfigurationData
, AiAgentKnowledgeBaseAssociationConfigurationDataArgs

AiAgentKnowledgeBaseSearchType
, AiAgentKnowledgeBaseSearchTypeArgs

Hybrid
HYBRID
Semantic
SEMANTIC
AiAgentKnowledgeBaseSearchTypeHybrid
HYBRID
AiAgentKnowledgeBaseSearchTypeSemantic
SEMANTIC
Hybrid
HYBRID
Semantic
SEMANTIC
Hybrid
HYBRID
Semantic
SEMANTIC
HYBRID
HYBRID
SEMANTIC
SEMANTIC
"HYBRID"
HYBRID
"SEMANTIC"
SEMANTIC

AiAgentManualSearchAiAgentConfiguration
, AiAgentManualSearchAiAgentConfigurationArgs

AiAgentOrCondition0Properties
, AiAgentOrCondition0PropertiesArgs

AndConditions This property is required. []AiAgentTagCondition
andConditions This property is required. List<AiAgentTagCondition>
andConditions This property is required. AiAgentTagCondition[]
andConditions This property is required. List<Property Map>

AiAgentOrCondition1Properties
, AiAgentOrCondition1PropertiesArgs

TagCondition This property is required. AiAgentTagCondition
tagCondition This property is required. AiAgentTagCondition
tagCondition This property is required. AiAgentTagCondition
tag_condition This property is required. AiAgentTagCondition
tagCondition This property is required. Property Map

AiAgentSelfServiceAiAgentConfiguration
, AiAgentSelfServiceAiAgentConfigurationArgs

AiAgentTagCondition
, AiAgentTagConditionArgs

Key This property is required. string
Value string
Key This property is required. string
Value string
key This property is required. String
value String
key This property is required. string
value string
key This property is required. str
value str
key This property is required. String
value String

AiAgentTagFilter0Properties
, AiAgentTagFilter0PropertiesArgs

TagCondition This property is required. AiAgentTagCondition
tagCondition This property is required. AiAgentTagCondition
tagCondition This property is required. AiAgentTagCondition
tag_condition This property is required. AiAgentTagCondition
tagCondition This property is required. Property Map

AiAgentTagFilter1Properties
, AiAgentTagFilter1PropertiesArgs

AndConditions This property is required. []AiAgentTagCondition
andConditions This property is required. List<AiAgentTagCondition>
andConditions This property is required. AiAgentTagCondition[]
andConditions This property is required. List<Property Map>

AiAgentTagFilter2Properties
, AiAgentTagFilter2PropertiesArgs

OrConditions This property is required. List<Union<Pulumi.AwsNative.Wisdom.Inputs.AiAgentOrCondition0Properties, Pulumi.AwsNative.Wisdom.Inputs.AiAgentOrCondition1Properties>>
OrConditions This property is required. []interface{}
orConditions This property is required. List<Either<AiAgentOrCondition0Properties,AiAgentOrCondition1Properties>>
orConditions This property is required. (AiAgentOrCondition0Properties | AiAgentOrCondition1Properties)[]
or_conditions This property is required. Sequence[Union[AiAgentOrCondition0Properties, AiAgentOrCondition1Properties]]
orConditions This property is required. List<Property Map | Property Map>

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native