Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. bedrock
  5. AgentAgentActionGroup
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.bedrock.AgentAgentActionGroup

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    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";
import * as std from "@pulumi/std";

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: {
        payload: std.file({
            input: "path/to/schema.yaml",
        }).then(invoke => invoke.result),
    },
});

    import pulumi
import pulumi_aws as aws
import pulumi_std as std

example = aws.bedrock.AgentAgentActionGroup("example",
    action_group_name="example",
    agent_id="GGRRAED6JP",
    agent_version="DRAFT",
    skip_resource_in_use_check=True,
    action_group_executor={
        "lambda_": "arn:aws:lambda:us-west-2:123456789012:function:example-function",
    },
    api_schema={
        "payload": std.file(input="path/to/schema.yaml").result,
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/bedrock"
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		invokeFile, err := std.File(ctx, &std.FileArgs{
			Input: "path/to/schema.yaml",
		}, nil)
		if err != nil {
			return err
		}
		_, 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{
				Payload: pulumi.String(invokeFile.Result),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Std = Pulumi.Std;

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
        {
            Payload = Std.File.Invoke(new()
            {
                Input = "path/to/schema.yaml",
            }).Apply(invoke => invoke.Result),
        },
    });

});

    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 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()
                .payload(StdFunctions.file(FileArgs.builder()
                    .input("path/to/schema.yaml")
                    .build()).result())
                .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:
        payload:
          fn::invoke:
            Function: std:file
            Arguments:
              input: path/to/schema.yaml
            Return: result

    API Schema in S3 Bucket

    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={
        "lambda_": "arn:aws:lambda:us-west-2:123456789012:function:example-function",
    },
    api_schema={
        "s3": {
            "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

    Function Schema (Simplified Schema)

    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",
    },
    functionSchema: {
        memberFunctions: {
            functions: [{
                name: "example-function",
                description: "Example function",
                parameters: [
                    {
                        mapBlockKey: "param1",
                        type: "string",
                        description: "The first parameter",
                        required: true,
                    },
                    {
                        mapBlockKey: "param2",
                        type: "integer",
                        description: "The second parameter",
                        required: false,
                    },
                ],
            }],
        },
    },
});

    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={
        "lambda_": "arn:aws:lambda:us-west-2:123456789012:function:example-function",
    },
    function_schema={
        "member_functions": {
            "functions": [{
                "name": "example-function",
                "description": "Example function",
                "parameters": [
                    {
                        "map_block_key": "param1",
                        "type": "string",
                        "description": "The first parameter",
                        "required": True,
                    },
                    {
                        "map_block_key": "param2",
                        "type": "integer",
                        "description": "The second parameter",
                        "required": False,
                    },
                ],
            }],
        },
    })

    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"),
			},
			FunctionSchema: &bedrock.AgentAgentActionGroupFunctionSchemaArgs{
				MemberFunctions: &bedrock.AgentAgentActionGroupFunctionSchemaMemberFunctionsArgs{
					Functions: bedrock.AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionArray{
						&bedrock.AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionArgs{
							Name:        pulumi.String("example-function"),
							Description: pulumi.String("Example function"),
							Parameters: bedrock.AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameterArray{
								&bedrock.AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameterArgs{
									MapBlockKey: pulumi.String("param1"),
									Type:        pulumi.String("string"),
									Description: pulumi.String("The first parameter"),
									Required:    pulumi.Bool(true),
								},
								&bedrock.AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameterArgs{
									MapBlockKey: pulumi.String("param2"),
									Type:        pulumi.String("integer"),
									Description: pulumi.String("The second parameter"),
									Required:    pulumi.Bool(false),
								},
							},
						},
					},
				},
			},
		})
		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",
        },
        FunctionSchema = new Aws.Bedrock.Inputs.AgentAgentActionGroupFunctionSchemaArgs
        {
            MemberFunctions = new Aws.Bedrock.Inputs.AgentAgentActionGroupFunctionSchemaMemberFunctionsArgs
            {
                Functions = new[]
                {
                    new Aws.Bedrock.Inputs.AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionArgs
                    {
                        Name = "example-function",
                        Description = "Example function",
                        Parameters = new[]
                        {
                            new Aws.Bedrock.Inputs.AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameterArgs
                            {
                                MapBlockKey = "param1",
                                Type = "string",
                                Description = "The first parameter",
                                Required = true,
                            },
                            new Aws.Bedrock.Inputs.AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameterArgs
                            {
                                MapBlockKey = "param2",
                                Type = "integer",
                                Description = "The second parameter",
                                Required = false,
                            },
                        },
                    },
                },
            },
        },
    });

});

    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.AgentAgentActionGroupFunctionSchemaArgs;
import com.pulumi.aws.bedrock.inputs.AgentAgentActionGroupFunctionSchemaMemberFunctionsArgs;
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())
            .functionSchema(AgentAgentActionGroupFunctionSchemaArgs.builder()
                .memberFunctions(AgentAgentActionGroupFunctionSchemaMemberFunctionsArgs.builder()
                    .functions(AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionArgs.builder()
                        .name("example-function")
                        .description("Example function")
                        .parameters(                        
                            AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameterArgs.builder()
                                .mapBlockKey("param1")
                                .type("string")
                                .description("The first parameter")
                                .required(true)
                                .build(),
                            AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameterArgs.builder()
                                .mapBlockKey("param2")
                                .type("integer")
                                .description("The second parameter")
                                .required(false)
                                .build())
                        .build())
                    .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
      functionSchema:
        memberFunctions:
          functions:
            - name: example-function
              description: Example function
              parameters:
                - mapBlockKey: param1
                  type: string
                  description: The first parameter
                  required: true
                - mapBlockKey: param2
                  type: integer
                  description: The second parameter
                  required: false

    Return of Control

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as std from "@pulumi/std";

const example = new aws.bedrock.AgentAgentActionGroup("example", {
    actionGroupName: "example",
    agentId: "GGRRAED6JP",
    agentVersion: "DRAFT",
    skipResourceInUseCheck: true,
    actionGroupExecutor: {
        customControl: "RETURN_CONTROL",
    },
    apiSchema: {
        payload: std.file({
            input: "path/to/schema.yaml",
        }).then(invoke => invoke.result),
    },
});

    import pulumi
import pulumi_aws as aws
import pulumi_std as std

example = aws.bedrock.AgentAgentActionGroup("example",
    action_group_name="example",
    agent_id="GGRRAED6JP",
    agent_version="DRAFT",
    skip_resource_in_use_check=True,
    action_group_executor={
        "custom_control": "RETURN_CONTROL",
    },
    api_schema={
        "payload": std.file(input="path/to/schema.yaml").result,
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/bedrock"
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		invokeFile, err := std.File(ctx, &std.FileArgs{
			Input: "path/to/schema.yaml",
		}, nil)
		if err != nil {
			return err
		}
		_, 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{
				CustomControl: pulumi.String("RETURN_CONTROL"),
			},
			ApiSchema: &bedrock.AgentAgentActionGroupApiSchemaArgs{
				Payload: pulumi.String(invokeFile.Result),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Std = Pulumi.Std;

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
        {
            CustomControl = "RETURN_CONTROL",
        },
        ApiSchema = new Aws.Bedrock.Inputs.AgentAgentActionGroupApiSchemaArgs
        {
            Payload = Std.File.Invoke(new()
            {
                Input = "path/to/schema.yaml",
            }).Apply(invoke => invoke.Result),
        },
    });

});

    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 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()
                .customControl("RETURN_CONTROL")
                .build())
            .apiSchema(AgentAgentActionGroupApiSchemaArgs.builder()
                .payload(StdFunctions.file(FileArgs.builder()
                    .input("path/to/schema.yaml")
                    .build()).result())
                .build())
            .build());

    }
}

    resources:
  example:
    type: aws:bedrock:AgentAgentActionGroup
    properties:
      actionGroupName: example
      agentId: GGRRAED6JP
      agentVersion: DRAFT
      skipResourceInUseCheck: true
      actionGroupExecutor:
        customControl: RETURN_CONTROL
      apiSchema:
        payload:
          fn::invoke:
            Function: std:file
            Arguments:
              input: path/to/schema.yaml
            Return: result

    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,
                          function_schema: Optional[AgentAgentActionGroupFunctionSchemaArgs] = None,
                          parent_action_group_signature: Optional[str] = None,
                          prepare_agent: Optional[bool] = None,
                          skip_resource_in_use_check: Optional[bool] = None,
                          timeouts: Optional[AgentAgentActionGroupTimeoutsArgs] = 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.

    Constructor 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
    {
        CustomControl = "string",
        Lambda = "string",
    },
    ActionGroupState = "string",
    ApiSchema = new Aws.Bedrock.Inputs.AgentAgentActionGroupApiSchemaArgs
    {
        Payload = "string",
        S3 = new Aws.Bedrock.Inputs.AgentAgentActionGroupApiSchemaS3Args
        {
            S3BucketName = "string",
            S3ObjectKey = "string",
        },
    },
    Description = "string",
    FunctionSchema = new Aws.Bedrock.Inputs.AgentAgentActionGroupFunctionSchemaArgs
    {
        MemberFunctions = new Aws.Bedrock.Inputs.AgentAgentActionGroupFunctionSchemaMemberFunctionsArgs
        {
            Functions = new[]
            {
                new Aws.Bedrock.Inputs.AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionArgs
                {
                    Name = "string",
                    Description = "string",
                    Parameters = new[]
                    {
                        new Aws.Bedrock.Inputs.AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameterArgs
                        {
                            MapBlockKey = "string",
                            Type = "string",
                            Description = "string",
                            Required = false,
                        },
                    },
                },
            },
        },
    },
    ParentActionGroupSignature = "string",
    PrepareAgent = false,
    SkipResourceInUseCheck = false,
    Timeouts = new Aws.Bedrock.Inputs.AgentAgentActionGroupTimeoutsArgs
    {
        Create = "string",
        Update = "string",
    },
});

    example, err := bedrock.NewAgentAgentActionGroup(ctx, "agentAgentActionGroupResource", &bedrock.AgentAgentActionGroupArgs{
	ActionGroupName: pulumi.String("string"),
	AgentId:         pulumi.String("string"),
	AgentVersion:    pulumi.String("string"),
	ActionGroupExecutor: &bedrock.AgentAgentActionGroupActionGroupExecutorArgs{
		CustomControl: pulumi.String("string"),
		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"),
	FunctionSchema: &bedrock.AgentAgentActionGroupFunctionSchemaArgs{
		MemberFunctions: &bedrock.AgentAgentActionGroupFunctionSchemaMemberFunctionsArgs{
			Functions: bedrock.AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionArray{
				&bedrock.AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionArgs{
					Name:        pulumi.String("string"),
					Description: pulumi.String("string"),
					Parameters: bedrock.AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameterArray{
						&bedrock.AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameterArgs{
							MapBlockKey: pulumi.String("string"),
							Type:        pulumi.String("string"),
							Description: pulumi.String("string"),
							Required:    pulumi.Bool(false),
						},
					},
				},
			},
		},
	},
	ParentActionGroupSignature: pulumi.String("string"),
	PrepareAgent:               pulumi.Bool(false),
	SkipResourceInUseCheck:     pulumi.Bool(false),
	Timeouts: &bedrock.AgentAgentActionGroupTimeoutsArgs{
		Create: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var agentAgentActionGroupResource = new AgentAgentActionGroup("agentAgentActionGroupResource", AgentAgentActionGroupArgs.builder()
    .actionGroupName("string")
    .agentId("string")
    .agentVersion("string")
    .actionGroupExecutor(AgentAgentActionGroupActionGroupExecutorArgs.builder()
        .customControl("string")
        .lambda("string")
        .build())
    .actionGroupState("string")
    .apiSchema(AgentAgentActionGroupApiSchemaArgs.builder()
        .payload("string")
        .s3(AgentAgentActionGroupApiSchemaS3Args.builder()
            .s3BucketName("string")
            .s3ObjectKey("string")
            .build())
        .build())
    .description("string")
    .functionSchema(AgentAgentActionGroupFunctionSchemaArgs.builder()
        .memberFunctions(AgentAgentActionGroupFunctionSchemaMemberFunctionsArgs.builder()
            .functions(AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionArgs.builder()
                .name("string")
                .description("string")
                .parameters(AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameterArgs.builder()
                    .mapBlockKey("string")
                    .type("string")
                    .description("string")
                    .required(false)
                    .build())
                .build())
            .build())
        .build())
    .parentActionGroupSignature("string")
    .prepareAgent(false)
    .skipResourceInUseCheck(false)
    .timeouts(AgentAgentActionGroupTimeoutsArgs.builder()
        .create("string")
        .update("string")
        .build())
    .build());

    agent_agent_action_group_resource = aws.bedrock.AgentAgentActionGroup("agentAgentActionGroupResource",
    action_group_name="string",
    agent_id="string",
    agent_version="string",
    action_group_executor={
        "custom_control": "string",
        "lambda_": "string",
    },
    action_group_state="string",
    api_schema={
        "payload": "string",
        "s3": {
            "s3_bucket_name": "string",
            "s3_object_key": "string",
        },
    },
    description="string",
    function_schema={
        "member_functions": {
            "functions": [{
                "name": "string",
                "description": "string",
                "parameters": [{
                    "map_block_key": "string",
                    "type": "string",
                    "description": "string",
                    "required": False,
                }],
            }],
        },
    },
    parent_action_group_signature="string",
    prepare_agent=False,
    skip_resource_in_use_check=False,
    timeouts={
        "create": "string",
        "update": "string",
    })

    const agentAgentActionGroupResource = new aws.bedrock.AgentAgentActionGroup("agentAgentActionGroupResource", {
    actionGroupName: "string",
    agentId: "string",
    agentVersion: "string",
    actionGroupExecutor: {
        customControl: "string",
        lambda: "string",
    },
    actionGroupState: "string",
    apiSchema: {
        payload: "string",
        s3: {
            s3BucketName: "string",
            s3ObjectKey: "string",
        },
    },
    description: "string",
    functionSchema: {
        memberFunctions: {
            functions: [{
                name: "string",
                description: "string",
                parameters: [{
                    mapBlockKey: "string",
                    type: "string",
                    description: "string",
                    required: false,
                }],
            }],
        },
    },
    parentActionGroupSignature: "string",
    prepareAgent: false,
    skipResourceInUseCheck: false,
    timeouts: {
        create: "string",
        update: "string",
    },
});

    type: aws:bedrock:AgentAgentActionGroup
properties:
    actionGroupExecutor:
        customControl: string
        lambda: string
    actionGroupName: string
    actionGroupState: string
    agentId: string
    agentVersion: string
    apiSchema:
        payload: string
        s3:
            s3BucketName: string
            s3ObjectKey: string
    description: string
    functionSchema:
        memberFunctions:
            functions:
                - description: string
                  name: string
                  parameters:
                    - description: string
                      mapBlockKey: string
                      required: false
                      type: string
    parentActionGroupSignature: string
    prepareAgent: false
    skipResourceInUseCheck: false
    timeouts:
        create: string
        update: string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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.

    The following arguments are optional:

    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.
    Description string
    Description of the action group.
    FunctionSchema AgentAgentActionGroupFunctionSchema
    Describes the function schema for the action group. Each function represents an action in an action group. See function_schema Block for details.
    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.
    PrepareAgent bool
    Whether or not to prepare the agent after creation or modification. Defaults to true.
    SkipResourceInUseCheck bool
    Whether the in-use check is skipped when deleting the action group.
    Timeouts AgentAgentActionGroupTimeouts
    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.

    The following arguments are optional:

    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.
    Description string
    Description of the action group.
    FunctionSchema AgentAgentActionGroupFunctionSchemaArgs
    Describes the function schema for the action group. Each function represents an action in an action group. See function_schema Block for details.
    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.
    PrepareAgent bool
    Whether or not to prepare the agent after creation or modification. Defaults to true.
    SkipResourceInUseCheck bool
    Whether the in-use check is skipped when deleting the action group.
    Timeouts AgentAgentActionGroupTimeoutsArgs
    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.

    The following arguments are optional:

    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.
    description String
    Description of the action group.
    functionSchema AgentAgentActionGroupFunctionSchema
    Describes the function schema for the action group. Each function represents an action in an action group. See function_schema Block for details.
    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.
    prepareAgent Boolean
    Whether or not to prepare the agent after creation or modification. Defaults to true.
    skipResourceInUseCheck Boolean
    Whether the in-use check is skipped when deleting the action group.
    timeouts AgentAgentActionGroupTimeouts
    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.

    The following arguments are optional:

    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.
    description string
    Description of the action group.
    functionSchema AgentAgentActionGroupFunctionSchema
    Describes the function schema for the action group. Each function represents an action in an action group. See function_schema Block for details.
    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.
    prepareAgent boolean
    Whether or not to prepare the agent after creation or modification. Defaults to true.
    skipResourceInUseCheck boolean
    Whether the in-use check is skipped when deleting the action group.
    timeouts AgentAgentActionGroupTimeouts
    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.

    The following arguments are optional:

    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.
    description str
    Description of the action group.
    function_schema AgentAgentActionGroupFunctionSchemaArgs
    Describes the function schema for the action group. Each function represents an action in an action group. See function_schema Block for details.
    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.
    prepare_agent bool
    Whether or not to prepare the agent after creation or modification. Defaults to true.
    skip_resource_in_use_check bool
    Whether the in-use check is skipped when deleting the action group.
    timeouts AgentAgentActionGroupTimeoutsArgs
    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.

    The following arguments are optional:

    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.
    description String
    Description of the action group.
    functionSchema Property Map
    Describes the function schema for the action group. Each function represents an action in an action group. See function_schema Block for details.
    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.
    prepareAgent Boolean
    Whether or not to prepare the agent after creation or modification. Defaults to true.
    skipResourceInUseCheck Boolean
    Whether the in-use check is skipped when deleting the action group.
    timeouts Property Map

    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,
        function_schema: Optional[AgentAgentActionGroupFunctionSchemaArgs] = None,
        parent_action_group_signature: Optional[str] = None,
        prepare_agent: Optional[bool] = None,
        skip_resource_in_use_check: Optional[bool] = None,
        timeouts: Optional[AgentAgentActionGroupTimeoutsArgs] = 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.

    The following arguments are optional:

    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.
    Description string
    Description of the action group.
    FunctionSchema AgentAgentActionGroupFunctionSchema
    Describes the function schema for the action group. Each function represents an action in an action group. See function_schema Block for details.
    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.
    PrepareAgent bool
    Whether or not to prepare the agent after creation or modification. Defaults to true.
    SkipResourceInUseCheck bool
    Whether the in-use check is skipped when deleting the action group.
    Timeouts AgentAgentActionGroupTimeouts
    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.

    The following arguments are optional:

    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.
    Description string
    Description of the action group.
    FunctionSchema AgentAgentActionGroupFunctionSchemaArgs
    Describes the function schema for the action group. Each function represents an action in an action group. See function_schema Block for details.
    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.
    PrepareAgent bool
    Whether or not to prepare the agent after creation or modification. Defaults to true.
    SkipResourceInUseCheck bool
    Whether the in-use check is skipped when deleting the action group.
    Timeouts AgentAgentActionGroupTimeoutsArgs
    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.

    The following arguments are optional:

    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.
    description String
    Description of the action group.
    functionSchema AgentAgentActionGroupFunctionSchema
    Describes the function schema for the action group. Each function represents an action in an action group. See function_schema Block for details.
    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.
    prepareAgent Boolean
    Whether or not to prepare the agent after creation or modification. Defaults to true.
    skipResourceInUseCheck Boolean
    Whether the in-use check is skipped when deleting the action group.
    timeouts AgentAgentActionGroupTimeouts
    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.

    The following arguments are optional:

    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.
    description string
    Description of the action group.
    functionSchema AgentAgentActionGroupFunctionSchema
    Describes the function schema for the action group. Each function represents an action in an action group. See function_schema Block for details.
    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.
    prepareAgent boolean
    Whether or not to prepare the agent after creation or modification. Defaults to true.
    skipResourceInUseCheck boolean
    Whether the in-use check is skipped when deleting the action group.
    timeouts AgentAgentActionGroupTimeouts
    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.

    The following arguments are optional:

    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.
    description str
    Description of the action group.
    function_schema AgentAgentActionGroupFunctionSchemaArgs
    Describes the function schema for the action group. Each function represents an action in an action group. See function_schema Block for details.
    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.
    prepare_agent bool
    Whether or not to prepare the agent after creation or modification. Defaults to true.
    skip_resource_in_use_check bool
    Whether the in-use check is skipped when deleting the action group.
    timeouts AgentAgentActionGroupTimeoutsArgs
    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.

    The following arguments are optional:

    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.
    description String
    Description of the action group.
    functionSchema Property Map
    Describes the function schema for the action group. Each function represents an action in an action group. See function_schema Block for details.
    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.
    prepareAgent Boolean
    Whether or not to prepare the agent after creation or modification. Defaults to true.
    skipResourceInUseCheck Boolean
    Whether the in-use check is skipped when deleting the action group.
    timeouts Property Map

    Supporting Types

    AgentAgentActionGroupActionGroupExecutor, AgentAgentActionGroupActionGroupExecutorArgs

    CustomControl string
    Custom control method for handling the information elicited from the user. Valid values: RETURN_CONTROL. To skip using a Lambda function and instead return the predicted action group, in addition to the parameters and information required for it, in the InvokeAgent response, specify RETURN_CONTROL. Only one of custom_control or lambda can be specified.
    Lambda string
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action. Only one of lambda or custom_control can be specified.
    CustomControl string
    Custom control method for handling the information elicited from the user. Valid values: RETURN_CONTROL. To skip using a Lambda function and instead return the predicted action group, in addition to the parameters and information required for it, in the InvokeAgent response, specify RETURN_CONTROL. Only one of custom_control or lambda can be specified.
    Lambda string
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action. Only one of lambda or custom_control can be specified.
    customControl String
    Custom control method for handling the information elicited from the user. Valid values: RETURN_CONTROL. To skip using a Lambda function and instead return the predicted action group, in addition to the parameters and information required for it, in the InvokeAgent response, specify RETURN_CONTROL. Only one of custom_control or lambda can be specified.
    lambda String
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action. Only one of lambda or custom_control can be specified.
    customControl string
    Custom control method for handling the information elicited from the user. Valid values: RETURN_CONTROL. To skip using a Lambda function and instead return the predicted action group, in addition to the parameters and information required for it, in the InvokeAgent response, specify RETURN_CONTROL. Only one of custom_control or lambda can be specified.
    lambda string
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action. Only one of lambda or custom_control can be specified.
    custom_control str
    Custom control method for handling the information elicited from the user. Valid values: RETURN_CONTROL. To skip using a Lambda function and instead return the predicted action group, in addition to the parameters and information required for it, in the InvokeAgent response, specify RETURN_CONTROL. Only one of custom_control or lambda can be specified.
    lambda_ str
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action. Only one of lambda or custom_control can be specified.
    customControl String
    Custom control method for handling the information elicited from the user. Valid values: RETURN_CONTROL. To skip using a Lambda function and instead return the predicted action group, in addition to the parameters and information required for it, in the InvokeAgent response, specify RETURN_CONTROL. Only one of custom_control or lambda can be specified.
    lambda String
    ARN of the Lambda function containing the business logic that is carried out upon invoking the action. Only one of lambda or custom_control can be specified.

    AgentAgentActionGroupApiSchema, AgentAgentActionGroupApiSchemaArgs

    Payload string
    JSON or YAML-formatted payload defining the OpenAPI schema for the action group. Only one of payload or s3 can be specified.
    S3 AgentAgentActionGroupApiSchemaS3
    Details about the S3 object containing the OpenAPI schema for the action group. See s3 Block for details. Only one of s3 or payload can be specified.
    Payload string
    JSON or YAML-formatted payload defining the OpenAPI schema for the action group. Only one of payload or s3 can be specified.
    S3 AgentAgentActionGroupApiSchemaS3
    Details about the S3 object containing the OpenAPI schema for the action group. See s3 Block for details. Only one of s3 or payload can be specified.
    payload String
    JSON or YAML-formatted payload defining the OpenAPI schema for the action group. Only one of payload or s3 can be specified.
    s3 AgentAgentActionGroupApiSchemaS3
    Details about the S3 object containing the OpenAPI schema for the action group. See s3 Block for details. Only one of s3 or payload can be specified.
    payload string
    JSON or YAML-formatted payload defining the OpenAPI schema for the action group. Only one of payload or s3 can be specified.
    s3 AgentAgentActionGroupApiSchemaS3
    Details about the S3 object containing the OpenAPI schema for the action group. See s3 Block for details. Only one of s3 or payload can be specified.
    payload str
    JSON or YAML-formatted payload defining the OpenAPI schema for the action group. Only one of payload or s3 can be specified.
    s3 AgentAgentActionGroupApiSchemaS3
    Details about the S3 object containing the OpenAPI schema for the action group. See s3 Block for details. Only one of s3 or payload can be specified.
    payload String
    JSON or YAML-formatted payload defining the OpenAPI schema for the action group. Only one of payload or s3 can be specified.
    s3 Property Map
    Details about the S3 object containing the OpenAPI schema for the action group. See s3 Block for details. Only one of s3 or payload can be specified.

    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.

    AgentAgentActionGroupFunctionSchema, AgentAgentActionGroupFunctionSchemaArgs

    MemberFunctions AgentAgentActionGroupFunctionSchemaMemberFunctions
    Contains a list of functions. Each function describes and action in the action group. See member_functions Block for details.
    MemberFunctions AgentAgentActionGroupFunctionSchemaMemberFunctions
    Contains a list of functions. Each function describes and action in the action group. See member_functions Block for details.
    memberFunctions AgentAgentActionGroupFunctionSchemaMemberFunctions
    Contains a list of functions. Each function describes and action in the action group. See member_functions Block for details.
    memberFunctions AgentAgentActionGroupFunctionSchemaMemberFunctions
    Contains a list of functions. Each function describes and action in the action group. See member_functions Block for details.
    member_functions AgentAgentActionGroupFunctionSchemaMemberFunctions
    Contains a list of functions. Each function describes and action in the action group. See member_functions Block for details.
    memberFunctions Property Map
    Contains a list of functions. Each function describes and action in the action group. See member_functions Block for details.

    AgentAgentActionGroupFunctionSchemaMemberFunctions, AgentAgentActionGroupFunctionSchemaMemberFunctionsArgs

    Functions List<AgentAgentActionGroupFunctionSchemaMemberFunctionsFunction>
    Functions that each define an action in the action group. See functions Block for details.
    Functions []AgentAgentActionGroupFunctionSchemaMemberFunctionsFunction
    Functions that each define an action in the action group. See functions Block for details.
    functions List<AgentAgentActionGroupFunctionSchemaMemberFunctionsFunction>
    Functions that each define an action in the action group. See functions Block for details.
    functions AgentAgentActionGroupFunctionSchemaMemberFunctionsFunction[]
    Functions that each define an action in the action group. See functions Block for details.
    functions Sequence[AgentAgentActionGroupFunctionSchemaMemberFunctionsFunction]
    Functions that each define an action in the action group. See functions Block for details.
    functions List<Property Map>
    Functions that each define an action in the action group. See functions Block for details.

    AgentAgentActionGroupFunctionSchemaMemberFunctionsFunction, AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionArgs

    Name string
    Name for the function.
    Description string
    Description of the function and its purpose.
    Parameters List<AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameter>
    Parameters that the agent elicits from the user to fulfill the function. See parameters Block for details.
    Name string
    Name for the function.
    Description string
    Description of the function and its purpose.
    Parameters []AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameter
    Parameters that the agent elicits from the user to fulfill the function. See parameters Block for details.
    name String
    Name for the function.
    description String
    Description of the function and its purpose.
    parameters List<AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameter>
    Parameters that the agent elicits from the user to fulfill the function. See parameters Block for details.
    name string
    Name for the function.
    description string
    Description of the function and its purpose.
    parameters AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameter[]
    Parameters that the agent elicits from the user to fulfill the function. See parameters Block for details.
    name str
    Name for the function.
    description str
    Description of the function and its purpose.
    parameters Sequence[AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameter]
    Parameters that the agent elicits from the user to fulfill the function. See parameters Block for details.
    name String
    Name for the function.
    description String
    Description of the function and its purpose.
    parameters List<Property Map>
    Parameters that the agent elicits from the user to fulfill the function. See parameters Block for details.

    AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameter, AgentAgentActionGroupFunctionSchemaMemberFunctionsFunctionParameterArgs

    MapBlockKey string

    Name of the parameter.

    Note: The argument name map_block_key may seem out of context, but is necessary for backward compatibility reasons in the provider.

    Type string
    Data type of the parameter. Valid values: string, number, integer, boolean, array.
    Description string
    Description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
    Required bool
    Whether the parameter is required for the agent to complete the function for action group invocation.
    MapBlockKey string

    Name of the parameter.

    Note: The argument name map_block_key may seem out of context, but is necessary for backward compatibility reasons in the provider.

    Type string
    Data type of the parameter. Valid values: string, number, integer, boolean, array.
    Description string
    Description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
    Required bool
    Whether the parameter is required for the agent to complete the function for action group invocation.
    mapBlockKey String

    Name of the parameter.

    Note: The argument name map_block_key may seem out of context, but is necessary for backward compatibility reasons in the provider.

    type String
    Data type of the parameter. Valid values: string, number, integer, boolean, array.
    description String
    Description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
    required Boolean
    Whether the parameter is required for the agent to complete the function for action group invocation.
    mapBlockKey string

    Name of the parameter.

    Note: The argument name map_block_key may seem out of context, but is necessary for backward compatibility reasons in the provider.

    type string
    Data type of the parameter. Valid values: string, number, integer, boolean, array.
    description string
    Description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
    required boolean
    Whether the parameter is required for the agent to complete the function for action group invocation.
    map_block_key str

    Name of the parameter.

    Note: The argument name map_block_key may seem out of context, but is necessary for backward compatibility reasons in the provider.

    type str
    Data type of the parameter. Valid values: string, number, integer, boolean, array.
    description str
    Description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
    required bool
    Whether the parameter is required for the agent to complete the function for action group invocation.
    mapBlockKey String

    Name of the parameter.

    Note: The argument name map_block_key may seem out of context, but is necessary for backward compatibility reasons in the provider.

    type String
    Data type of the parameter. Valid values: string, number, integer, boolean, array.
    description String
    Description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
    required Boolean
    Whether the parameter is required for the agent to complete the function for action group invocation.

    AgentAgentActionGroupTimeouts, AgentAgentActionGroupTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    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
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws