Get Agent

bedrockagent_get_agent

R Documentation

Gets information about an agent

Description

Gets information about an agent.

Usage

bedrockagent_get_agent(agentId)

Arguments

agentId

[required] The unique identifier of the agent.

Value

A list with the following syntax:

list(
  agent = list(
    agentId = "string",
    agentName = "string",
    agentArn = "string",
    agentVersion = "string",
    clientToken = "string",
    instruction = "string",
    agentStatus = "CREATING"|"PREPARING"|"PREPARED"|"NOT_PREPARED"|"DELETING"|"FAILED"|"VERSIONING"|"UPDATING",
    foundationModel = "string",
    description = "string",
    orchestrationType = "DEFAULT"|"CUSTOM_ORCHESTRATION",
    customOrchestration = list(
      executor = list(
        lambda = "string"
      )
    ),
    idleSessionTTLInSeconds = 123,
    agentResourceRoleArn = "string",
    customerEncryptionKeyArn = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    updatedAt = as.POSIXct(
      "2015-01-01"
    ),
    preparedAt = as.POSIXct(
      "2015-01-01"
    ),
    failureReasons = list(
      "string"
    ),
    recommendedActions = list(
      "string"
    ),
    promptOverrideConfiguration = list(
      promptConfigurations = list(
        list(
          promptType = "PRE_PROCESSING"|"ORCHESTRATION"|"POST_PROCESSING"|"KNOWLEDGE_BASE_RESPONSE_GENERATION"|"MEMORY_SUMMARIZATION",
          promptCreationMode = "DEFAULT"|"OVERRIDDEN",
          promptState = "ENABLED"|"DISABLED",
          basePromptTemplate = "string",
          inferenceConfiguration = list(
            temperature = 123.0,
            topP = 123.0,
            topK = 123,
            maximumLength = 123,
            stopSequences = list(
              "string"
            )
          ),
          parserMode = "DEFAULT"|"OVERRIDDEN",
          foundationModel = "string",
          additionalModelRequestFields = list()
        )
      ),
      overrideLambda = "string"
    ),
    guardrailConfiguration = list(
      guardrailIdentifier = "string",
      guardrailVersion = "string"
    ),
    memoryConfiguration = list(
      enabledMemoryTypes = list(
        "SESSION_SUMMARY"
      ),
      storageDays = 123,
      sessionSummaryConfiguration = list(
        maxRecentSessions = 123
      )
    ),
    agentCollaboration = "SUPERVISOR"|"SUPERVISOR_ROUTER"|"DISABLED"
  )
)

Request syntax

svc$get_agent(
  agentId = "string"
)