aws-native.bedrock.getAgent

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

pulumi/pulumi-aws-native

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
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.
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
RecommendedActions List<string>: The recommended actions users can take to resolve an error in failureReasons.
Tags Dictionary<string, string>
TestAliasTags Dictionary<string, string>
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
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.
IdleSessionTtlInSeconds float64: Max Session Time.
Instruction string: Instruction for the agent.
KnowledgeBases []AgentKnowledgeBase: List of Agent Knowledge Bases
PreparedAt string: Time Stamp.
PromptOverrideConfiguration AgentPromptOverrideConfiguration
RecommendedActions []string: The recommended actions users can take to resolve an error in failureReasons.
Tags map[string]string
TestAliasTags map[string]string
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
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.
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
recommendedActions List<String>: The recommended actions users can take to resolve an error in failureReasons.
tags Map<String,String>
testAliasTags Map<String,String>
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
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.
idleSessionTtlInSeconds number: Max Session Time.
instruction string: Instruction for the agent.
knowledgeBases AgentKnowledgeBase[]: List of Agent Knowledge Bases
preparedAt string: Time Stamp.
promptOverrideConfiguration AgentPromptOverrideConfiguration
recommendedActions string[]: The recommended actions users can take to resolve an error in failureReasons.
tags {[key: string]: string}
testAliasTags {[key: string]: string}
updatedAt string: Time Stamp.