Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateProfileWithAgent

Updates a data transformation profile using chat-based interaction with an agent. Supports multi-turn conversations for iteratively customizing profiles.

Request Syntax


{
   "ConversationId": "string",
   "InputMessage": { 
      "Body": "string",
      "Type": "string"
   },
   "ProfileId": "string",
   "SourceFormat": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ConversationId

The conversation identifier for multi-turn interactions. Omit to start a new conversation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Required: No

InputMessage

The message to send to the agent.

Type: AgentInputMessage object

Required: Yes

ProfileId

The unique identifier of the profile to update via the agent.

Type: String

Length Constraints: Fixed length of 32.

Pattern: [a-f0-9]{32}

Required: Yes

SourceFormat

The source data format for the transformation.

Type: String

Valid Values: CCDA | CSV

Required: Yes

Response Syntax


{
   "AgentResponse": { 
      "Body": "string",
      "OptionsList": [ "string" ],
      "Type": "string"
   },
   "ConversationId": "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.

AgentResponse

The response message from the agent.

Type: AgentOutputMessage object

ConversationId

The conversation identifier to use for follow-up messages in this conversation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

Access is denied. Your account is not authorized to perform this operation.

HTTP Status Code: 400

AgentMessageOutOfContextException

The agent message does not fit within the current conversation context. Start a new conversation or provide a message that relates to the current profile customization session.

HTTP Status Code: 400

ConversationNotFoundException

The specified conversation identifier does not exist. Verify the conversation ID or omit it to start a new conversation.

HTTP Status Code: 400

InternalServerException

An unknown internal error occurred in the service.

HTTP Status Code: 500

NotImplementedOperationException

The requested operation is not yet available. Check the service documentation for a list of supported operations.

HTTP Status Code: 500

ResourceNotFoundException

The requested data store was not found.

HTTP Status Code: 400

ThrottlingException

The user has exceeded their maximum number of allowed calls to the given API.

HTTP Status Code: 400

UnauthorizedException

You are not authorized to make this request. Verify that your AWS credentials are valid and that you have the required permissions.

HTTP Status Code: 400

UnsupportedMIMETypeException

The content type in your request is not supported. Use a supported content type for this operation.

HTTP Status Code: 400

ValidationException

The user input parameter was invalid.

HTTP Status Code: 400