com.amazonaws.services.bedrockagent.model

Class CreateAgentActionGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.bedrockagent.model.CreateAgentActionGroupRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateAgentActionGroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateAgentActionGroupRequest()

Method Summary

Modifier and Type	Method and Description
CreateAgentActionGroupRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
ActionGroupExecutor	getActionGroupExecutor() The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
String	getActionGroupName() The name to give the action group.
String	getActionGroupState() Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
String	getAgentId() The unique identifier of the agent for which to create the action group.
String	getAgentVersion() The version of the agent for which to create the action group.
APISchema	getApiSchema() Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
String	getClientToken() A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
String	getDescription() A description of the action group.
FunctionSchema	getFunctionSchema() Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
String	getParentActionGroupSignature() To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
int	hashCode()
void	setActionGroupExecutor(ActionGroupExecutor actionGroupExecutor) The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
void	setActionGroupName(String actionGroupName) The name to give the action group.
void	setActionGroupState(String actionGroupState) Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
void	setAgentId(String agentId) The unique identifier of the agent for which to create the action group.
void	setAgentVersion(String agentVersion) The version of the agent for which to create the action group.
void	setApiSchema(APISchema apiSchema) Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
void	setClientToken(String clientToken) A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
void	setDescription(String description) A description of the action group.
void	setFunctionSchema(FunctionSchema functionSchema) Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
void	setParentActionGroupSignature(String parentActionGroupSignature) To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
String	toString() Returns a string representation of this object.
CreateAgentActionGroupRequest	withActionGroupExecutor(ActionGroupExecutor actionGroupExecutor) The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
CreateAgentActionGroupRequest	withActionGroupName(String actionGroupName) The name to give the action group.
CreateAgentActionGroupRequest	withActionGroupState(ActionGroupState actionGroupState) Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
CreateAgentActionGroupRequest	withActionGroupState(String actionGroupState) Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
CreateAgentActionGroupRequest	withAgentId(String agentId) The unique identifier of the agent for which to create the action group.
CreateAgentActionGroupRequest	withAgentVersion(String agentVersion) The version of the agent for which to create the action group.
CreateAgentActionGroupRequest	withApiSchema(APISchema apiSchema) Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
CreateAgentActionGroupRequest	withClientToken(String clientToken) A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
CreateAgentActionGroupRequest	withDescription(String description) A description of the action group.
CreateAgentActionGroupRequest	withFunctionSchema(FunctionSchema functionSchema) Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
CreateAgentActionGroupRequest	withParentActionGroupSignature(ActionGroupSignature parentActionGroupSignature) To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
CreateAgentActionGroupRequest	withParentActionGroupSignature(String parentActionGroupSignature) To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateAgentActionGroupRequest

public CreateAgentActionGroupRequest()

Method Detail

setActionGroupExecutor

public void setActionGroupExecutor(ActionGroupExecutor actionGroupExecutor)

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

Parameters:

actionGroupExecutor - The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

getActionGroupExecutor

public ActionGroupExecutor getActionGroupExecutor()

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

Returns:

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

withActionGroupExecutor

public CreateAgentActionGroupRequest withActionGroupExecutor(ActionGroupExecutor actionGroupExecutor)

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

Parameters:

actionGroupExecutor - The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

setActionGroupName

public void setActionGroupName(String actionGroupName)

The name to give the action group.

Parameters:

actionGroupName - The name to give the action group.

getActionGroupName

public String getActionGroupName()

The name to give the action group.

Returns:

The name to give the action group.

withActionGroupName

public CreateAgentActionGroupRequest withActionGroupName(String actionGroupName)

The name to give the action group.

Parameters:

actionGroupName - The name to give the action group.

Returns:

Returns a reference to this object so that method calls can be chained together.

setActionGroupState

public void setActionGroupState(String actionGroupState)

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

Parameters:

actionGroupState - Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

See Also:

ActionGroupState

getActionGroupState

public String getActionGroupState()

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

Returns:

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

See Also:

ActionGroupState

withActionGroupState

public CreateAgentActionGroupRequest withActionGroupState(String actionGroupState)

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

Parameters:

actionGroupState - Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ActionGroupState

withActionGroupState

public CreateAgentActionGroupRequest withActionGroupState(ActionGroupState actionGroupState)

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

Parameters:

actionGroupState - Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ActionGroupState

setAgentId

public void setAgentId(String agentId)

The unique identifier of the agent for which to create the action group.

Parameters:

agentId - The unique identifier of the agent for which to create the action group.

getAgentId

public String getAgentId()

The unique identifier of the agent for which to create the action group.

Returns:

The unique identifier of the agent for which to create the action group.

withAgentId

public CreateAgentActionGroupRequest withAgentId(String agentId)

The unique identifier of the agent for which to create the action group.

Parameters:

agentId - The unique identifier of the agent for which to create the action group.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAgentVersion

public void setAgentVersion(String agentVersion)

The version of the agent for which to create the action group.

Parameters:

agentVersion - The version of the agent for which to create the action group.

getAgentVersion

public String getAgentVersion()

The version of the agent for which to create the action group.

Returns:

The version of the agent for which to create the action group.

withAgentVersion

public CreateAgentActionGroupRequest withAgentVersion(String agentVersion)

The version of the agent for which to create the action group.

Parameters:

agentVersion - The version of the agent for which to create the action group.

Returns:

Returns a reference to this object so that method calls can be chained together.

setApiSchema

public void setApiSchema(APISchema apiSchema)

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

Parameters:

apiSchema - Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

getApiSchema

public APISchema getApiSchema()

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

Returns:

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

withApiSchema

public CreateAgentActionGroupRequest withApiSchema(APISchema apiSchema)

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

Parameters:

apiSchema - Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientToken

public void setClientToken(String clientToken)

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.

Parameters:

clientToken - 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.

getClientToken

public String getClientToken()

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.

Returns:

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.

withClientToken

public CreateAgentActionGroupRequest withClientToken(String clientToken)

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.

Parameters:

clientToken - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

A description of the action group.

Parameters:

description - A description of the action group.

getDescription

public String getDescription()

A description of the action group.

Returns:

A description of the action group.

withDescription

public CreateAgentActionGroupRequest withDescription(String description)

A description of the action group.

Parameters:

description - A description of the action group.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFunctionSchema

public void setFunctionSchema(FunctionSchema functionSchema)

Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

Parameters:

functionSchema - Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

getFunctionSchema

public FunctionSchema getFunctionSchema()

Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

Returns:

Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

withFunctionSchema

public CreateAgentActionGroupRequest withFunctionSchema(FunctionSchema functionSchema)

Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

Parameters:

functionSchema - Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

Returns:

Returns a reference to this object so that method calls can be chained together.

setParentActionGroupSignature

public void setParentActionGroupSignature(String parentActionGroupSignature)

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.

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. 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:

parentActionGroupSignature - 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.

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. 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.

See Also:

ActionGroupSignature

getParentActionGroupSignature

public String getParentActionGroupSignature()

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.

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. 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.

Returns:

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.

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. 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.

See Also:

ActionGroupSignature

withParentActionGroupSignature

public CreateAgentActionGroupRequest withParentActionGroupSignature(String parentActionGroupSignature)

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.

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. 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:

parentActionGroupSignature - 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.

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ActionGroupSignature

withParentActionGroupSignature

public CreateAgentActionGroupRequest withParentActionGroupSignature(ActionGroupSignature parentActionGroupSignature)

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.

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. 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:

parentActionGroupSignature - 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.

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ActionGroupSignature

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateAgentActionGroupRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()