AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Q Connect CreateAIAgent API operation.

Syntax

New-QCAIAgent
-Name <String>
-AnswerRecommendationAIAgentConfiguration_AnswerGenerationAIGuardrailId <String>
-ManualSearchAIAgentConfiguration_AnswerGenerationAIGuardrailId <String>
-AnswerRecommendationAIAgentConfiguration_AnswerGenerationAIPromptId <String>
-ManualSearchAIAgentConfiguration_AnswerGenerationAIPromptId <String>
-AssistantId <String>
-AnswerRecommendationAIAgentConfiguration_AssociationConfiguration <AssociationConfiguration[]>
-EmailGenerativeAnswerAIAgentConfiguration_AssociationConfiguration <AssociationConfiguration[]>
-EmailResponseAIAgentConfiguration_AssociationConfiguration <AssociationConfiguration[]>
-ManualSearchAIAgentConfiguration_AssociationConfiguration <AssociationConfiguration[]>
-SelfServiceAIAgentConfiguration_AssociationConfiguration <AssociationConfiguration[]>
-Description <String>
-EmailGenerativeAnswerAIAgentConfiguration_EmailGenerativeAnswerAIPromptId <String>
-EmailOverviewAIAgentConfiguration_EmailOverviewAIPromptId <String>
-EmailGenerativeAnswerAIAgentConfiguration_EmailQueryReformulationAIPromptId <String>
-EmailResponseAIAgentConfiguration_EmailQueryReformulationAIPromptId <String>
-EmailResponseAIAgentConfiguration_EmailResponseAIPromptId <String>
-AnswerRecommendationAIAgentConfiguration_IntentLabelingGenerationAIPromptId <String>
-AnswerRecommendationAIAgentConfiguration_Locale <String>
-EmailGenerativeAnswerAIAgentConfiguration_Locale <String>
-EmailOverviewAIAgentConfiguration_Locale <String>
-EmailResponseAIAgentConfiguration_Locale <String>
-ManualSearchAIAgentConfiguration_Locale <String>
-AnswerRecommendationAIAgentConfiguration_QueryReformulationAIPromptId <String>
-SelfServiceAIAgentConfiguration_SelfServiceAIGuardrailId <String>
-SelfServiceAIAgentConfiguration_SelfServiceAnswerGenerationAIPromptId <String>
-SelfServiceAIAgentConfiguration_SelfServicePreProcessingAIPromptId <String>
-Tag <Hashtable>
-Type <AIAgentType>
-VisibilityStatus <VisibilityStatus>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonQConnectConfig>

Description

Creates an Amazon Q in Connect AI Agent.

Parameters

-AnswerRecommendationAIAgentConfiguration_AnswerGenerationAIGuardrailId <String>
The AI Guardrail identifier for the Answer Generation Guardrail used by the ANSWER_RECOMMENDATION AI Agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_AnswerRecommendationAIAgentConfiguration_AnswerGenerationAIGuardrailId
-AnswerRecommendationAIAgentConfiguration_AnswerGenerationAIPromptId <String>
The AI Prompt identifier for the Answer Generation prompt used by the ANSWER_RECOMMENDATION AI Agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_AnswerRecommendationAIAgentConfiguration_AnswerGenerationAIPromptId
-AnswerRecommendationAIAgentConfiguration_AssociationConfiguration <AssociationConfiguration[]>
The association configurations for overriding behavior on this AI Agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_AnswerRecommendationAIAgentConfiguration_AssociationConfigurations
-AnswerRecommendationAIAgentConfiguration_IntentLabelingGenerationAIPromptId <String>
The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_AnswerRecommendationAIAgentConfiguration_IntentLabelingGenerationAIPromptId
-AnswerRecommendationAIAgentConfiguration_Locale <String>
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.For more information on supported locales, see Language support for Amazon Q in Connect.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_AnswerRecommendationAIAgentConfiguration_Locale
-AnswerRecommendationAIAgentConfiguration_QueryReformulationAIPromptId <String>
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_AnswerRecommendationAIAgentConfiguration_QueryReformulationAIPromptId
-AssistantId <String>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonQConnectConfig>
Amazon.PowerShell.Cmdlets.QC.AmazonQConnectClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
The description of the AI Agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EmailGenerativeAnswerAIAgentConfiguration_AssociationConfiguration <AssociationConfiguration[]>
Configuration settings for knowledge base associations used by the email generative answer agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_EmailGenerativeAnswerAIAgentConfiguration_AssociationConfigurations
-EmailGenerativeAnswerAIAgentConfiguration_EmailGenerativeAnswerAIPromptId <String>
The ID of the System AI prompt used for generating comprehensive knowledge-based answers from email queries.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_EmailGenerativeAnswerAIAgentConfiguration_EmailGenerativeAnswerAIPromptId
-EmailGenerativeAnswerAIAgentConfiguration_EmailQueryReformulationAIPromptId <String>
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search results.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_EmailGenerativeAnswerAIAgentConfiguration_EmailQueryReformulationAIPromptId
-EmailGenerativeAnswerAIAgentConfiguration_Locale <String>
The locale setting for language-specific email processing and response generation (for example, en_US, es_ES).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_EmailGenerativeAnswerAIAgentConfiguration_Locale
-EmailOverviewAIAgentConfiguration_EmailOverviewAIPromptId <String>
The ID of the System AI prompt used for generating structured email conversation summaries.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_EmailOverviewAIAgentConfiguration_EmailOverviewAIPromptId
-EmailOverviewAIAgentConfiguration_Locale <String>
The locale setting for language-specific email overview processing (for example, en_US, es_ES).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_EmailOverviewAIAgentConfiguration_Locale
-EmailResponseAIAgentConfiguration_AssociationConfiguration <AssociationConfiguration[]>
Configuration settings for knowledge base associations used by the email response agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_EmailResponseAIAgentConfiguration_AssociationConfigurations
-EmailResponseAIAgentConfiguration_EmailQueryReformulationAIPromptId <String>
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search for response generation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_EmailResponseAIAgentConfiguration_EmailQueryReformulationAIPromptId
-EmailResponseAIAgentConfiguration_EmailResponseAIPromptId <String>
The ID of the System AI prompt used for generating professional email responses based on knowledge base content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_EmailResponseAIAgentConfiguration_EmailResponseAIPromptId
-EmailResponseAIAgentConfiguration_Locale <String>
The locale setting for language-specific email response generation (for example, en_US, es_ES).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_EmailResponseAIAgentConfiguration_Locale
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManualSearchAIAgentConfiguration_AnswerGenerationAIGuardrailId <String>
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ManualSearchAIAgentConfiguration_AnswerGenerationAIGuardrailId
-ManualSearchAIAgentConfiguration_AnswerGenerationAIPromptId <String>
The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ManualSearchAIAgentConfiguration_AnswerGenerationAIPromptId
-ManualSearchAIAgentConfiguration_AssociationConfiguration <AssociationConfiguration[]>
The association configurations for overriding behavior on this AI Agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ManualSearchAIAgentConfiguration_AssociationConfigurations
-ManualSearchAIAgentConfiguration_Locale <String>
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.For more information on supported locales, see Language support for Amazon Q in Connect.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ManualSearchAIAgentConfiguration_Locale
-Name <String>
The name of the AI Agent.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'AiAgent'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QConnect.Model.CreateAIAgentResponse). Specifying the name of a property of type Amazon.QConnect.Model.CreateAIAgentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SelfServiceAIAgentConfiguration_AssociationConfiguration <AssociationConfiguration[]>
The association configurations for overriding behavior on this AI Agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_SelfServiceAIAgentConfiguration_AssociationConfigurations
-SelfServiceAIAgentConfiguration_SelfServiceAIGuardrailId <String>
The AI Guardrail identifier used by the SELF_SERVICE AI Agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_SelfServiceAIAgentConfiguration_SelfServiceAIGuardrailId
-SelfServiceAIAgentConfiguration_SelfServiceAnswerGenerationAIPromptId <String>
The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_SelfServiceAIAgentConfiguration_SelfServiceAnswerGenerationAIPromptId
-SelfServiceAIAgentConfiguration_SelfServicePreProcessingAIPromptId <String>
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_SelfServiceAIAgentConfiguration_SelfServicePreProcessingAIPromptId
-Tag <Hashtable>
The tags used to organize, track, or control access for this resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Type <AIAgentType>
The type of the AI Agent.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-VisibilityStatus <VisibilityStatus>
The visibility status of the AI Agent.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.QConnect.Model.AIAgentData or Amazon.QConnect.Model.CreateAIAgentResponse
This cmdlet returns an Amazon.QConnect.Model.AIAgentData object. The service call response (type Amazon.QConnect.Model.CreateAIAgentResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z