Skip to content

Creates an alias of an agent that can be used to deploy the agent

Description

Creates an alias of an agent that can be used to deploy the agent.

Usage

bedrockagent_create_agent_alias(agentId, agentAliasName, clientToken,
  description, routingConfiguration, tags)

Arguments

  • agentId

    [required] The unique identifier of the agent.

  • agentAliasName

    [required] The name of the alias.

  • clientToken

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

  • description

    A description of the alias of the agent.

  • routingConfiguration

    Contains details about the routing configuration of the alias.

  • tags

    Any tags that you want to attach to the alias of the agent.

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$create_agent_alias(
  agentId = "string",
  agentAliasName = "string",
  clientToken = "string",
  description = "string",
  routingConfiguration = list(
    list(
      agentVersion = "string",
      provisionedThroughput = "string"
    )
  ),
  tags = list(
    "string"
  )
)