All Superinterfaces:

Buildable, CopyableBuilder<AgentActionGroup.Builder,AgentActionGroup>, SdkBuilder<AgentActionGroup.Builder,AgentActionGroup>, SdkPojo

Enclosing class:

AgentActionGroup
```
public static interface AgentActionGroup.Builder
extends SdkPojo, CopyableBuilder<AgentActionGroup.Builder,AgentActionGroup>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default AgentActionGroup.Builder`	`actionGroupExecutor(Consumer<ActionGroupExecutor.Builder> actionGroupExecutor)`	The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
`AgentActionGroup.Builder`	`actionGroupExecutor(ActionGroupExecutor actionGroupExecutor)`	The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
`AgentActionGroup.Builder`	`actionGroupId(String actionGroupId)`	The unique identifier of the action group.
`AgentActionGroup.Builder`	`actionGroupName(String actionGroupName)`	The name of the action group.
`AgentActionGroup.Builder`	`actionGroupState(String actionGroupState)`	Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
`AgentActionGroup.Builder`	`actionGroupState(ActionGroupState actionGroupState)`	Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
`AgentActionGroup.Builder`	`agentId(String agentId)`	The unique identifier of the agent to which the action group belongs.
`AgentActionGroup.Builder`	`agentVersion(String agentVersion)`	The version of the agent to which the action group belongs.
`default AgentActionGroup.Builder`	`apiSchema(Consumer<APISchema.Builder> 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.
`AgentActionGroup.Builder`	`apiSchema(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.
`AgentActionGroup.Builder`	`clientToken(String clientToken)`	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
`AgentActionGroup.Builder`	`createdAt(Instant createdAt)`	The time at which the action group was created.
`AgentActionGroup.Builder`	`description(String description)`	The description of the action group.
`default AgentActionGroup.Builder`	`functionSchema(Consumer<FunctionSchema.Builder> functionSchema)`	Defines functions that each define parameters that the agent needs to invoke from the user.
`AgentActionGroup.Builder`	`functionSchema(FunctionSchema functionSchema)`	Defines functions that each define parameters that the agent needs to invoke from the user.
`AgentActionGroup.Builder`	`parentActionSignature(String parentActionSignature)`	If this field is set as `AMAZON.UserInput`, the agent can request the user for additional information when trying to complete a task.
`AgentActionGroup.Builder`	`parentActionSignature(ActionGroupSignature parentActionSignature)`	If this field is set as `AMAZON.UserInput`, the agent can request the user for additional information when trying to complete a task.
`AgentActionGroup.Builder`	`updatedAt(Instant updatedAt)`	The time at which the action group was last updated.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

- Method Detail
  - actionGroupExecutor
```
AgentActionGroup.Builder actionGroupExecutor(ActionGroupExecutor actionGroupExecutor)
```
    The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
    
    Parameters:
    
    actionGroupExecutor - The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - actionGroupExecutor
```
default AgentActionGroup.Builder actionGroupExecutor(Consumer<ActionGroupExecutor.Builder> actionGroupExecutor)
```
    The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
    This is a convenience method that creates an instance of the ActionGroupExecutor.Builder avoiding the need to create one manually via ActionGroupExecutor.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to actionGroupExecutor(ActionGroupExecutor).
    
    Parameters:
    
    actionGroupExecutor - a consumer that will call methods on ActionGroupExecutor.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    actionGroupExecutor(ActionGroupExecutor)
  - actionGroupId
```
AgentActionGroup.Builder actionGroupId(String actionGroupId)
```
    The unique identifier of the action group.
    
    Parameters:
    
    actionGroupId - The unique identifier of the action group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - actionGroupName
```
AgentActionGroup.Builder actionGroupName(String actionGroupName)
```
    The name of the action group.
    
    Parameters:
    
    actionGroupName - The name of the action group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - actionGroupState
```
AgentActionGroup.Builder actionGroupState(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, ActionGroupState
  - actionGroupState
```
AgentActionGroup.Builder actionGroupState(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, ActionGroupState
  - agentId
```
AgentActionGroup.Builder agentId(String agentId)
```
    The unique identifier of the agent to which the action group belongs.
    
    Parameters:
    
    agentId - The unique identifier of the agent to which the action group belongs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - agentVersion
```
AgentActionGroup.Builder agentVersion(String agentVersion)
```
    The version of the agent to which the action group belongs.
    
    Parameters:
    
    agentVersion - The version of the agent to which the action group belongs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - apiSchema
```
AgentActionGroup.Builder apiSchema(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.
  - apiSchema
```
default AgentActionGroup.Builder apiSchema(Consumer<APISchema.Builder> 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.
    This is a convenience method that creates an instance of the APISchema.Builder avoiding the need to create one manually via APISchema.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to apiSchema(APISchema).
    
    Parameters:
    
    apiSchema - a consumer that will call methods on APISchema.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    apiSchema(APISchema)
  - clientToken
```
AgentActionGroup.Builder clientToken(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.
  - createdAt
```
AgentActionGroup.Builder createdAt(Instant createdAt)
```
    The time at which the action group was created.
    
    Parameters:
    
    createdAt - The time at which the action group was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - description
```
AgentActionGroup.Builder description(String description)
```
    The description of the action group.
    
    Parameters:
    
    description - The description of the action group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - functionSchema
```
AgentActionGroup.Builder functionSchema(FunctionSchema functionSchema)
```
    Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
    
    Parameters:
    
    functionSchema - Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - functionSchema
```
default AgentActionGroup.Builder functionSchema(Consumer<FunctionSchema.Builder> functionSchema)
```
    Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
    This is a convenience method that creates an instance of the FunctionSchema.Builder avoiding the need to create one manually via FunctionSchema.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to functionSchema(FunctionSchema).
    
    Parameters:
    
    functionSchema - a consumer that will call methods on FunctionSchema.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    functionSchema(FunctionSchema)
  - parentActionSignature
```
AgentActionGroup.Builder parentActionSignature(String parentActionSignature)
```
    If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.
    
    During orchestration, if the 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:
    
    parentActionSignature - If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.
    
    During orchestration, if the 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, ActionGroupSignature
  - parentActionSignature
```
AgentActionGroup.Builder parentActionSignature(ActionGroupSignature parentActionSignature)
```
    If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.
    
    During orchestration, if the 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:
    
    parentActionSignature - If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.
    
    During orchestration, if the 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, ActionGroupSignature
  - updatedAt
```
AgentActionGroup.Builder updatedAt(Instant updatedAt)
```
    The time at which the action group was last updated.
    
    Parameters:
    
    updatedAt - The time at which the action group was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface AgentActionGroup.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Method Detail

actionGroupExecutor

actionGroupExecutor

actionGroupId

actionGroupName

actionGroupState

actionGroupState

agentId

agentVersion

apiSchema

apiSchema

clientToken

createdAt

description

functionSchema

functionSchema

parentActionSignature

parentActionSignature

updatedAt