Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. bedrock
  5. getAgent

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.bedrock.getAgent

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Bedrock::Agent Resource Type

    Using getAgent

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAgent(args: GetAgentArgs, opts?: InvokeOptions): Promise<GetAgentResult>
function getAgentOutput(args: GetAgentOutputArgs, opts?: InvokeOptions): Output<GetAgentResult>
    def get_agent(agent_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetAgentResult
def get_agent_output(agent_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetAgentResult]
    func LookupAgent(ctx *Context, args *LookupAgentArgs, opts ...InvokeOption) (*LookupAgentResult, error)
func LookupAgentOutput(ctx *Context, args *LookupAgentOutputArgs, opts ...InvokeOption) LookupAgentResultOutput

    > Note: This function is named LookupAgent in the Go SDK.

    public static class GetAgent 
{
    public static Task<GetAgentResult> InvokeAsync(GetAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentResult> Invoke(GetAgentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAgentResult> getAgent(GetAgentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:bedrock:getAgent
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AgentId string
    Identifier for a resource.
    AgentId string
    Identifier for a resource.
    agentId String
    Identifier for a resource.
    agentId string
    Identifier for a resource.
    agent_id str
    Identifier for a resource.
    agentId String
    Identifier for a resource.

    getAgent Result

    The following output properties are available:

    ActionGroups List<Pulumi.AwsNative.Bedrock.Outputs.AgentActionGroup>
    List of ActionGroups
    AgentArn string
    Arn representation of the Agent.
    AgentId string
    Identifier for a resource.
    AgentName string
    Name for a resource.
    AgentResourceRoleArn string
    ARN of a IAM role.
    AgentStatus Pulumi.AwsNative.Bedrock.AgentStatus
    The status of the agent and whether it is ready for use. The following statuses are possible:

    • CREATING – The agent is being created.
    • PREPARING – The agent is being prepared.
    • PREPARED – The agent is prepared and ready to be invoked.
    • NOT_PREPARED – The agent has been created but not yet prepared.
    • FAILED – The agent API operation failed.
    • UPDATING – The agent is being updated.
    • DELETING – The agent is being deleted.
    AgentVersion string
    Draft Agent Version.
    CreatedAt string
    Time Stamp.
    CustomerEncryptionKeyArn string
    A KMS key ARN
    Description string
    Description of the Resource.
    FailureReasons List<string>
    Failure Reasons for Error.
    FoundationModel string
    ARN or name of a Bedrock model.
    GuardrailConfiguration Pulumi.AwsNative.Bedrock.Outputs.AgentGuardrailConfiguration
    Details about the guardrail associated with the agent.
    IdleSessionTtlInSeconds double
    Max Session Time.
    Instruction string
    Instruction for the agent.
    KnowledgeBases List<Pulumi.AwsNative.Bedrock.Outputs.AgentKnowledgeBase>
    List of Agent Knowledge Bases
    PreparedAt string
    Time Stamp.
    PromptOverrideConfiguration Pulumi.AwsNative.Bedrock.Outputs.AgentPromptOverrideConfiguration
    Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts .
    RecommendedActions List<string>
    The recommended actions users can take to resolve an error in failureReasons.
    Tags Dictionary<string, string>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    TestAliasTags Dictionary<string, string>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    UpdatedAt string
    Time Stamp.
    ActionGroups []AgentActionGroup
    List of ActionGroups
    AgentArn string
    Arn representation of the Agent.
    AgentId string
    Identifier for a resource.
    AgentName string
    Name for a resource.
    AgentResourceRoleArn string
    ARN of a IAM role.
    AgentStatus AgentStatus
    The status of the agent and whether it is ready for use. The following statuses are possible:

    • CREATING – The agent is being created.
    • PREPARING – The agent is being prepared.
    • PREPARED – The agent is prepared and ready to be invoked.
    • NOT_PREPARED – The agent has been created but not yet prepared.
    • FAILED – The agent API operation failed.
    • UPDATING – The agent is being updated.
    • DELETING – The agent is being deleted.
    AgentVersion string
    Draft Agent Version.
    CreatedAt string
    Time Stamp.
    CustomerEncryptionKeyArn string
    A KMS key ARN
    Description string
    Description of the Resource.
    FailureReasons []string
    Failure Reasons for Error.
    FoundationModel string
    ARN or name of a Bedrock model.
    GuardrailConfiguration AgentGuardrailConfiguration
    Details about the guardrail associated with the agent.
    IdleSessionTtlInSeconds float64
    Max Session Time.
    Instruction string
    Instruction for the agent.
    KnowledgeBases []AgentKnowledgeBase
    List of Agent Knowledge Bases
    PreparedAt string
    Time Stamp.
    PromptOverrideConfiguration AgentPromptOverrideConfiguration
    Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts .
    RecommendedActions []string
    The recommended actions users can take to resolve an error in failureReasons.
    Tags map[string]string
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    TestAliasTags map[string]string
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    UpdatedAt string
    Time Stamp.
    actionGroups List<AgentActionGroup>
    List of ActionGroups
    agentArn String
    Arn representation of the Agent.
    agentId String
    Identifier for a resource.
    agentName String
    Name for a resource.
    agentResourceRoleArn String
    ARN of a IAM role.
    agentStatus AgentStatus
    The status of the agent and whether it is ready for use. The following statuses are possible:

    • CREATING – The agent is being created.
    • PREPARING – The agent is being prepared.
    • PREPARED – The agent is prepared and ready to be invoked.
    • NOT_PREPARED – The agent has been created but not yet prepared.
    • FAILED – The agent API operation failed.
    • UPDATING – The agent is being updated.
    • DELETING – The agent is being deleted.
    agentVersion String
    Draft Agent Version.
    createdAt String
    Time Stamp.
    customerEncryptionKeyArn String
    A KMS key ARN
    description String
    Description of the Resource.
    failureReasons List<String>
    Failure Reasons for Error.
    foundationModel String
    ARN or name of a Bedrock model.
    guardrailConfiguration AgentGuardrailConfiguration
    Details about the guardrail associated with the agent.
    idleSessionTtlInSeconds Double
    Max Session Time.
    instruction String
    Instruction for the agent.
    knowledgeBases List<AgentKnowledgeBase>
    List of Agent Knowledge Bases
    preparedAt String
    Time Stamp.
    promptOverrideConfiguration AgentPromptOverrideConfiguration
    Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts .
    recommendedActions List<String>
    The recommended actions users can take to resolve an error in failureReasons.
    tags Map<String,String>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    testAliasTags Map<String,String>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    updatedAt String
    Time Stamp.
    actionGroups AgentActionGroup[]
    List of ActionGroups
    agentArn string
    Arn representation of the Agent.
    agentId string
    Identifier for a resource.
    agentName string
    Name for a resource.
    agentResourceRoleArn string
    ARN of a IAM role.
    agentStatus AgentStatus
    The status of the agent and whether it is ready for use. The following statuses are possible:

    • CREATING – The agent is being created.
    • PREPARING – The agent is being prepared.
    • PREPARED – The agent is prepared and ready to be invoked.
    • NOT_PREPARED – The agent has been created but not yet prepared.
    • FAILED – The agent API operation failed.
    • UPDATING – The agent is being updated.
    • DELETING – The agent is being deleted.
    agentVersion string
    Draft Agent Version.
    createdAt string
    Time Stamp.
    customerEncryptionKeyArn string
    A KMS key ARN
    description string
    Description of the Resource.
    failureReasons string[]
    Failure Reasons for Error.
    foundationModel string
    ARN or name of a Bedrock model.
    guardrailConfiguration AgentGuardrailConfiguration
    Details about the guardrail associated with the agent.
    idleSessionTtlInSeconds number
    Max Session Time.
    instruction string
    Instruction for the agent.
    knowledgeBases AgentKnowledgeBase[]
    List of Agent Knowledge Bases
    preparedAt string
    Time Stamp.
    promptOverrideConfiguration AgentPromptOverrideConfiguration
    Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts .
    recommendedActions string[]
    The recommended actions users can take to resolve an error in failureReasons.
    tags {[key: string]: string}
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    testAliasTags {[key: string]: string}
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    updatedAt string
    Time Stamp.
    action_groups Sequence[AgentActionGroup]
    List of ActionGroups
    agent_arn str
    Arn representation of the Agent.
    agent_id str
    Identifier for a resource.
    agent_name str
    Name for a resource.
    agent_resource_role_arn str
    ARN of a IAM role.
    agent_status AgentStatus
    The status of the agent and whether it is ready for use. The following statuses are possible:

    • CREATING – The agent is being created.
    • PREPARING – The agent is being prepared.
    • PREPARED – The agent is prepared and ready to be invoked.
    • NOT_PREPARED – The agent has been created but not yet prepared.
    • FAILED – The agent API operation failed.
    • UPDATING – The agent is being updated.
    • DELETING – The agent is being deleted.
    agent_version str
    Draft Agent Version.
    created_at str
    Time Stamp.
    customer_encryption_key_arn str
    A KMS key ARN
    description str
    Description of the Resource.
    failure_reasons Sequence[str]
    Failure Reasons for Error.
    foundation_model str
    ARN or name of a Bedrock model.
    guardrail_configuration AgentGuardrailConfiguration
    Details about the guardrail associated with the agent.
    idle_session_ttl_in_seconds float
    Max Session Time.
    instruction str
    Instruction for the agent.
    knowledge_bases Sequence[AgentKnowledgeBase]
    List of Agent Knowledge Bases
    prepared_at str
    Time Stamp.
    prompt_override_configuration AgentPromptOverrideConfiguration
    Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts .
    recommended_actions Sequence[str]
    The recommended actions users can take to resolve an error in failureReasons.
    tags Mapping[str, str]
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    test_alias_tags Mapping[str, str]
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    updated_at str
    Time Stamp.
    actionGroups List<Property Map>
    List of ActionGroups
    agentArn String
    Arn representation of the Agent.
    agentId String
    Identifier for a resource.
    agentName String
    Name for a resource.
    agentResourceRoleArn String
    ARN of a IAM role.
    agentStatus "CREATING" | "PREPARING" | "PREPARED" | "NOT_PREPARED" | "DELETING" | "FAILED" | "VERSIONING" | "UPDATING"
    The status of the agent and whether it is ready for use. The following statuses are possible:

    • CREATING – The agent is being created.
    • PREPARING – The agent is being prepared.
    • PREPARED – The agent is prepared and ready to be invoked.
    • NOT_PREPARED – The agent has been created but not yet prepared.
    • FAILED – The agent API operation failed.
    • UPDATING – The agent is being updated.
    • DELETING – The agent is being deleted.
    agentVersion String
    Draft Agent Version.
    createdAt String
    Time Stamp.
    customerEncryptionKeyArn String
    A KMS key ARN
    description String
    Description of the Resource.
    failureReasons List<String>
    Failure Reasons for Error.
    foundationModel String
    ARN or name of a Bedrock model.
    guardrailConfiguration Property Map
    Details about the guardrail associated with the agent.
    idleSessionTtlInSeconds Number
    Max Session Time.
    instruction String
    Instruction for the agent.
    knowledgeBases List<Property Map>
    List of Agent Knowledge Bases
    preparedAt String
    Time Stamp.
    promptOverrideConfiguration Property Map
    Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts .
    recommendedActions List<String>
    The recommended actions users can take to resolve an error in failureReasons.
    tags Map<String>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    testAliasTags Map<String>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    updatedAt String
    Time Stamp.

    Supporting Types

    AgentActionGroup

    ActionGroupName string
    Name of the action group
    ActionGroupExecutor Pulumi.AwsNative.Bedrock.Inputs.AgentActionGroupExecutor0Properties | Pulumi.AwsNative.Bedrock.Inputs.AgentActionGroupExecutor1Properties
    The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
    ActionGroupState Pulumi.AwsNative.Bedrock.AgentActionGroupState
    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
    ApiSchema Pulumi.AwsNative.Bedrock.Inputs.AgentApiSchema0Properties | Pulumi.AwsNative.Bedrock.Inputs.AgentApiSchema1Properties
    Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas .
    Description string
    Description of action group
    FunctionSchema Pulumi.AwsNative.Bedrock.Inputs.AgentFunctionSchema
    Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
    ParentActionGroupSignature Pulumi.AwsNative.Bedrock.AgentActionGroupSignature

    If this field is set as AMAZON.UserInput , the agent can request the user for additional information when trying to complete a task. The description , apiSchema , and actionGroupExecutor fields must be blank for this action group.

    During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

    SkipResourceInUseCheckOnDelete bool
    Specifies whether to allow deleting action group while it is in use.
    ActionGroupName string
    Name of the action group
    ActionGroupExecutor AgentActionGroupExecutor0Properties | AgentActionGroupExecutor1Properties
    The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
    ActionGroupState AgentActionGroupState
    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
    ApiSchema AgentApiSchema0Properties | AgentApiSchema1Properties
    Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas .
    Description string
    Description of action group
    FunctionSchema AgentFunctionSchema
    Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
    ParentActionGroupSignature AgentActionGroupSignature

    If this field is set as AMAZON.UserInput , the agent can request the user for additional information when trying to complete a task. The description , apiSchema , and actionGroupExecutor fields must be blank for this action group.

    During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

    SkipResourceInUseCheckOnDelete bool
    Specifies whether to allow deleting action group while it is in use.
    actionGroupName String
    Name of the action group
    actionGroupExecutor AgentActionGroupExecutor0Properties | AgentActionGroupExecutor1Properties
    The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
    actionGroupState AgentActionGroupState
    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
    apiSchema AgentApiSchema0Properties | AgentApiSchema1Properties
    Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas .
    description String
    Description of action group
    functionSchema AgentFunctionSchema
    Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
    parentActionGroupSignature AgentActionGroupSignature

    If this field is set as AMAZON.UserInput , the agent can request the user for additional information when trying to complete a task. The description , apiSchema , and actionGroupExecutor fields must be blank for this action group.

    During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

    skipResourceInUseCheckOnDelete Boolean
    Specifies whether to allow deleting action group while it is in use.
    actionGroupName string
    Name of the action group
    actionGroupExecutor AgentActionGroupExecutor0Properties | AgentActionGroupExecutor1Properties
    The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
    actionGroupState AgentActionGroupState
    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
    apiSchema AgentApiSchema0Properties | AgentApiSchema1Properties
    Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas .
    description string
    Description of action group
    functionSchema AgentFunctionSchema
    Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
    parentActionGroupSignature AgentActionGroupSignature

    If this field is set as AMAZON.UserInput , the agent can request the user for additional information when trying to complete a task. The description , apiSchema , and actionGroupExecutor fields must be blank for this action group.

    During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

    skipResourceInUseCheckOnDelete boolean
    Specifies whether to allow deleting action group while it is in use.
    action_group_name str
    Name of the action group
    action_group_executor AgentActionGroupExecutor0Properties | AgentActionGroupExecutor1Properties
    The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
    action_group_state AgentActionGroupState
    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
    api_schema AgentApiSchema0Properties | AgentApiSchema1Properties
    Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas .
    description str
    Description of action group
    function_schema AgentFunctionSchema
    Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
    parent_action_group_signature AgentActionGroupSignature

    If this field is set as AMAZON.UserInput , the agent can request the user for additional information when trying to complete a task. The description , apiSchema , and actionGroupExecutor fields must be blank for this action group.

    During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

    skip_resource_in_use_check_on_delete bool
    Specifies whether to allow deleting action group while it is in use.
    actionGroupName String
    Name of the action group
    actionGroupExecutor Property Map | Property Map
    The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
    actionGroupState "ENABLED" | "DISABLED"
    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
    apiSchema Property Map | Property Map
    Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas .
    description String
    Description of action group
    functionSchema Property Map
    Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
    parentActionGroupSignature "AMAZON.UserInput"

    If this field is set as AMAZON.UserInput , the agent can request the user for additional information when trying to complete a task. The description , apiSchema , and actionGroupExecutor fields must be blank for this action group.

    During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

    skipResourceInUseCheckOnDelete Boolean
    Specifies whether to allow deleting action group while it is in use.

    AgentActionGroupExecutor0Properties

    Lambda string
    ARN of a Lambda.
    Lambda string
    ARN of a Lambda.
    lambda String
    ARN of a Lambda.
    lambda string
    ARN of a Lambda.
    lambda_ str
    ARN of a Lambda.
    lambda String
    ARN of a Lambda.

    AgentActionGroupExecutor1Properties

    AgentActionGroupSignature

    AgentActionGroupState

    AgentApiSchema0Properties

    AgentApiSchema1Properties

    Payload string
    String OpenAPI Payload
    Payload string
    String OpenAPI Payload
    payload String
    String OpenAPI Payload
    payload string
    String OpenAPI Payload
    payload str
    String OpenAPI Payload
    payload String
    String OpenAPI Payload

    AgentCreationMode

    AgentCustomControlMethod

    AgentFunction

    Name string
    Name for a resource.
    Description string
    Description of function
    Parameters Dictionary<string, Pulumi.AwsNative.Bedrock.Inputs.AgentParameterDetail>
    The parameters that the agent elicits from the user to fulfill the function.
    Name string
    Name for a resource.
    Description string
    Description of function
    Parameters map[string]AgentParameterDetail
    The parameters that the agent elicits from the user to fulfill the function.
    name String
    Name for a resource.
    description String
    Description of function
    parameters Map<String,AgentParameterDetail>
    The parameters that the agent elicits from the user to fulfill the function.
    name string
    Name for a resource.
    description string
    Description of function
    parameters {[key: string]: AgentParameterDetail}
    The parameters that the agent elicits from the user to fulfill the function.
    name str
    Name for a resource.
    description str
    Description of function
    parameters Mapping[str, AgentParameterDetail]
    The parameters that the agent elicits from the user to fulfill the function.
    name String
    Name for a resource.
    description String
    Description of function
    parameters Map<Property Map>
    The parameters that the agent elicits from the user to fulfill the function.

    AgentFunctionSchema

    Functions []AgentFunction
    List of Function definitions
    functions List<AgentFunction>
    List of Function definitions
    functions AgentFunction[]
    List of Function definitions
    functions Sequence[AgentFunction]
    List of Function definitions
    functions List<Property Map>
    List of Function definitions

    AgentGuardrailConfiguration

    GuardrailIdentifier string
    Identifier for the guardrail, could be the id or the arn
    GuardrailVersion string
    Version of the guardrail
    GuardrailIdentifier string
    Identifier for the guardrail, could be the id or the arn
    GuardrailVersion string
    Version of the guardrail
    guardrailIdentifier String
    Identifier for the guardrail, could be the id or the arn
    guardrailVersion String
    Version of the guardrail
    guardrailIdentifier string
    Identifier for the guardrail, could be the id or the arn
    guardrailVersion string
    Version of the guardrail
    guardrail_identifier str
    Identifier for the guardrail, could be the id or the arn
    guardrail_version str
    Version of the guardrail
    guardrailIdentifier String
    Identifier for the guardrail, could be the id or the arn
    guardrailVersion String
    Version of the guardrail

    AgentInferenceConfiguration

    MaximumLength double
    Maximum length of output
    StopSequences List<string>
    List of stop sequences
    Temperature double
    Controls randomness, higher values increase diversity
    TopK double
    Sample from the k most likely next tokens
    TopP double
    Cumulative probability cutoff for token selection
    MaximumLength float64
    Maximum length of output
    StopSequences []string
    List of stop sequences
    Temperature float64
    Controls randomness, higher values increase diversity
    TopK float64
    Sample from the k most likely next tokens
    TopP float64
    Cumulative probability cutoff for token selection
    maximumLength Double
    Maximum length of output
    stopSequences List<String>
    List of stop sequences
    temperature Double
    Controls randomness, higher values increase diversity
    topK Double
    Sample from the k most likely next tokens
    topP Double
    Cumulative probability cutoff for token selection
    maximumLength number
    Maximum length of output
    stopSequences string[]
    List of stop sequences
    temperature number
    Controls randomness, higher values increase diversity
    topK number
    Sample from the k most likely next tokens
    topP number
    Cumulative probability cutoff for token selection
    maximum_length float
    Maximum length of output
    stop_sequences Sequence[str]
    List of stop sequences
    temperature float
    Controls randomness, higher values increase diversity
    top_k float
    Sample from the k most likely next tokens
    top_p float
    Cumulative probability cutoff for token selection
    maximumLength Number
    Maximum length of output
    stopSequences List<String>
    List of stop sequences
    temperature Number
    Controls randomness, higher values increase diversity
    topK Number
    Sample from the k most likely next tokens
    topP Number
    Cumulative probability cutoff for token selection

    AgentKnowledgeBase

    Description string
    Description of the Resource.
    KnowledgeBaseId string
    Identifier for a resource.
    KnowledgeBaseState Pulumi.AwsNative.Bedrock.AgentKnowledgeBaseState
    Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
    Description string
    Description of the Resource.
    KnowledgeBaseId string
    Identifier for a resource.
    KnowledgeBaseState AgentKnowledgeBaseState
    Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
    description String
    Description of the Resource.
    knowledgeBaseId String
    Identifier for a resource.
    knowledgeBaseState AgentKnowledgeBaseState
    Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
    description string
    Description of the Resource.
    knowledgeBaseId string
    Identifier for a resource.
    knowledgeBaseState AgentKnowledgeBaseState
    Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
    description str
    Description of the Resource.
    knowledge_base_id str
    Identifier for a resource.
    knowledge_base_state AgentKnowledgeBaseState
    Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
    description String
    Description of the Resource.
    knowledgeBaseId String
    Identifier for a resource.
    knowledgeBaseState "ENABLED" | "DISABLED"
    Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

    AgentKnowledgeBaseState

    AgentParameterDetail

    Type Pulumi.AwsNative.Bedrock.AgentType
    The data type of the parameter.
    Description string
    Description of function parameter.
    Required bool
    Information about if a parameter is required for function call. Default to false.
    Type AgentType
    The data type of the parameter.
    Description string
    Description of function parameter.
    Required bool
    Information about if a parameter is required for function call. Default to false.
    type AgentType
    The data type of the parameter.
    description String
    Description of function parameter.
    required Boolean
    Information about if a parameter is required for function call. Default to false.
    type AgentType
    The data type of the parameter.
    description string
    Description of function parameter.
    required boolean
    Information about if a parameter is required for function call. Default to false.
    type AgentType
    The data type of the parameter.
    description str
    Description of function parameter.
    required bool
    Information about if a parameter is required for function call. Default to false.
    type "string" | "number" | "integer" | "boolean" | "array"
    The data type of the parameter.
    description String
    Description of function parameter.
    required Boolean
    Information about if a parameter is required for function call. Default to false.

    AgentPromptConfiguration

    BasePromptTemplate string
    Base Prompt Template.
    InferenceConfiguration Pulumi.AwsNative.Bedrock.Inputs.AgentInferenceConfiguration
    Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType . For more information, see Inference parameters for foundation models .
    ParserMode Pulumi.AwsNative.Bedrock.AgentCreationMode
    Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType . If you set the field as OVERRIDEN , the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
    PromptCreationMode Pulumi.AwsNative.Bedrock.AgentCreationMode
    Specifies whether to override the default prompt template for this promptType . Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate . If you leave it as DEFAULT , the agent uses a default prompt template.
    PromptState Pulumi.AwsNative.Bedrock.AgentPromptState
    Specifies whether to allow the agent to carry out the step specified in the promptType . If you set this value to DISABLED , the agent skips that step. The default state for each promptType is as follows.

    • PRE_PROCESSING – ENABLED
    • ORCHESTRATION – ENABLED
    • KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
    • POST_PROCESSING – DISABLED
    PromptType Pulumi.AwsNative.Bedrock.AgentPromptType
    The step in the agent sequence that this prompt configuration applies to.
    BasePromptTemplate string
    Base Prompt Template.
    InferenceConfiguration AgentInferenceConfiguration
    Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType . For more information, see Inference parameters for foundation models .
    ParserMode AgentCreationMode
    Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType . If you set the field as OVERRIDEN , the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
    PromptCreationMode AgentCreationMode
    Specifies whether to override the default prompt template for this promptType . Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate . If you leave it as DEFAULT , the agent uses a default prompt template.
    PromptState AgentPromptState
    Specifies whether to allow the agent to carry out the step specified in the promptType . If you set this value to DISABLED , the agent skips that step. The default state for each promptType is as follows.

    • PRE_PROCESSING – ENABLED
    • ORCHESTRATION – ENABLED
    • KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
    • POST_PROCESSING – DISABLED
    PromptType AgentPromptType
    The step in the agent sequence that this prompt configuration applies to.
    basePromptTemplate String
    Base Prompt Template.
    inferenceConfiguration AgentInferenceConfiguration
    Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType . For more information, see Inference parameters for foundation models .
    parserMode AgentCreationMode
    Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType . If you set the field as OVERRIDEN , the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
    promptCreationMode AgentCreationMode
    Specifies whether to override the default prompt template for this promptType . Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate . If you leave it as DEFAULT , the agent uses a default prompt template.
    promptState AgentPromptState
    Specifies whether to allow the agent to carry out the step specified in the promptType . If you set this value to DISABLED , the agent skips that step. The default state for each promptType is as follows.

    • PRE_PROCESSING – ENABLED
    • ORCHESTRATION – ENABLED
    • KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
    • POST_PROCESSING – DISABLED
    promptType AgentPromptType
    The step in the agent sequence that this prompt configuration applies to.
    basePromptTemplate string
    Base Prompt Template.
    inferenceConfiguration AgentInferenceConfiguration
    Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType . For more information, see Inference parameters for foundation models .
    parserMode AgentCreationMode
    Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType . If you set the field as OVERRIDEN , the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
    promptCreationMode AgentCreationMode
    Specifies whether to override the default prompt template for this promptType . Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate . If you leave it as DEFAULT , the agent uses a default prompt template.
    promptState AgentPromptState
    Specifies whether to allow the agent to carry out the step specified in the promptType . If you set this value to DISABLED , the agent skips that step. The default state for each promptType is as follows.

    • PRE_PROCESSING – ENABLED
    • ORCHESTRATION – ENABLED
    • KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
    • POST_PROCESSING – DISABLED
    promptType AgentPromptType
    The step in the agent sequence that this prompt configuration applies to.
    base_prompt_template str
    Base Prompt Template.
    inference_configuration AgentInferenceConfiguration
    Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType . For more information, see Inference parameters for foundation models .
    parser_mode AgentCreationMode
    Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType . If you set the field as OVERRIDEN , the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
    prompt_creation_mode AgentCreationMode
    Specifies whether to override the default prompt template for this promptType . Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate . If you leave it as DEFAULT , the agent uses a default prompt template.
    prompt_state AgentPromptState
    Specifies whether to allow the agent to carry out the step specified in the promptType . If you set this value to DISABLED , the agent skips that step. The default state for each promptType is as follows.

    • PRE_PROCESSING – ENABLED
    • ORCHESTRATION – ENABLED
    • KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
    • POST_PROCESSING – DISABLED
    prompt_type AgentPromptType
    The step in the agent sequence that this prompt configuration applies to.
    basePromptTemplate String
    Base Prompt Template.
    inferenceConfiguration Property Map
    Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType . For more information, see Inference parameters for foundation models .
    parserMode "DEFAULT" | "OVERRIDDEN"
    Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType . If you set the field as OVERRIDEN , the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
    promptCreationMode "DEFAULT" | "OVERRIDDEN"
    Specifies whether to override the default prompt template for this promptType . Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate . If you leave it as DEFAULT , the agent uses a default prompt template.
    promptState "ENABLED" | "DISABLED"
    Specifies whether to allow the agent to carry out the step specified in the promptType . If you set this value to DISABLED , the agent skips that step. The default state for each promptType is as follows.

    • PRE_PROCESSING – ENABLED
    • ORCHESTRATION – ENABLED
    • KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
    • POST_PROCESSING – DISABLED
    promptType "PRE_PROCESSING" | "ORCHESTRATION" | "POST_PROCESSING" | "KNOWLEDGE_BASE_RESPONSE_GENERATION"
    The step in the agent sequence that this prompt configuration applies to.

    AgentPromptOverrideConfiguration

    PromptConfigurations []AgentPromptConfiguration
    List of BasePromptConfiguration
    OverrideLambda string
    ARN of a Lambda.
    promptConfigurations List<AgentPromptConfiguration>
    List of BasePromptConfiguration
    overrideLambda String
    ARN of a Lambda.
    promptConfigurations AgentPromptConfiguration[]
    List of BasePromptConfiguration
    overrideLambda string
    ARN of a Lambda.
    prompt_configurations Sequence[AgentPromptConfiguration]
    List of BasePromptConfiguration
    override_lambda str
    ARN of a Lambda.
    promptConfigurations List<Property Map>
    List of BasePromptConfiguration
    overrideLambda String
    ARN of a Lambda.

    AgentPromptState

    AgentPromptType

    AgentS3Identifier

    S3BucketName string
    A bucket in S3.
    S3ObjectKey string
    A object key in S3.
    S3BucketName string
    A bucket in S3.
    S3ObjectKey string
    A object key in S3.
    s3BucketName String
    A bucket in S3.
    s3ObjectKey String
    A object key in S3.
    s3BucketName string
    A bucket in S3.
    s3ObjectKey string
    A object key in S3.
    s3_bucket_name str
    A bucket in S3.
    s3_object_key str
    A object key in S3.
    s3BucketName String
    A bucket in S3.
    s3ObjectKey String
    A object key in S3.

    AgentStatus

    AgentType

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native