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 CreateAgentActionGroup API operation.

Syntax

New-AABAgentActionGroup
-AgentId <String>
-ActionGroupName <String>
-ActionGroupState <ActionGroupState>
-AgentVersion <String>
-ActionGroupExecutor_CustomControl <CustomControlMethod>
-Description <String>
-FunctionSchema_Function <Function[]>
-ActionGroupExecutor_Lambda <String>
-ParentActionGroupSignature <ActionGroupSignature>
-ApiSchema_Payload <String>
-S3_S3BucketName <String>
-S3_S3ObjectKey <String>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonBedrockAgentConfig>

Description

Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them. To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

Parameters

-ActionGroupExecutor_CustomControl <CustomControlMethod>
To return the action group invocation results directly in the InvokeAgent response, specify RETURN_CONTROL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ActionGroupExecutor_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)
-ActionGroupName <String>
The name to give the action group.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ActionGroupState <ActionGroupState>
Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AgentId <String>
The unique identifier of the agent for which to create the action group.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-AgentVersion <String>
The version of the agent for which to create the action group.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ApiSchema_Payload <String>
The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
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)
-Description <String>
A description of the action group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
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)
-FunctionSchema_Function <Function[]>
A list of functions that each define an action in the action group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFunctionSchema_Functions
-ParentActionGroupSignature <ActionGroupSignature>
To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3_S3BucketName <String>
The name of the S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiSchema_S3_S3BucketName
-S3_S3ObjectKey <String>
The S3 object key containing the resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiSchema_S3_S3ObjectKey
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'AgentActionGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.CreateAgentActionGroupResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.CreateAgentActionGroupResponse 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)

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

This cmdlet returns an Amazon.BedrockAgent.Model.AgentActionGroup object. The service call response (type Amazon.BedrockAgent.Model.CreateAgentActionGroupResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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