AgentAlias
Contains details about an alias of an agent.
Contents
- agentAliasArn
-
The Amazon Resource Name (ARN) of the alias of the agent.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}Required: Yes
- agentAliasId
-
The unique identifier of the alias of the agent.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
(\bTSTALIASID\b|[0-9a-zA-Z]+)Required: Yes
- agentAliasName
-
The name of the alias of the agent.
Type: String
Pattern:
([0-9a-zA-Z][_-]?){1,100}Required: Yes
- agentAliasStatus
-
The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
-
CREATING – The agent alias is being created.
-
PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
-
FAILED – The agent alias API operation failed.
-
UPDATING – The agent alias is being updated.
-
DELETING – The agent alias is being deleted.
-
DISSOCIATED - The agent alias has no version associated with it.
Type: String
Valid Values:
CREATING | PREPARED | FAILED | UPDATING | DELETING | DISSOCIATEDRequired: Yes
-
- agentId
-
The unique identifier of the agent.
Type: String
Pattern:
[0-9a-zA-Z]{10}Required: Yes
- createdAt
-
The time at which the alias of the agent was created.
Type: Timestamp
Required: Yes
- routingConfiguration
-
Contains details about the routing configuration of the alias.
Type: Array of AgentAliasRoutingConfigurationListItem objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Required: Yes
- updatedAt
-
The time at which the alias was last updated.
Type: Timestamp
Required: Yes
- agentAliasHistoryEvents
-
Contains details about the history of the alias.
Type: Array of AgentAliasHistoryEvent objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
- aliasInvocationState
-
The invocation state for the agent alias. If the agent alias is running, the value is
ACCEPT_INVOCATIONS. If the agent alias is paused, the value isREJECT_INVOCATIONS. Use theUpdateAgentAliasoperation to change the invocation state.Type: String
Valid Values:
ACCEPT_INVOCATIONS | REJECT_INVOCATIONSRequired: No
- 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.
Type: String
Length Constraints: Minimum length of 33. Maximum length of 256.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}Required: No
- description
-
The description of the alias of the agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
- failureReasons
-
Information on the failure of Provisioned Throughput assigned to an agent alias.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2048 items.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: