commonMain.aws.sdk.kotlin.services.bedrockagent.model.FunctionSchema.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bedrockagent-jvm Show documentation

The AWS SDK for Kotlin client for Bedrock Agent

There is a newer version: 1.3.77

// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.bedrockagent.model



/**
 * Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
 *
 * This data type is used in the following API operations:
 * + [CreateAgentActionGroup request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax)
 * + [CreateAgentActionGroup response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax)
 * + [UpdateAgentActionGroup request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax)
 * + [UpdateAgentActionGroup response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax)
 * + [GetAgentActionGroup response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax)
 */
public sealed class FunctionSchema {
    /**
     * A list of functions that each define an action in the action group.
     */
    public data class Functions(val value: List) : aws.sdk.kotlin.services.bedrockagent.model.FunctionSchema() {
    }

    public object SdkUnknown : aws.sdk.kotlin.services.bedrockagent.model.FunctionSchema() {
    }

    /**
     * Casts this [FunctionSchema] as a [Functions] and retrieves its [List] value. Throws an exception if the [FunctionSchema] is not a
     * [Functions].
     */
    public fun asFunctions(): List = (this as FunctionSchema.Functions).value

    /**
     * Casts this [FunctionSchema] as a [Functions] and retrieves its [List] value. Returns null if the [FunctionSchema] is not a [Functions].
     */
    public fun asFunctionsOrNull(): List? = (this as? FunctionSchema.Functions)?.value
}