Skip to content

Updates configurations for an alias of an agent

Description

Updates configurations for an alias of an agent.

Usage

bedrockagent_update_agent_alias(agentId, agentAliasId, agentAliasName,
  description, routingConfiguration, aliasInvocationState)

Arguments

  • agentId

[required] The unique identifier of the agent.

  • agentAliasId

[required] The unique identifier of the alias.

  • agentAliasName

[required] Specifies a new name for the alias.

  • description

Specifies a new description for the alias.

  • routingConfiguration

Contains details about the routing configuration of the alias.

  • aliasInvocationState

The invocation state for the agent alias. To pause the agent alias, set the value to REJECT_INVOCATIONS. To start the agent alias running again, set the value to ACCEPT_INVOCATIONS. Use the get_agent_alias, or list_agent_aliases, operation to get the invocation state of an agent alias.

Value

A list with the following syntax:

list(
  agentAlias = list(
    agentId = "string",
    agentAliasId = "string",
    agentAliasName = "string",
    agentAliasArn = "string",
    clientToken = "string",
    description = "string",
    routingConfiguration = list(
      list(
        agentVersion = "string",
        provisionedThroughput = "string"
      )
    ),
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    updatedAt = as.POSIXct(
      "2015-01-01"
    ),
    agentAliasHistoryEvents = list(
      list(
        routingConfiguration = list(
          list(
            agentVersion = "string",
            provisionedThroughput = "string"
          )
        ),
        endDate = as.POSIXct(
          "2015-01-01"
        ),
        startDate = as.POSIXct(
          "2015-01-01"
        )
      )
    ),
    agentAliasStatus = "CREATING"|"PREPARED"|"FAILED"|"UPDATING"|"DELETING"|"DISSOCIATED",
    failureReasons = list(
      "string"
    ),
    aliasInvocationState = "ACCEPT_INVOCATIONS"|"REJECT_INVOCATIONS"
  )
)

Request syntax

svc$update_agent_alias(
  agentId = "string",
  agentAliasId = "string",
  agentAliasName = "string",
  description = "string",
  routingConfiguration = list(
    list(
      agentVersion = "string",
      provisionedThroughput = "string"
    )
  ),
  aliasInvocationState = "ACCEPT_INVOCATIONS"|"REJECT_INVOCATIONS"
)