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 Agents for Amazon Bedrock CreateAgent API operation.

Syntax

New-AABAgent
-AgentName <String>
-AgentCollaboration <AgentCollaboration>
-AgentResourceRoleArn <String>
-CustomerEncryptionKeyArn <String>
-Description <String>
-MemoryConfiguration_EnabledMemoryType <String[]>
-FoundationModel <String>
-GuardrailConfiguration_GuardrailIdentifier <String>
-GuardrailConfiguration_GuardrailVersion <String>
-IdleSessionTTLInSecond <Int32>
-Instruction <String>
-Executor_Lambda <String>
-SessionSummaryConfiguration_MaxRecentSession <Int32>
-OrchestrationType <OrchestrationType>
-PromptOverrideConfiguration_OverrideLambda <String>
-PromptOverrideConfiguration_PromptConfiguration <PromptConfiguration[]>
-MemoryConfiguration_StorageDay <Int32>
-Tag <Hashtable>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonBedrockAgentConfig>

Description

Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
  • Specify the following fields for security purposes.
    • agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.
    • (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
    • (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.
  • To enable your agent to retain conversational context across multiple sessions, include a memoryConfiguration object. For more information, see Configure memory.
  • To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.
  • If your agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
  • The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.

Parameters

-AgentCollaboration <AgentCollaboration>
The agent's collaboration role.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AgentName <String>
A name for the agent that you create.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-AgentResourceRoleArn <String>
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonBedrockAgentConfig>
Amazon.PowerShell.Cmdlets.AAB.AmazonBedrockAgentClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomerEncryptionKeyArn <String>
The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
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)
-Executor_Lambda <String>
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomOrchestration_Executor_Lambda
-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)
-FoundationModel <String>
The identifier for the model that you want to be used for orchestration by the agent you create.The modelId to provide depends on the type of model or throughput that you use:
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GuardrailConfiguration_GuardrailIdentifier <String>
The unique identifier of the guardrail.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GuardrailConfiguration_GuardrailVersion <String>
The version of the guardrail.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IdleSessionTTLInSecond <Int32>
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIdleSessionTTLInSeconds
-Instruction <String>
Instructions that tell the agent what it should do and how it should interact with users.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MemoryConfiguration_EnabledMemoryType <String[]>
The type of memory that is stored. 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)
AliasesMemoryConfiguration_EnabledMemoryTypes
-MemoryConfiguration_StorageDay <Int32>
The number of days the agent is configured to retain the conversational context.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMemoryConfiguration_StorageDays
-OrchestrationType <OrchestrationType>
Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PromptOverrideConfiguration_OverrideLambda <String>
The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN. For more information, see Parser Lambda function in Amazon Bedrock Agents.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PromptOverrideConfiguration_PromptConfiguration <PromptConfiguration[]>
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts. 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)
AliasesPromptOverrideConfiguration_PromptConfigurations
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Agent'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.CreateAgentResponse). Specifying the name of a property of type Amazon.BedrockAgent.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)
-SessionSummaryConfiguration_MaxRecentSession <Int32>
Maximum number of recent session summaries to include in the agent's prompt context.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMemoryConfiguration_SessionSummaryConfiguration_MaxRecentSessions
-Tag <Hashtable>
Any tags that you want 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)
AliasesTags

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.BedrockAgent.Model.Agent or Amazon.BedrockAgent.Model.CreateAgentResponse
This cmdlet returns an Amazon.BedrockAgent.Model.Agent object. The service call response (type Amazon.BedrockAgent.Model.CreateAgentResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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