AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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:

Inheritance Hierarchy

System.Object
  Amazon.BedrockAgentRuntime.Model.ApiResult

Namespace: Amazon.BedrockAgentRuntime.Model
Assembly: AWSSDK.BedrockAgentRuntime.dll
Version: 3.x.y.z

Syntax

C# 
public class ApiResult

The ApiResult type exposes the following members

Constructors

NameDescription
Public Method ApiResult()

Properties

NameTypeDescription
Public Property ActionGroup System.String

Gets and sets the property ActionGroup.

The action group that the API operation belongs to.

Public Property AgentId System.String

Gets and sets the property AgentId.

The agent's ID.

Public Property ApiPath System.String

Gets and sets the property ApiPath.

The path to the API operation.

Public Property ConfirmationState Amazon.BedrockAgentRuntime.ConfirmationState

Gets and sets the property ConfirmationState.

Controls the API operations or functions to invoke based on the user confirmation.

Public Property HttpMethod System.String

Gets and sets the property HttpMethod.

The HTTP method for the API operation.

Public Property HttpStatusCode System.Int32

Gets and sets the property HttpStatusCode.

http status code from API execution response (for example: 200, 400, 500).

Public Property ResponseBody System.Collections.Generic.Dictionary<System.String, Amazon.BedrockAgentRuntime.Model.ContentBody>

Gets and sets the property ResponseBody.

The response body from the API operation. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.

Public Property ResponseState Amazon.BedrockAgentRuntime.ResponseState

Gets and sets the property 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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5