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 QuickSight CreateAgent API operation.

Syntax

New-QSAgent
-ActionConnector <String[]>
-AgentId <String>
-AgentLifecycle <AgentLifecycle>
-AwsAccountId <String>
-CustomPromptInput_NewPrompt_CustomInstruction <String>
-Description <String>
-IconId <String>
-CustomPromptInput_NewPrompt_Identity <String>
-CustomPromptInput_ExistingPrompt_ModelProfileId <String>
-Name <String>
-CustomPromptInput_NewPrompt_OutputStyle <String>
-CustomPromptInput_ExistingPrompt_QbsAwsAccountId <String>
-CustomPromptInput_NewPrompt_ResponseLength <String>
-Space <String[]>
-StarterPrompt <String[]>
-CustomPromptInput_ExistingPrompt_SubscriptionId <String>
-CustomPromptInput_NewPrompt_Tone <String>
-WelcomeMessage <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonQuickSightConfig>

Description

Creates an agent in Amazon QuickSight.

Parameters

-ActionConnector <String[]>
The Amazon Resource Names (ARNs) of the action connectors to attach to the agent. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActionConnectors
-AgentId <String>
A unique identifier for the agent.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-AgentLifecycle <AgentLifecycle>
The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsAccountId <String>
The ID of the Amazon Web Services account that contains the agent.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonQuickSightConfig>
Amazon.PowerShell.Cmdlets.QS.AmazonQuickSightClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomPromptInput_ExistingPrompt_ModelProfileId <String>
The identifier of the model profile.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomPromptInput_ExistingPrompt_QbsAwsAccountId <String>
The Amazon Web Services account ID for the Q Business service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomPromptInput_ExistingPrompt_SubscriptionId <String>
The subscription identifier.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomPromptInput_NewPrompt_CustomInstruction <String>
Custom instructions for the agent's behavior.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomPromptInput_NewPrompt_CustomInstructions
-CustomPromptInput_NewPrompt_Identity <String>
Instructions that define the agent's identity and persona.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomPromptInput_NewPrompt_OutputStyle <String>
Instructions for the desired output style.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomPromptInput_NewPrompt_ResponseLength <String>
Instructions for the desired response length.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomPromptInput_NewPrompt_Tone <String>
Instructions for the desired tone of responses.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description of the agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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)
-IconId <String>
The icon identifier for the agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The name of the agent.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateAgentResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateAgentResponse 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)
-Space <String[]>
The Amazon Resource Names (ARNs) of the spaces to attach to the agent. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSpaces
-StarterPrompt <String[]>
A list of starter prompts that are displayed to users when they begin interacting with the agent. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStarterPrompts
-WelcomeMessage <String>
The welcome message that is displayed when a user starts a conversation with the agent.
Required?False
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.QuickSight.Model.CreateAgentResponse
This cmdlet returns an Amazon.QuickSight.Model.CreateAgentResponse object containing multiple properties.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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