UpdateAgentCollaborator
Updates an agent's collaborator.
Request Syntax
PUT /agents/agentId
/agentversions/agentVersion
/agentcollaborators/collaboratorId
/ HTTP/1.1
Content-type: application/json
{
"agentDescriptor": {
"aliasArn": "string
"
},
"collaborationInstruction": "string
",
"collaboratorName": "string
",
"relayConversationHistory": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- agentId
-
The agent's ID.
Pattern:
^[0-9a-zA-Z]{10}$
Required: Yes
- agentVersion
-
The agent's version.
Length Constraints: Fixed length of 5.
Pattern:
^DRAFT$
Required: Yes
- collaboratorId
-
The collaborator's ID.
Pattern:
^[0-9a-zA-Z]{10}$
Required: Yes
Request Body
The request accepts the following data in JSON format.
- agentDescriptor
-
An agent descriptor for the agent collaborator.
Type: AgentDescriptor object
Required: Yes
- collaborationInstruction
-
Instruction for the collaborator.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4000.
Required: Yes
- collaboratorName
-
The collaborator's name.
Type: String
Pattern:
^([0-9a-zA-Z][_-]?){1,100}$
Required: Yes
- relayConversationHistory
-
A relay conversation history for the collaborator.
Type: String
Valid Values:
TO_COLLABORATOR | DISABLED
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"agentCollaborator": {
"agentDescriptor": {
"aliasArn": "string"
},
"agentId": "string",
"agentVersion": "string",
"clientToken": "string",
"collaborationInstruction": "string",
"collaboratorId": "string",
"collaboratorName": "string",
"createdAt": "string",
"lastUpdatedAt": "string",
"relayConversationHistory": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- agentCollaborator
-
Details about the collaborator.
Type: AgentCollaborator object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request is denied because of missing access permissions.
HTTP Status Code: 403
- ConflictException
-
There was a conflict performing an operation.
HTTP Status Code: 409
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
- ThrottlingException
-
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
- ValidationException
-
Input validation failed. Check your request parameters and retry the request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: