1. Packages
  2. AWS Classic
  3. API Docs
  4. bedrock
  5. AgentAgentActionGroup

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.37.1 published on Friday, May 24, 2024 by Pulumi

aws.bedrock.AgentAgentActionGroup

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.37.1 published on Friday, May 24, 2024 by Pulumi

    Resource for managing an AWS Agents for Amazon Bedrock Agent Action Group.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.bedrock.AgentAgentActionGroup("example", {
        actionGroupName: "example",
        agentId: "GGRRAED6JP",
        agentVersion: "DRAFT",
        skipResourceInUseCheck: true,
        actionGroupExecutor: {
            lambda: "arn:aws:lambda:us-west-2:123456789012:function:example-function",
        },
        apiSchema: {
            s3: {
                s3BucketName: "example-bucket",
                s3ObjectKey: "path/to/schema.json",
            },
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.bedrock.AgentAgentActionGroup("example",
        action_group_name="example",
        agent_id="GGRRAED6JP",
        agent_version="DRAFT",
        skip_resource_in_use_check=True,
        action_group_executor=aws.bedrock.AgentAgentActionGroupActionGroupExecutorArgs(
            lambda_="arn:aws:lambda:us-west-2:123456789012:function:example-function",
        ),
        api_schema=aws.bedrock.AgentAgentActionGroupApiSchemaArgs(
            s3=aws.bedrock.AgentAgentActionGroupApiSchemaS3Args(
                s3_bucket_name="example-bucket",
                s3_object_key="path/to/schema.json",
            ),
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/bedrock"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := bedrock.NewAgentAgentActionGroup(ctx, "example", &bedrock.AgentAgentActionGroupArgs{
    			ActionGroupName:        pulumi.String("example"),
    			AgentId:                pulumi.String("GGRRAED6JP"),
    			AgentVersion:           pulumi.String("DRAFT"),
    			SkipResourceInUseCheck: pulumi.Bool(true),
    			ActionGroupExecutor: &bedrock.AgentAgentActionGroupActionGroupExecutorArgs{
    				Lambda: pulumi.String("arn:aws:lambda:us-west-2:123456789012:function:example-function"),
    			},
    			ApiSchema: &bedrock.AgentAgentActionGroupApiSchemaArgs{
    				S3: &bedrock.AgentAgentActionGroupApiSchemaS3Args{
    					S3BucketName: pulumi.String("example-bucket"),
    					S3ObjectKey:  pulumi.String("path/to/schema.json"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Bedrock.AgentAgentActionGroup("example", new()
        {
            ActionGroupName = "example",
            AgentId = "GGRRAED6JP",
            AgentVersion = "DRAFT",
            SkipResourceInUseCheck = true,
            ActionGroupExecutor = new Aws.Bedrock.Inputs.AgentAgentActionGroupActionGroupExecutorArgs
            {
                Lambda = "arn:aws:lambda:us-west-2:123456789012:function:example-function",
            },
            ApiSchema = new Aws.Bedrock.Inputs.AgentAgentActionGroupApiSchemaArgs
            {
                S3 = new Aws.Bedrock.Inputs.AgentAgentActionGroupApiSchemaS3Args
                {
                    S3BucketName = "example-bucket",
                    S3ObjectKey = "path/to/schema.json",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.bedrock.AgentAgentActionGroup;
    import com.pulumi.aws.bedrock.AgentAgentActionGroupArgs;
    import com.pulumi.aws.bedrock.inputs.AgentAgentActionGroupActionGroupExecutorArgs;
    import com.pulumi.aws.bedrock.inputs.AgentAgentActionGroupApiSchemaArgs;
    import com.pulumi.aws.bedrock.inputs.AgentAgentActionGroupApiSchemaS3Args;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new AgentAgentActionGroup("example", AgentAgentActionGroupArgs.builder()
                .actionGroupName("example")
                .agentId("GGRRAED6JP")
                .agentVersion("DRAFT")
                .skipResourceInUseCheck(true)
                .actionGroupExecutor(AgentAgentActionGroupActionGroupExecutorArgs.builder()
                    .lambda("arn:aws:lambda:us-west-2:123456789012:function:example-function")
                    .build())
                .apiSchema(AgentAgentActionGroupApiSchemaArgs.builder()
                    .s3(AgentAgentActionGroupApiSchemaS3Args.builder()
                        .s3BucketName("example-bucket")
                        .s3ObjectKey("path/to/schema.json")
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:bedrock:AgentAgentActionGroup
        properties:
          actionGroupName: example
          agentId: GGRRAED6JP
          agentVersion: DRAFT
          skipResourceInUseCheck: true
          actionGroupExecutor:
            lambda: arn:aws:lambda:us-west-2:123456789012:function:example-function
          apiSchema:
            s3:
              s3BucketName: example-bucket
              s3ObjectKey: path/to/schema.json
    

    Create AgentAgentActionGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AgentAgentActionGroup(name: string, args: AgentAgentActionGroupArgs, opts?: CustomResourceOptions);
    @overload
    def AgentAgentActionGroup(resource_name: str,
                              args: AgentAgentActionGroupArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def AgentAgentActionGroup(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              action_group_name: Optional[str] = None,
                              agent_id: Optional[str] = None,
                              agent_version: Optional[str] = None,
                              action_group_executor: Optional[AgentAgentActionGroupActionGroupExecutorArgs] = None,
                              action_group_state: Optional[str] = None,
                              api_schema: Optional[AgentAgentActionGroupApiSchemaArgs] = None,
                              description: Optional[str] = None,
                              parent_action_group_signature: Optional[str] = None,
                              skip_resource_in_use_check: Optional[bool] = None)
    func NewAgentAgentActionGroup(ctx *Context, name string, args AgentAgentActionGroupArgs, opts ...ResourceOption) (*AgentAgentActionGroup, error)
    public AgentAgentActionGroup(string name, AgentAgentActionGroupArgs args, CustomResourceOptions? opts = null)
    public AgentAgentActionGroup(String name, AgentAgentActionGroupArgs args)
    public AgentAgentActionGroup(String name, AgentAgentActionGroupArgs args, CustomResourceOptions options)
    
    type: aws:bedrock:AgentAgentActionGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AgentAgentActionGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AgentAgentActionGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AgentAgentActionGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AgentAgentActionGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AgentAgentActionGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var agentAgentActionGroupResource = new Aws.Bedrock.AgentAgentActionGroup("agentAgentActionGroupResource", new()
    {
        ActionGroupName = "string",
        AgentId = "string",
        AgentVersion = "string",
        ActionGroupExecutor = new Aws.Bedrock.Inputs.AgentAgentActionGroupActionGroupExecutorArgs
        {
            Lambda = "string",
        },
        ActionGroupState = "string",
        ApiSchema = new Aws.Bedrock.Inputs.AgentAgentActionGroupApiSchemaArgs
        {
            Payload = "string",
            S3 = new Aws.Bedrock.Inputs.AgentAgentActionGroupApiSchemaS3Args
            {
                S3BucketName = "string",
                S3ObjectKey = "string",
            },
        },
        Description = "string",
        ParentActionGroupSignature = "string",
        SkipResourceInUseCheck = false,
    });
    
    example, err := bedrock.NewAgentAgentActionGroup(ctx, "agentAgentActionGroupResource", &bedrock.AgentAgentActionGroupArgs{
    	ActionGroupName: pulumi.String("string"),
    	AgentId:         pulumi.String("string"),
    	AgentVersion:    pulumi.String("string"),
    	ActionGroupExecutor: &bedrock.AgentAgentActionGroupActionGroupExecutorArgs{
    		Lambda: pulumi.String("string"),
    	},
    	ActionGroupState: pulumi.String("string"),
    	ApiSchema: &bedrock.AgentAgentActionGroupApiSchemaArgs{
    		Payload: pulumi.String("string"),
    		S3: &bedrock.AgentAgentActionGroupApiSchemaS3Args{
    			S3BucketName: pulumi.String("string"),
    			S3ObjectKey:  pulumi.String("string"),
    		},
    	},
    	Description:                pulumi.String("string"),
    	ParentActionGroupSignature: pulumi.String("string"),
    	SkipResourceInUseCheck:     pulumi.Bool(false),
    })
    
    var agentAgentActionGroupResource = new AgentAgentActionGroup("agentAgentActionGroupResource", AgentAgentActionGroupArgs.builder()        
        .actionGroupName("string")
        .agentId("string")
        .agentVersion("string")
        .actionGroupExecutor(AgentAgentActionGroupActionGroupExecutorArgs.builder()
            .lambda("string")
            .build())
        .actionGroupState("string")
        .apiSchema(AgentAgentActionGroupApiSchemaArgs.builder()
            .payload("string")
            .s3(AgentAgentActionGroupApiSchemaS3Args.builder()
                .s3BucketName("string")
                .s3ObjectKey("string")
                .build())
            .build())
        .description("string")
        .parentActionGroupSignature("string")
        .skipResourceInUseCheck(false)
        .build());
    
    agent_agent_action_group_resource = aws.bedrock.AgentAgentActionGroup("agentAgentActionGroupResource",
        action_group_name="string",
        agent_id="string",
        agent_version="string",
        action_group_executor=aws.bedrock.AgentAgentActionGroupActionGroupExecutorArgs(
            lambda_="string",
        ),
        action_group_state="string",
        api_schema=aws.bedrock.AgentAgentActionGroupApiSchemaArgs(
            payload="string",
            s3=aws.bedrock.AgentAgentActionGroupApiSchemaS3Args(
                s3_bucket_name="string",
                s3_object_key="string",
            ),
        ),
        description="string",
        parent_action_group_signature="string",
        skip_resource_in_use_check=False)
    
    const agentAgentActionGroupResource = new aws.bedrock.AgentAgentActionGroup("agentAgentActionGroupResource", {
        actionGroupName: "string",
        agentId: "string",
        agentVersion: "string",
        actionGroupExecutor: {
            lambda: "string",
        },
        actionGroupState: "string",
        apiSchema: {
            payload: "string",
            s3: {
                s3BucketName: "string",
                s3ObjectKey: "string",
            },
        },
        description: "string",
        parentActionGroupSignature: "string",
        skipResourceInUseCheck: false,
    });
    
    type: aws:bedrock:AgentAgentActionGroup
    properties:
        actionGroupExecutor:
            lambda: string
        actionGroupName: string
        actionGroupState: string
        agentId: string
        agentVersion: string
        apiSchema:
            payload: string
            s3:
                s3BucketName: string
                s3ObjectKey: string
        description: string
        parentActionGroupSignature: string
        skipResourceInUseCheck: false
    

    AgentAgentActionGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AgentAgentActionGroup resource accepts the following input properties:

    ActionGroupName string
    Name of the action group.
    AgentId string
    The unique identifier of the agent for which to create the action group.
    AgentVersion string
    Version of the agent for which to create the action group. Valid values: DRAFT.
    ActionGroupExecutor AgentAgentActionGroupActionGroupExecutor
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action or custom control method for handling the information elicited from the user. See action_group_executor block for details.
    ActionGroupState string
    Whether the action group is available for the agent to invoke or not when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.
    ApiSchema AgentAgentActionGroupApiSchema

    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. See api_schema block for details.

    The following arguments are optional:

    Description string
    Description of the action group.
    ParentActionGroupSignature string
    To allow your agent to request the user for additional information when trying to complete a task, set this argument to AMAZON.UserInput. You must leave the description, api_schema, and action_group_executor arguments blank for this action group. Valid values: AMAZON.UserInput.
    SkipResourceInUseCheck bool
    Whether the in-use check is skipped when deleting the action group.
    ActionGroupName string
    Name of the action group.
    AgentId string
    The unique identifier of the agent for which to create the action group.
    AgentVersion string
    Version of the agent for which to create the action group. Valid values: DRAFT.
    ActionGroupExecutor AgentAgentActionGroupActionGroupExecutorArgs
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action or custom control method for handling the information elicited from the user. See action_group_executor block for details.
    ActionGroupState string
    Whether the action group is available for the agent to invoke or not when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.
    ApiSchema AgentAgentActionGroupApiSchemaArgs

    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. See api_schema block for details.

    The following arguments are optional:

    Description string
    Description of the action group.
    ParentActionGroupSignature string
    To allow your agent to request the user for additional information when trying to complete a task, set this argument to AMAZON.UserInput. You must leave the description, api_schema, and action_group_executor arguments blank for this action group. Valid values: AMAZON.UserInput.
    SkipResourceInUseCheck bool
    Whether the in-use check is skipped when deleting the action group.
    actionGroupName String
    Name of the action group.
    agentId String
    The unique identifier of the agent for which to create the action group.
    agentVersion String
    Version of the agent for which to create the action group. Valid values: DRAFT.
    actionGroupExecutor AgentAgentActionGroupActionGroupExecutor
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action or custom control method for handling the information elicited from the user. See action_group_executor block for details.
    actionGroupState String
    Whether the action group is available for the agent to invoke or not when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.
    apiSchema AgentAgentActionGroupApiSchema

    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. See api_schema block for details.

    The following arguments are optional:

    description String
    Description of the action group.
    parentActionGroupSignature String
    To allow your agent to request the user for additional information when trying to complete a task, set this argument to AMAZON.UserInput. You must leave the description, api_schema, and action_group_executor arguments blank for this action group. Valid values: AMAZON.UserInput.
    skipResourceInUseCheck Boolean
    Whether the in-use check is skipped when deleting the action group.
    actionGroupName string
    Name of the action group.
    agentId string
    The unique identifier of the agent for which to create the action group.
    agentVersion string
    Version of the agent for which to create the action group. Valid values: DRAFT.
    actionGroupExecutor AgentAgentActionGroupActionGroupExecutor
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action or custom control method for handling the information elicited from the user. See action_group_executor block for details.
    actionGroupState string
    Whether the action group is available for the agent to invoke or not when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.
    apiSchema AgentAgentActionGroupApiSchema

    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. See api_schema block for details.

    The following arguments are optional:

    description string
    Description of the action group.
    parentActionGroupSignature string
    To allow your agent to request the user for additional information when trying to complete a task, set this argument to AMAZON.UserInput. You must leave the description, api_schema, and action_group_executor arguments blank for this action group. Valid values: AMAZON.UserInput.
    skipResourceInUseCheck boolean
    Whether the in-use check is skipped when deleting the action group.
    action_group_name str
    Name of the action group.
    agent_id str
    The unique identifier of the agent for which to create the action group.
    agent_version str
    Version of the agent for which to create the action group. Valid values: DRAFT.
    action_group_executor AgentAgentActionGroupActionGroupExecutorArgs
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action or custom control method for handling the information elicited from the user. See action_group_executor block for details.
    action_group_state str
    Whether the action group is available for the agent to invoke or not when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.
    api_schema AgentAgentActionGroupApiSchemaArgs

    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. See api_schema block for details.

    The following arguments are optional:

    description str
    Description of the action group.
    parent_action_group_signature str
    To allow your agent to request the user for additional information when trying to complete a task, set this argument to AMAZON.UserInput. You must leave the description, api_schema, and action_group_executor arguments blank for this action group. Valid values: AMAZON.UserInput.
    skip_resource_in_use_check bool
    Whether the in-use check is skipped when deleting the action group.
    actionGroupName String
    Name of the action group.
    agentId String
    The unique identifier of the agent for which to create the action group.
    agentVersion String
    Version of the agent for which to create the action group. Valid values: DRAFT.
    actionGroupExecutor Property Map
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action or custom control method for handling the information elicited from the user. See action_group_executor block for details.
    actionGroupState String
    Whether the action group is available for the agent to invoke or not when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.
    apiSchema Property Map

    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. See api_schema block for details.

    The following arguments are optional:

    description String
    Description of the action group.
    parentActionGroupSignature String
    To allow your agent to request the user for additional information when trying to complete a task, set this argument to AMAZON.UserInput. You must leave the description, api_schema, and action_group_executor arguments blank for this action group. Valid values: AMAZON.UserInput.
    skipResourceInUseCheck Boolean
    Whether the in-use check is skipped when deleting the action group.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AgentAgentActionGroup resource produces the following output properties:

    ActionGroupId string
    Unique identifier of the action group.
    Id string
    The provider-assigned unique ID for this managed resource.
    ActionGroupId string
    Unique identifier of the action group.
    Id string
    The provider-assigned unique ID for this managed resource.
    actionGroupId String
    Unique identifier of the action group.
    id String
    The provider-assigned unique ID for this managed resource.
    actionGroupId string
    Unique identifier of the action group.
    id string
    The provider-assigned unique ID for this managed resource.
    action_group_id str
    Unique identifier of the action group.
    id str
    The provider-assigned unique ID for this managed resource.
    actionGroupId String
    Unique identifier of the action group.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AgentAgentActionGroup Resource

    Get an existing AgentAgentActionGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AgentAgentActionGroupState, opts?: CustomResourceOptions): AgentAgentActionGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            action_group_executor: Optional[AgentAgentActionGroupActionGroupExecutorArgs] = None,
            action_group_id: Optional[str] = None,
            action_group_name: Optional[str] = None,
            action_group_state: Optional[str] = None,
            agent_id: Optional[str] = None,
            agent_version: Optional[str] = None,
            api_schema: Optional[AgentAgentActionGroupApiSchemaArgs] = None,
            description: Optional[str] = None,
            parent_action_group_signature: Optional[str] = None,
            skip_resource_in_use_check: Optional[bool] = None) -> AgentAgentActionGroup
    func GetAgentAgentActionGroup(ctx *Context, name string, id IDInput, state *AgentAgentActionGroupState, opts ...ResourceOption) (*AgentAgentActionGroup, error)
    public static AgentAgentActionGroup Get(string name, Input<string> id, AgentAgentActionGroupState? state, CustomResourceOptions? opts = null)
    public static AgentAgentActionGroup get(String name, Output<String> id, AgentAgentActionGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ActionGroupExecutor AgentAgentActionGroupActionGroupExecutor
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action or custom control method for handling the information elicited from the user. See action_group_executor block for details.
    ActionGroupId string
    Unique identifier of the action group.
    ActionGroupName string
    Name of the action group.
    ActionGroupState string
    Whether the action group is available for the agent to invoke or not when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.
    AgentId string
    The unique identifier of the agent for which to create the action group.
    AgentVersion string
    Version of the agent for which to create the action group. Valid values: DRAFT.
    ApiSchema AgentAgentActionGroupApiSchema

    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. See api_schema block for details.

    The following arguments are optional:

    Description string
    Description of the action group.
    ParentActionGroupSignature string
    To allow your agent to request the user for additional information when trying to complete a task, set this argument to AMAZON.UserInput. You must leave the description, api_schema, and action_group_executor arguments blank for this action group. Valid values: AMAZON.UserInput.
    SkipResourceInUseCheck bool
    Whether the in-use check is skipped when deleting the action group.
    ActionGroupExecutor AgentAgentActionGroupActionGroupExecutorArgs
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action or custom control method for handling the information elicited from the user. See action_group_executor block for details.
    ActionGroupId string
    Unique identifier of the action group.
    ActionGroupName string
    Name of the action group.
    ActionGroupState string
    Whether the action group is available for the agent to invoke or not when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.
    AgentId string
    The unique identifier of the agent for which to create the action group.
    AgentVersion string
    Version of the agent for which to create the action group. Valid values: DRAFT.
    ApiSchema AgentAgentActionGroupApiSchemaArgs

    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. See api_schema block for details.

    The following arguments are optional:

    Description string
    Description of the action group.
    ParentActionGroupSignature string
    To allow your agent to request the user for additional information when trying to complete a task, set this argument to AMAZON.UserInput. You must leave the description, api_schema, and action_group_executor arguments blank for this action group. Valid values: AMAZON.UserInput.
    SkipResourceInUseCheck bool
    Whether the in-use check is skipped when deleting the action group.
    actionGroupExecutor AgentAgentActionGroupActionGroupExecutor
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action or custom control method for handling the information elicited from the user. See action_group_executor block for details.
    actionGroupId String
    Unique identifier of the action group.
    actionGroupName String
    Name of the action group.
    actionGroupState String
    Whether the action group is available for the agent to invoke or not when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.
    agentId String
    The unique identifier of the agent for which to create the action group.
    agentVersion String
    Version of the agent for which to create the action group. Valid values: DRAFT.
    apiSchema AgentAgentActionGroupApiSchema

    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. See api_schema block for details.

    The following arguments are optional:

    description String
    Description of the action group.
    parentActionGroupSignature String
    To allow your agent to request the user for additional information when trying to complete a task, set this argument to AMAZON.UserInput. You must leave the description, api_schema, and action_group_executor arguments blank for this action group. Valid values: AMAZON.UserInput.
    skipResourceInUseCheck Boolean
    Whether the in-use check is skipped when deleting the action group.
    actionGroupExecutor AgentAgentActionGroupActionGroupExecutor
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action or custom control method for handling the information elicited from the user. See action_group_executor block for details.
    actionGroupId string
    Unique identifier of the action group.
    actionGroupName string
    Name of the action group.
    actionGroupState string
    Whether the action group is available for the agent to invoke or not when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.
    agentId string
    The unique identifier of the agent for which to create the action group.
    agentVersion string
    Version of the agent for which to create the action group. Valid values: DRAFT.
    apiSchema AgentAgentActionGroupApiSchema

    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. See api_schema block for details.

    The following arguments are optional:

    description string
    Description of the action group.
    parentActionGroupSignature string
    To allow your agent to request the user for additional information when trying to complete a task, set this argument to AMAZON.UserInput. You must leave the description, api_schema, and action_group_executor arguments blank for this action group. Valid values: AMAZON.UserInput.
    skipResourceInUseCheck boolean
    Whether the in-use check is skipped when deleting the action group.
    action_group_executor AgentAgentActionGroupActionGroupExecutorArgs
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action or custom control method for handling the information elicited from the user. See action_group_executor block for details.
    action_group_id str
    Unique identifier of the action group.
    action_group_name str
    Name of the action group.
    action_group_state str
    Whether the action group is available for the agent to invoke or not when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.
    agent_id str
    The unique identifier of the agent for which to create the action group.
    agent_version str
    Version of the agent for which to create the action group. Valid values: DRAFT.
    api_schema AgentAgentActionGroupApiSchemaArgs

    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. See api_schema block for details.

    The following arguments are optional:

    description str
    Description of the action group.
    parent_action_group_signature str
    To allow your agent to request the user for additional information when trying to complete a task, set this argument to AMAZON.UserInput. You must leave the description, api_schema, and action_group_executor arguments blank for this action group. Valid values: AMAZON.UserInput.
    skip_resource_in_use_check bool
    Whether the in-use check is skipped when deleting the action group.
    actionGroupExecutor Property Map
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action or custom control method for handling the information elicited from the user. See action_group_executor block for details.
    actionGroupId String
    Unique identifier of the action group.
    actionGroupName String
    Name of the action group.
    actionGroupState String
    Whether the action group is available for the agent to invoke or not when sending an InvokeAgent request. Valid values: ENABLED, DISABLED.
    agentId String
    The unique identifier of the agent for which to create the action group.
    agentVersion String
    Version of the agent for which to create the action group. Valid values: DRAFT.
    apiSchema Property Map

    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. See api_schema block for details.

    The following arguments are optional:

    description String
    Description of the action group.
    parentActionGroupSignature String
    To allow your agent to request the user for additional information when trying to complete a task, set this argument to AMAZON.UserInput. You must leave the description, api_schema, and action_group_executor arguments blank for this action group. Valid values: AMAZON.UserInput.
    skipResourceInUseCheck Boolean
    Whether the in-use check is skipped when deleting the action group.

    Supporting Types

    AgentAgentActionGroupActionGroupExecutor, AgentAgentActionGroupActionGroupExecutorArgs

    Lambda string
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
    Lambda string
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
    lambda String
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
    lambda string
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
    lambda_ str
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
    lambda String
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action.

    AgentAgentActionGroupApiSchema, AgentAgentActionGroupApiSchemaArgs

    Payload string
    JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
    S3 AgentAgentActionGroupApiSchemaS3
    Details about the S3 object containing the OpenAPI schema for the action group. See s3 block for details.
    Payload string
    JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
    S3 AgentAgentActionGroupApiSchemaS3
    Details about the S3 object containing the OpenAPI schema for the action group. See s3 block for details.
    payload String
    JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
    s3 AgentAgentActionGroupApiSchemaS3
    Details about the S3 object containing the OpenAPI schema for the action group. See s3 block for details.
    payload string
    JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
    s3 AgentAgentActionGroupApiSchemaS3
    Details about the S3 object containing the OpenAPI schema for the action group. See s3 block for details.
    payload str
    JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
    s3 AgentAgentActionGroupApiSchemaS3
    Details about the S3 object containing the OpenAPI schema for the action group. See s3 block for details.
    payload String
    JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
    s3 Property Map
    Details about the S3 object containing the OpenAPI schema for the action group. See s3 block for details.

    AgentAgentActionGroupApiSchemaS3, AgentAgentActionGroupApiSchemaS3Args

    S3BucketName string
    Name of the S3 bucket.
    S3ObjectKey string
    S3 object key containing the resource.
    S3BucketName string
    Name of the S3 bucket.
    S3ObjectKey string
    S3 object key containing the resource.
    s3BucketName String
    Name of the S3 bucket.
    s3ObjectKey String
    S3 object key containing the resource.
    s3BucketName string
    Name of the S3 bucket.
    s3ObjectKey string
    S3 object key containing the resource.
    s3_bucket_name str
    Name of the S3 bucket.
    s3_object_key str
    S3 object key containing the resource.
    s3BucketName String
    Name of the S3 bucket.
    s3ObjectKey String
    S3 object key containing the resource.

    Import

    Using pulumi import, import Agents for Amazon Bedrock Agent Action Group the action group ID, the agent ID, and the agent version separated by ,. For example:

    $ pulumi import aws:bedrock/agentAgentActionGroup:AgentAgentActionGroup example MMAUDBZTH4,GGRRAED6JP,DRAFT
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.37.1 published on Friday, May 24, 2024 by Pulumi