Docs Home Pulumi IaC Pulumi ESC 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.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.wisdom.AiAgent

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 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]] = 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 string
    The unique name of the resource.
    args AiAgentArgs
    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 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 string
    The unique name of the resource.
    args AiAgentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AiAgentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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 string
    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
    Configuration Pulumi.AwsNative.Wisdom.Inputs.AiAgentAiAgentConfiguration0Properties | Pulumi.AwsNative.Wisdom.Inputs.AiAgentAiAgentConfiguration1Properties
    Configuration for the AI Agent.
    Type 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 string
    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
    Configuration AiAgentAiAgentConfiguration0PropertiesArgs | AiAgentAiAgentConfiguration1PropertiesArgs
    Configuration for the AI Agent.
    Type 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 String
    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
    configuration AiAgentAiAgentConfiguration0Properties | AiAgentAiAgentConfiguration1Properties
    Configuration for the AI Agent.
    type 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 string
    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
    configuration AiAgentAiAgentConfiguration0Properties | AiAgentAiAgentConfiguration1Properties
    Configuration for the AI Agent.
    type 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 str
    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
    configuration AiAgentAiAgentConfiguration0PropertiesArgs | AiAgentAiAgentConfiguration1PropertiesArgs
    Configuration for the AI Agent.
    type 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 String
    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
    configuration Property Map | Property Map
    Configuration for the AI Agent.
    type "MANUAL_SEARCH" | "ANSWER_RECOMMENDATION"
    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.
    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.
    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.
    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.
    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.
    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.

    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

    AiAgentAiAgentType, AiAgentAiAgentTypeArgs

    ManualSearch
    MANUAL_SEARCH
    AnswerRecommendation
    ANSWER_RECOMMENDATION
    AiAgentAiAgentTypeManualSearch
    MANUAL_SEARCH
    AiAgentAiAgentTypeAnswerRecommendation
    ANSWER_RECOMMENDATION
    ManualSearch
    MANUAL_SEARCH
    AnswerRecommendation
    ANSWER_RECOMMENDATION
    ManualSearch
    MANUAL_SEARCH
    AnswerRecommendation
    ANSWER_RECOMMENDATION
    MANUAL_SEARCH
    MANUAL_SEARCH
    ANSWER_RECOMMENDATION
    ANSWER_RECOMMENDATION
    "MANUAL_SEARCH"
    MANUAL_SEARCH
    "ANSWER_RECOMMENDATION"
    ANSWER_RECOMMENDATION

    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

    AiAgentOrCondition1Properties, AiAgentOrCondition1PropertiesArgs

    AiAgentTagCondition, AiAgentTagConditionArgs

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    AiAgentTagFilter0Properties, AiAgentTagFilter0PropertiesArgs

    AiAgentTagFilter1Properties, AiAgentTagFilter1PropertiesArgs

    AiAgentTagFilter2Properties, AiAgentTagFilter2PropertiesArgs

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

    Package Details

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

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

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native