ApiResult
Contains information about the API operation that was called from the action group and the response body that was returned.
This data type is used in the following API operations:
-
In the
returnControlInvocationResultsof the InvokeAgent request
Contents
- actionGroup
-
The action group that the API operation belongs to.
Type: String
Required: Yes
- agentId
-
The agent's ID.
Type: String
Required: No
- apiPath
-
The path to the API operation.
Type: String
Required: No
- confirmationState
-
Controls the API operations or functions to invoke based on the user confirmation.
Type: String
Valid Values:
CONFIRM | DENYRequired: No
- httpMethod
-
The HTTP method for the API operation.
Type: String
Required: No
- httpStatusCode
-
http status code from API execution response (for example: 200, 400, 500).
Type: Integer
Required: No
- responseBody
-
The response body from the API operation. The key of the object is the content type (currently, only
TEXTis supported). The response may be returned directly or from the Lambda function.Type: String to ContentBody object map
Required: No
- responseState
-
Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
Type: String
Valid Values:
FAILURE | REPROMPTRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
