Package-level declarations

Types

Link copied to clipboard
data class AgentActionGroup(val actionGroupExecutor: Either<AgentActionGroupExecutor0Properties, AgentActionGroupExecutor1Properties>? = null, val actionGroupName: String, val actionGroupState: AgentActionGroupState? = null, val apiSchema: Either<AgentApiSchema0Properties, AgentApiSchema1Properties>? = null, val description: String? = null, val functionSchema: AgentFunctionSchema? = null, val parentActionGroupSignature: AgentActionGroupSignature? = null, val skipResourceInUseCheckOnDelete: Boolean? = null)

Contains the information of an Agent Action Group

Link copied to clipboard

Type of Executors for an Action Group

Link copied to clipboard

Type of Executors for an Action Group

Link copied to clipboard

Additional Model Request Fields for Prompt Configuration

Link copied to clipboard
data class AgentAliasHistoryEvent(val endDate: String? = null, val routingConfiguration: List<AgentAliasRoutingConfigurationListItem>? = null, val startDate: String? = null)

History event for an alias for an Agent.

Link copied to clipboard
data class AgentAliasRoutingConfigurationListItem(val agentVersion: String)

Details about the routing configuration for an Agent alias.

Link copied to clipboard

Contains information about the API Schema for the Action Group

Link copied to clipboard
data class AgentApiSchema1Properties(val payload: String)

Contains information about the API Schema for the Action Group

Link copied to clipboard
data class AgentCollaborator(val agentDescriptor: AgentCollaboratorAgentDescriptorProperties, val collaborationInstruction: String, val collaboratorName: String, val relayConversationHistory: AgentRelayConversationHistory? = null)

Agent Collaborator

data class AgentCollaboratorAgentDescriptorProperties(val aliasArn: String? = null)

Agent descriptor for agent collaborator

Link copied to clipboard
data class AgentCustomOrchestration(val executor: AgentOrchestrationExecutor? = null)

Structure for custom orchestration

Link copied to clipboard
data class AgentFunction(val description: String? = null, val name: String, val parameters: Map<String, AgentParameterDetail>? = null, val requireConfirmation: AgentRequireConfirmation? = null)

Function definition

Link copied to clipboard
data class AgentFunctionSchema(val functions: List<AgentFunction>)

Schema of Functions

Link copied to clipboard
data class AgentGuardrailConfiguration(val guardrailIdentifier: String? = null, val guardrailVersion: String? = null)

Configuration for a guardrail.

Link copied to clipboard
data class AgentInferenceConfiguration(val maximumLength: Double? = null, val stopSequences: List<String>? = null, val temperature: Double? = null, val topK: Double? = null, val topP: Double? = null)

Configuration for inference in prompt configuration

Link copied to clipboard
data class AgentKnowledgeBase(val description: String, val knowledgeBaseId: String, val knowledgeBaseState: AgentKnowledgeBaseState? = null)

Agent Knowledge Base

Link copied to clipboard
data class AgentMemoryConfiguration(val enabledMemoryTypes: List<AgentMemoryType>? = null, val sessionSummaryConfiguration: AgentSessionSummaryConfiguration? = null, val storageDays: Double? = null)

Configuration for memory storage

Link copied to clipboard
data class AgentOrchestrationExecutor(val lambda: String)

Types of executors for custom orchestration strategy

Link copied to clipboard
data class AgentParameterDetail(val description: String? = null, val required: Boolean? = null, val type: AgentType)

Parameter detail

Link copied to clipboard
data class AgentPromptConfiguration(val additionalModelRequestFields: AgentAdditionalModelRequestFields? = null, val basePromptTemplate: String? = null, val foundationModel: String? = null, val inferenceConfiguration: AgentInferenceConfiguration? = null, val parserMode: AgentCreationMode? = null, val promptCreationMode: AgentCreationMode? = null, val promptState: AgentPromptState? = null, val promptType: AgentPromptType? = null)

BasePromptConfiguration per Prompt Type.

Link copied to clipboard
data class AgentPromptOverrideConfiguration(val overrideLambda: String? = null, val promptConfigurations: List<AgentPromptConfiguration>)

Configuration for prompt override.

Link copied to clipboard
data class AgentS3Identifier(val s3BucketName: String? = null, val s3ObjectKey: String? = null)

The identifier for the S3 resource.

Link copied to clipboard
data class AgentSessionSummaryConfiguration(val maxRecentSessions: Double? = null)

Configuration for Session Summarization

Model configuration

Various ways to encode a list of models in a CreateInferenceProfile request

Link copied to clipboard
data class DataAutomationProjectBlueprintItem(val blueprintArn: String, val blueprintStage: DataAutomationProjectBlueprintStage? = null, val blueprintVersion: String? = null)

Custom output configuration

Settings for a Bedrock Data Automation used to parse documents for a data source.

data class DataSourceBedrockFoundationModelConfiguration(val modelArn: String, val parsingModality: DataSourceParsingModality? = null, val parsingPrompt: DataSourceParsingPrompt? = null)

Settings for a foundation model used to parse documents for a data source.

Bedrock Foundation Model configuration to be used for Context Enrichment.

Link copied to clipboard
data class DataSourceChunkingConfiguration(val chunkingStrategy: DataSourceChunkingStrategy, val fixedSizeChunkingConfiguration: DataSourceFixedSizeChunkingConfiguration? = null, val hierarchicalChunkingConfiguration: DataSourceHierarchicalChunkingConfiguration? = null, val semanticChunkingConfiguration: DataSourceSemanticChunkingConfiguration? = null)

Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

Link copied to clipboard
data class DataSourceConfiguration(val confluenceConfiguration: DataSourceConfluenceDataSourceConfiguration? = null, val s3Configuration: DataSourceS3DataSourceConfiguration? = null, val salesforceConfiguration: DataSourceSalesforceDataSourceConfiguration? = null, val sharePointConfiguration: DataSourceSharePointDataSourceConfiguration? = null, val type: DataSourceType, val webConfiguration: DataSourceWebDataSourceConfiguration? = null)

Specifies a raw data source location to ingest.

Link copied to clipboard

The configuration of the Confluence content. For example, configuring specific types of Confluence content.

The configuration information to connect to Confluence as your data source.

Link copied to clipboard

The endpoint information to connect to your Confluence data source.

Link copied to clipboard

Additional Enrichment Configuration for example when using GraphRag.

Link copied to clipboard

The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content.

Settings for customizing steps in the data source content ingestion pipeline.

Strategy to be used when using Bedrock Foundation Model for Context Enrichment.

Link copied to clipboard
data class DataSourceFixedSizeChunkingConfiguration(val maxTokens: Int, val overlapPercentage: Int)

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

Configurations for when you choose hierarchical chunking. If you set the chunkingStrategy as NONE, exclude this field.

Token settings for a layer in a hierarchical chunking configuration.

Link copied to clipboard

A location for storing content from data sources temporarily as it is processed by custom components in the ingestion pipeline.

Link copied to clipboard
data class DataSourceParsingConfiguration(val bedrockDataAutomationConfiguration: DataSourceBedrockDataAutomationConfiguration? = null, val bedrockFoundationModelConfiguration: DataSourceBedrockFoundationModelConfiguration? = null, val parsingStrategy: DataSourceParsingStrategy)

Settings for parsing document contents

Link copied to clipboard
data class DataSourceParsingPrompt(val parsingPromptText: String)

Instructions for interpreting the contents of a document.

Link copied to clipboard
data class DataSourcePatternObjectFilter(val exclusionFilters: List<String>? = null, val inclusionFilters: List<String>? = null, val objectType: String)

The specific filters applied to your data source content. You can filter out or include certain content.

The configuration of specific filters applied to your data source content. You can filter out or include certain content.

Link copied to clipboard
data class DataSourceS3DataSourceConfiguration(val bucketArn: String, val bucketOwnerAccountId: String? = null, val inclusionPrefixes: List<String>? = null)

The configuration information to connect to Amazon S3 as your data source.

Link copied to clipboard
data class DataSourceS3Location(val uri: String)

An Amazon S3 location.

Link copied to clipboard

The configuration of filtering the Salesforce content. For example, configuring regular expression patterns to include or exclude certain content.

The configuration information to connect to Salesforce as your data source.

Link copied to clipboard
data class DataSourceSalesforceSourceConfiguration(val authType: DataSourceSalesforceSourceConfigurationAuthType, val credentialsSecretArn: String, val hostUrl: String)

The endpoint information to connect to your Salesforce data source.

Link copied to clipboard
data class DataSourceSeedUrl(val url: String)

A seed url object.

Link copied to clipboard
data class DataSourceSemanticChunkingConfiguration(val breakpointPercentileThreshold: Int, val bufferSize: Int, val maxTokens: Int)

Configurations for when you choose semantic chunking. If you set the chunkingStrategy as NONE, exclude this field.

data class DataSourceServerSideEncryptionConfiguration(val kmsKeyArn: String? = null)

Contains details about the server-side encryption for the data source.

Link copied to clipboard

The configuration of the SharePoint content. For example, configuring specific types of SharePoint content.

The configuration information to connect to SharePoint as your data source.

Link copied to clipboard
data class DataSourceSharePointSourceConfiguration(val authType: DataSourceSharePointSourceConfigurationAuthType, val credentialsSecretArn: String, val domain: String, val hostType: DataSourceSharePointSourceConfigurationHostType, val siteUrls: List<String>, val tenantId: String? = null)

The endpoint information to connect to your SharePoint data source.

Link copied to clipboard

A Lambda function that processes documents.

Link copied to clipboard
data class DataSourceTransformationFunction(val transformationLambdaConfiguration: DataSourceTransformationLambdaConfiguration)

A Lambda function that processes documents.

A Lambda function that processes documents.

Link copied to clipboard

A url configuration.

Link copied to clipboard
data class DataSourceVectorIngestionConfiguration(val chunkingConfiguration: DataSourceChunkingConfiguration? = null, val contextEnrichmentConfiguration: DataSourceContextEnrichmentConfiguration? = null, val customTransformationConfiguration: DataSourceCustomTransformationConfiguration? = null, val parsingConfiguration: DataSourceParsingConfiguration? = null)

Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

Link copied to clipboard
data class DataSourceWebCrawlerConfiguration(val crawlerLimits: DataSourceWebCrawlerLimits? = null, val exclusionFilters: List<String>? = null, val inclusionFilters: List<String>? = null, val scope: DataSourceWebScopeType? = null, val userAgent: String? = null, val userAgentHeader: String? = null)

Configuration for the web crawler.

Link copied to clipboard
data class DataSourceWebCrawlerLimits(val maxPages: Int? = null, val rateLimit: Int? = null)

Limit settings for the web crawler.

Link copied to clipboard
data class DataSourceWebDataSourceConfiguration(val crawlerConfiguration: DataSourceWebCrawlerConfiguration? = null, val sourceConfiguration: DataSourceWebSourceConfiguration)

Configures a web data source location.

Link copied to clipboard

A web source configuration.

Link copied to clipboard
data class FlowAgentFlowNodeConfiguration(val agentAliasArn: String)

Agent flow node configuration

Link copied to clipboard
data class FlowAliasRoutingConfigurationListItem(val flowVersion: String? = null)

Details about the routing configuration for a Flow alias.

Link copied to clipboard

Collector flow node configuration

Link copied to clipboard
data class FlowCondition(val expression: String? = null, val name: String)

Condition branch for a condition node

Link copied to clipboard

Conditional connection configuration

Link copied to clipboard

Condition flow node configuration

Link copied to clipboard
data class FlowConnection(val configuration: Either<FlowConnectionConfiguration0Properties, FlowConnectionConfiguration1Properties>? = null, val name: String, val source: String, val target: String, val type: FlowConnectionType)

Flow connection

Link copied to clipboard

Connection configuration

Link copied to clipboard

Connection configuration

Link copied to clipboard
data class FlowDataConnectionConfiguration(val sourceOutput: String, val targetInput: String)

Data connection configuration

Link copied to clipboard
data class FlowDefinition(val connections: List<FlowConnection>? = null, val nodes: List<FlowNode>? = null)

Flow definition

Link copied to clipboard
data class FlowGuardrailConfiguration(val guardrailIdentifier: String? = null, val guardrailVersion: String? = null)

Configuration for a guardrail

Link copied to clipboard

Input flow node configuration

Link copied to clipboard

Iterator flow node configuration

Link copied to clipboard
data class FlowKnowledgeBaseFlowNodeConfiguration(val guardrailConfiguration: FlowGuardrailConfiguration? = null, val knowledgeBaseId: String, val modelId: String? = null)

Knowledge base flow node configuration

Link copied to clipboard

Lambda function flow node configuration

Link copied to clipboard
data class FlowLexFlowNodeConfiguration(val botAliasArn: String, val localeId: String)

Lex flow node configuration

Link copied to clipboard
data class FlowNode(val configuration: Any? = null, val inputs: List<FlowNodeInput>? = null, val name: String, val outputs: List<FlowNodeOutput>? = null, val type: FlowNodeType)

Internal mixin for flow node

Link copied to clipboard

Node configuration in a flow

Link copied to clipboard

Node configuration in a flow

Link copied to clipboard

Node configuration in a flow

Link copied to clipboard

Node configuration in a flow

Link copied to clipboard

Node configuration in a flow

Link copied to clipboard

Node configuration in a flow

Link copied to clipboard

Node configuration in a flow

Link copied to clipboard

Node configuration in a flow

Link copied to clipboard

Node configuration in a flow

Link copied to clipboard

Node configuration in a flow

Link copied to clipboard

Node configuration in a flow

Link copied to clipboard

Node configuration in a flow

Link copied to clipboard
data class FlowNodeInput(val expression: String, val name: String, val type: FlowNodeIoDataType)

Input to a node in a flow

Link copied to clipboard
data class FlowNodeOutput(val name: String, val type: FlowNodeIoDataType)

Output of a node in a flow

Link copied to clipboard

Output flow node configuration

Link copied to clipboard

Prompt flow node configuration

Link copied to clipboard
data class FlowPromptFlowNodeInlineConfiguration(val inferenceConfiguration: FlowPromptInferenceConfigurationProperties? = null, val modelId: String, val templateConfiguration: FlowPromptTemplateConfigurationProperties, val templateType: FlowPromptTemplateType)

Inline prompt configuration for prompt node

Link copied to clipboard

Resource prompt configuration for prompt node

Prompt source configuration for prompt node

Prompt source configuration for prompt node

Link copied to clipboard
data class FlowPromptInputVariable(val name: String? = null)

Input variable

Link copied to clipboard
data class FlowPromptModelInferenceConfiguration(val maxTokens: Double? = null, val stopSequences: List<String>? = null, val temperature: Double? = null, val topP: Double? = null)

Prompt model inference configuration

Prompt template configuration

Link copied to clipboard

Retrieval flow node configuration

Link copied to clipboard
data class FlowRetrievalFlowNodeS3Configuration(val bucketName: String)

s3 Retrieval configuration for Retrieval node

Retrieval service configuration for Retrieval node

Link copied to clipboard
data class FlowS3Location(val bucket: String, val key: String, val version: String? = null)

A bucket, key and optional version pointing to an S3 object containing a UTF-8 encoded JSON string Definition with the same schema as the Definition property of this resource

Link copied to clipboard

Storage flow node configuration

Link copied to clipboard
data class FlowStorageFlowNodeS3Configuration(val bucketName: String)

s3 storage configuration for storage node

storage service configuration for storage node

Link copied to clipboard
data class FlowTextPromptTemplateConfiguration(val inputVariables: List<FlowPromptInputVariable>? = null, val text: String)

Configuration for text prompt template

Link copied to clipboard
data class FlowValidation(val message: String)

Validation for Flow

Link copied to clipboard
data class FlowVersionAgentFlowNodeConfiguration(val agentAliasArn: String)

Agent flow node configuration

Collector flow node configuration

Condition flow node configuration

Link copied to clipboard
data class FlowVersionFlowCondition(val expression: String? = null, val name: String)

Condition branch for a condition node

Conditional connection configuration

Link copied to clipboard

Flow connection

data class FlowVersionFlowDataConnectionConfiguration(val sourceOutput: String, val targetInput: String)

Data connection configuration

Link copied to clipboard
data class FlowVersionFlowDefinition(val connections: List<FlowVersionFlowConnection>? = null, val nodes: List<FlowVersionFlowNode>? = null)

Flow definition

Link copied to clipboard
data class FlowVersionFlowNode(val configuration: Any? = null, val inputs: List<FlowVersionFlowNodeInput>? = null, val name: String, val outputs: List<FlowVersionFlowNodeOutput>? = null, val type: FlowVersionFlowNodeType)

Internal mixin for flow node

Node configuration in a flow

Node configuration in a flow

Link copied to clipboard
data class FlowVersionFlowNodeInput(val expression: String, val name: String, val type: FlowVersionFlowNodeIoDataType)

Input to a node in a flow

Link copied to clipboard

Output of a node in a flow

Link copied to clipboard
data class FlowVersionGuardrailConfiguration(val guardrailIdentifier: String? = null, val guardrailVersion: String? = null)

Configuration for a guardrail

Link copied to clipboard

Input flow node configuration

Link copied to clipboard

Iterator flow node configuration

data class FlowVersionKnowledgeBaseFlowNodeConfiguration(val guardrailConfiguration: FlowVersionGuardrailConfiguration? = null, val knowledgeBaseId: String, val modelId: String? = null)

Knowledge base flow node configuration

Lambda function flow node configuration

Link copied to clipboard
data class FlowVersionLexFlowNodeConfiguration(val botAliasArn: String, val localeId: String)

Lex flow node configuration

Link copied to clipboard

Output flow node configuration

Inline prompt configuration for prompt node

Resource prompt configuration for prompt node

Link copied to clipboard
data class FlowVersionPromptInputVariable(val name: String? = null)

Input variable

data class FlowVersionPromptModelInferenceConfiguration(val maxTokens: Double? = null, val stopSequences: List<String>? = null, val temperature: Double? = null, val topP: Double? = null)

Prompt model inference configuration

Retrieval flow node configuration

s3 Retrieval configuration for Retrieval node

Retrieval service configuration for Retrieval node

Link copied to clipboard

Storage flow node configuration

s3 storage configuration for storage node

storage service configuration for storage node

data class FlowVersionTextPromptTemplateConfiguration(val inputVariables: List<FlowVersionPromptInputVariable>? = null, val text: String)

Configuration for text prompt template

Link copied to clipboard
data class GetAgentAliasResult(val agentAliasArn: String? = null, val agentAliasHistoryEvents: List<AgentAliasHistoryEvent>? = null, val agentAliasId: String? = null, val agentAliasName: String? = null, val agentAliasStatus: AgentAliasStatus? = null, val createdAt: String? = null, val description: String? = null, val routingConfiguration: List<AgentAliasRoutingConfigurationListItem>? = null, val tags: Map<String, String>? = null, val updatedAt: String? = null)
Link copied to clipboard
data class GetAgentResult(val actionGroups: List<AgentActionGroup>? = null, val agentArn: String? = null, val agentCollaboration: AgentCollaboration? = null, val agentCollaborators: List<AgentCollaborator>? = null, val agentId: String? = null, val agentName: String? = null, val agentResourceRoleArn: String? = null, val agentStatus: AgentStatus? = null, val agentVersion: String? = null, val createdAt: String? = null, val customOrchestration: AgentCustomOrchestration? = null, val customerEncryptionKeyArn: String? = null, val description: String? = null, val failureReasons: List<String>? = null, val foundationModel: String? = null, val guardrailConfiguration: AgentGuardrailConfiguration? = null, val idleSessionTtlInSeconds: Double? = null, val instruction: String? = null, val knowledgeBases: List<AgentKnowledgeBase>? = null, val memoryConfiguration: AgentMemoryConfiguration? = null, val orchestrationType: AgentOrchestrationType? = null, val preparedAt: String? = null, val promptOverrideConfiguration: AgentPromptOverrideConfiguration? = null, val recommendedActions: List<String>? = null, val tags: Map<String, String>? = null, val testAliasTags: Map<String, String>? = null, val updatedAt: String? = null)
Link copied to clipboard
data class GetApplicationInferenceProfileResult(val createdAt: String? = null, val inferenceProfileArn: String? = null, val inferenceProfileId: String? = null, val inferenceProfileIdentifier: String? = null, val models: List<ApplicationInferenceProfileInferenceProfileModel>? = null, val status: ApplicationInferenceProfileInferenceProfileStatus? = null, val tags: List<Tag>? = null, val type: ApplicationInferenceProfileInferenceProfileType? = null, val updatedAt: String? = null)
Link copied to clipboard
data class GetBlueprintResult(val blueprintArn: String? = null, val blueprintStage: BlueprintStage? = null, val creationTime: String? = null, val kmsEncryptionContext: Map<String, String>? = null, val kmsKeyId: String? = null, val lastModifiedTime: String? = null, val schema: Any? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetDataAutomationProjectResult(val creationTime: String? = null, val customOutputConfiguration: DataAutomationProjectCustomOutputConfiguration? = null, val kmsEncryptionContext: Map<String, String>? = null, val kmsKeyId: String? = null, val lastModifiedTime: String? = null, val overrideConfiguration: DataAutomationProjectOverrideConfiguration? = null, val projectArn: String? = null, val projectDescription: String? = null, val projectStage: DataAutomationProjectStage? = null, val standardOutputConfiguration: DataAutomationProjectStandardOutputConfiguration? = null, val status: DataAutomationProjectStatus? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetDataSourceResult(val createdAt: String? = null, val dataDeletionPolicy: DataSourceDataDeletionPolicy? = null, val dataSourceConfiguration: DataSourceConfiguration? = null, val dataSourceId: String? = null, val dataSourceStatus: DataSourceStatus? = null, val description: String? = null, val failureReasons: List<String>? = null, val name: String? = null, val serverSideEncryptionConfiguration: DataSourceServerSideEncryptionConfiguration? = null, val updatedAt: String? = null, val vectorIngestionConfiguration: DataSourceVectorIngestionConfiguration? = null)
Link copied to clipboard
data class GetFlowAliasResult(val arn: String? = null, val createdAt: String? = null, val description: String? = null, val flowId: String? = null, val id: String? = null, val name: String? = null, val routingConfiguration: List<FlowAliasRoutingConfigurationListItem>? = null, val tags: Map<String, String>? = null, val updatedAt: String? = null)
Link copied to clipboard
data class GetFlowResult(val arn: String? = null, val createdAt: String? = null, val customerEncryptionKeyArn: String? = null, val definition: FlowDefinition? = null, val description: String? = null, val executionRoleArn: String? = null, val id: String? = null, val name: String? = null, val status: FlowStatus? = null, val tags: Map<String, String>? = null, val testAliasTags: Map<String, String>? = null, val updatedAt: String? = null, val validations: List<FlowValidation>? = null, val version: String? = null)
Link copied to clipboard
data class GetFlowVersionResult(val createdAt: String? = null, val customerEncryptionKeyArn: String? = null, val definition: FlowVersionFlowDefinition? = null, val executionRoleArn: String? = null, val flowId: String? = null, val name: String? = null, val status: FlowVersionFlowStatus? = null, val version: String? = null)
Link copied to clipboard
data class GetGuardrailResult(val blockedInputMessaging: String? = null, val blockedOutputsMessaging: String? = null, val contentPolicyConfig: GuardrailContentPolicyConfig? = null, val contextualGroundingPolicyConfig: GuardrailContextualGroundingPolicyConfig? = null, val createdAt: String? = null, val description: String? = null, val failureRecommendations: List<String>? = null, val guardrailArn: String? = null, val guardrailId: String? = null, val kmsKeyArn: String? = null, val name: String? = null, val sensitiveInformationPolicyConfig: GuardrailSensitiveInformationPolicyConfig? = null, val status: GuardrailStatus? = null, val statusReasons: List<String>? = null, val tags: List<Tag>? = null, val topicPolicyConfig: GuardrailTopicPolicyConfig? = null, val updatedAt: String? = null, val version: String? = null, val wordPolicyConfig: GuardrailWordPolicyConfig? = null)
Link copied to clipboard
data class GetGuardrailVersionResult(val guardrailArn: String? = null, val guardrailId: String? = null, val version: String? = null)
Link copied to clipboard
data class GetIntelligentPromptRouterResult(val createdAt: String? = null, val promptRouterArn: String? = null, val status: IntelligentPromptRouterPromptRouterStatus? = null, val tags: List<Tag>? = null, val type: IntelligentPromptRouterPromptRouterType? = null, val updatedAt: String? = null)
Link copied to clipboard
data class GetKnowledgeBaseResult(val createdAt: String? = null, val description: String? = null, val failureReasons: List<String>? = null, val knowledgeBaseArn: String? = null, val knowledgeBaseConfiguration: KnowledgeBaseConfiguration? = null, val knowledgeBaseId: String? = null, val name: String? = null, val roleArn: String? = null, val status: KnowledgeBaseStatus? = null, val tags: Map<String, String>? = null, val updatedAt: String? = null)
Link copied to clipboard
data class GetPromptResult(val arn: String? = null, val createdAt: String? = null, val customerEncryptionKeyArn: String? = null, val defaultVariant: String? = null, val description: String? = null, val id: String? = null, val name: String? = null, val tags: Map<String, String>? = null, val updatedAt: String? = null, val variants: List<PromptVariant>? = null, val version: String? = null)
Link copied to clipboard
data class GetPromptVersionResult(val arn: String? = null, val createdAt: String? = null, val customerEncryptionKeyArn: String? = null, val defaultVariant: String? = null, val name: String? = null, val promptId: String? = null, val updatedAt: String? = null, val variants: List<PromptVersionPromptVariant>? = null, val version: String? = null)
Link copied to clipboard
data class GuardrailContentFilterConfig(val inputAction: GuardrailContentFilterAction? = null, val inputEnabled: Boolean? = null, val inputModalities: List<GuardrailModality>? = null, val inputStrength: GuardrailFilterStrength, val outputAction: GuardrailContentFilterAction? = null, val outputEnabled: Boolean? = null, val outputModalities: List<GuardrailModality>? = null, val outputStrength: GuardrailFilterStrength, val type: GuardrailContentFilterType)

Content filter config in content policy.

Link copied to clipboard

Content policy config for a guardrail.

Link copied to clipboard
data class GuardrailContextualGroundingFilterConfig(val action: GuardrailContextualGroundingAction? = null, val enabled: Boolean? = null, val threshold: Double, val type: GuardrailContextualGroundingFilterType)

A config for grounding filter.

Link copied to clipboard

Contextual grounding policy config for a guardrail.

Link copied to clipboard
data class GuardrailManagedWordsConfig(val inputAction: GuardrailWordAction? = null, val inputEnabled: Boolean? = null, val outputAction: GuardrailWordAction? = null, val outputEnabled: Boolean? = null, val type: GuardrailManagedWordsType)

A managed words config.

Link copied to clipboard
data class GuardrailPiiEntityConfig(val action: GuardrailSensitiveInformationAction, val inputAction: GuardrailSensitiveInformationAction? = null, val inputEnabled: Boolean? = null, val outputAction: GuardrailSensitiveInformationAction? = null, val outputEnabled: Boolean? = null, val type: GuardrailPiiEntityType)

Pii entity configuration.

Link copied to clipboard
data class GuardrailRegexConfig(val action: GuardrailSensitiveInformationAction, val description: String? = null, val inputAction: GuardrailSensitiveInformationAction? = null, val inputEnabled: Boolean? = null, val name: String, val outputAction: GuardrailSensitiveInformationAction? = null, val outputEnabled: Boolean? = null, val pattern: String)

A regex configuration.

data class GuardrailSensitiveInformationPolicyConfig(val piiEntitiesConfig: List<GuardrailPiiEntityConfig>? = null, val regexesConfig: List<GuardrailRegexConfig>? = null)

Sensitive information policy config for a guardrail.

Link copied to clipboard
data class GuardrailTopicConfig(val definition: String, val examples: List<String>? = null, val inputAction: GuardrailTopicAction? = null, val inputEnabled: Boolean? = null, val name: String, val outputAction: GuardrailTopicAction? = null, val outputEnabled: Boolean? = null, val type: GuardrailTopicType)

Topic config in topic policy.

Link copied to clipboard

Topic policy config for a guardrail.

Link copied to clipboard
data class GuardrailWordConfig(val inputAction: GuardrailWordAction? = null, val inputEnabled: Boolean? = null, val outputAction: GuardrailWordAction? = null, val outputEnabled: Boolean? = null, val text: String)

A custom word config.

Link copied to clipboard
data class GuardrailWordPolicyConfig(val managedWordListsConfig: List<GuardrailManagedWordsConfig>? = null, val wordsConfig: List<GuardrailWordConfig>? = null)

Word policy config for a guardrail.

Model configuration

Link copied to clipboard
data class IntelligentPromptRouterRoutingCriteria(val responseQualityDifference: Double)

Represents the criteria used for routing requests.

The vector configuration details for the Bedrock embeddings model.

Link copied to clipboard
data class KnowledgeBaseConfiguration(val kendraKnowledgeBaseConfiguration: KnowledgeBaseKendraKnowledgeBaseConfiguration? = null, val sqlKnowledgeBaseConfiguration: KnowledgeBaseSqlKnowledgeBaseConfiguration? = null, val type: KnowledgeBaseType, val vectorKnowledgeBaseConfiguration: KnowledgeBaseVectorKnowledgeBaseConfiguration? = null)

Contains details about the embeddings model used for the knowledge base.

Link copied to clipboard
data class KnowledgeBaseCuratedQuery(val naturalLanguage: String, val sql: String)

Curated query or question and answer pair

Link copied to clipboard
data class KnowledgeBaseEmbeddingModelConfiguration(val bedrockEmbeddingModelConfiguration: KnowledgeBaseBedrockEmbeddingModelConfiguration? = null)

The embeddings model configuration details for the vector model used in Knowledge Base.

Configurations for a Kendra knowledge base

Link copied to clipboard
data class KnowledgeBaseMongoDbAtlasConfiguration(val collectionName: String, val credentialsSecretArn: String, val databaseName: String, val endpoint: String, val endpointServiceName: String? = null, val fieldMapping: KnowledgeBaseMongoDbAtlasFieldMapping, val textIndexName: String? = null, val vectorIndexName: String)

Contains the storage configuration of the knowledge base in MongoDb Atlas Cloud.

Link copied to clipboard
data class KnowledgeBaseMongoDbAtlasFieldMapping(val metadataField: String, val textField: String, val vectorField: String)

Contains the names of the fields to which to map information about the vector store.

Contains the configurations to use Neptune Analytics as Vector Store.

data class KnowledgeBaseNeptuneAnalyticsFieldMapping(val metadataField: String, val textField: String)

A mapping of Bedrock Knowledge Base fields to Neptune Analytics fields.

data class KnowledgeBaseOpenSearchManagedClusterConfiguration(val domainArn: String, val domainEndpoint: String, val fieldMapping: KnowledgeBaseOpenSearchManagedClusterFieldMapping, val vectorIndexName: String)

Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.

data class KnowledgeBaseOpenSearchManagedClusterFieldMapping(val metadataField: String, val textField: String, val vectorField: String)

A mapping of Bedrock Knowledge Base fields to OpenSearch Managed Cluster field names

data class KnowledgeBaseOpenSearchServerlessConfiguration(val collectionArn: String, val fieldMapping: KnowledgeBaseOpenSearchServerlessFieldMapping, val vectorIndexName: String)

Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.

data class KnowledgeBaseOpenSearchServerlessFieldMapping(val metadataField: String, val textField: String, val vectorField: String)

A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names

Link copied to clipboard
data class KnowledgeBasePineconeConfiguration(val connectionString: String, val credentialsSecretArn: String, val fieldMapping: KnowledgeBasePineconeFieldMapping, val namespace: String? = null)

Contains the storage configuration of the knowledge base in Pinecone.

Link copied to clipboard
data class KnowledgeBasePineconeFieldMapping(val metadataField: String, val textField: String)

Contains the names of the fields to which to map information about the vector store.

Link copied to clipboard
data class KnowledgeBaseQueryGenerationColumn(val description: String? = null, val inclusion: KnowledgeBaseInclusionType? = null, val name: String? = null)

Redshift query generation column

data class KnowledgeBaseQueryGenerationConfiguration(val executionTimeoutSeconds: Int? = null, val generationContext: KnowledgeBaseQueryGenerationContext? = null)

Configurations for generating Redshift engine queries

Link copied to clipboard

Context used to improve query generation

Link copied to clipboard
data class KnowledgeBaseQueryGenerationTable(val columns: List<KnowledgeBaseQueryGenerationColumn>? = null, val description: String? = null, val inclusion: KnowledgeBaseInclusionType? = null, val name: String)

Tables used for Redshift query generation context

Link copied to clipboard
data class KnowledgeBaseRdsConfiguration(val credentialsSecretArn: String, val databaseName: String, val fieldMapping: KnowledgeBaseRdsFieldMapping, val resourceArn: String, val tableName: String)

Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.

Link copied to clipboard
data class KnowledgeBaseRdsFieldMapping(val customMetadataField: String? = null, val metadataField: String, val primaryKeyField: String, val textField: String, val vectorField: String)

Contains the names of the fields to which to map information about the vector store.

Link copied to clipboard
data class KnowledgeBaseRedshiftConfiguration(val queryEngineConfiguration: KnowledgeBaseRedshiftQueryEngineConfiguration, val queryGenerationConfiguration: KnowledgeBaseQueryGenerationConfiguration? = null, val storageConfigurations: List<KnowledgeBaseRedshiftQueryEngineStorageConfiguration>)

Configurations for a Redshift knowledge base

data class KnowledgeBaseRedshiftProvisionedAuthConfiguration(val databaseUser: String? = null, val type: KnowledgeBaseRedshiftProvisionedAuthType, val usernamePasswordSecretArn: String? = null)

Configurations for Redshift query engine provisioned auth setup

Configurations for provisioned Redshift query engine

Configurations for Redshift query engine AWS Data Catalog backed storage

Configurations for Redshift query engine

Configurations for Redshift query engine Redshift backed storage

Configurations for available Redshift query engine storage types

data class KnowledgeBaseRedshiftServerlessAuthConfiguration(val type: KnowledgeBaseRedshiftServerlessAuthType, val usernamePasswordSecretArn: String? = null)

Configurations for Redshift query engine serverless auth setup

Configurations for serverless Redshift query engine

Link copied to clipboard
data class KnowledgeBaseS3Location(val uri: String)

An Amazon S3 location.

Configurations for a SQL knowledge base

Link copied to clipboard
data class KnowledgeBaseStorageConfiguration(val mongoDbAtlasConfiguration: KnowledgeBaseMongoDbAtlasConfiguration? = null, val neptuneAnalyticsConfiguration: KnowledgeBaseNeptuneAnalyticsConfiguration? = null, val opensearchManagedClusterConfiguration: KnowledgeBaseOpenSearchManagedClusterConfiguration? = null, val opensearchServerlessConfiguration: KnowledgeBaseOpenSearchServerlessConfiguration? = null, val pineconeConfiguration: KnowledgeBasePineconeConfiguration? = null, val rdsConfiguration: KnowledgeBaseRdsConfiguration? = null, val type: KnowledgeBaseStorageType)

The vector store service in which the knowledge base is stored.

Configurations for supplemental data storage.

data class KnowledgeBaseSupplementalDataStorageLocation(val s3Location: KnowledgeBaseS3Location? = null, val supplementalDataStorageLocationType: KnowledgeBaseSupplementalDataStorageLocationType)

Supplemental data storage location.

data class KnowledgeBaseVectorKnowledgeBaseConfiguration(val embeddingModelArn: String, val embeddingModelConfiguration: KnowledgeBaseEmbeddingModelConfiguration? = null, val supplementalDataStorageConfiguration: KnowledgeBaseSupplementalDataStorageConfiguration? = null)

Contains details about the model used to create vector embeddings for the knowledge base.

Link copied to clipboard

Contains model-specific configurations

Link copied to clipboard
data class PromptAgentResource(val agentIdentifier: String)

Target Agent to invoke with Prompt

Link copied to clipboard

Any Tool choice

Link copied to clipboard

Auto Tool choice

Link copied to clipboard

CachePointBlock

Link copied to clipboard
data class PromptChatPromptTemplateConfiguration(val inputVariables: List<PromptInputVariable>? = null, val messages: List<PromptMessage>, val system: List<Either<PromptSystemContentBlock0Properties, PromptSystemContentBlock1Properties>>? = null, val toolConfiguration: PromptToolConfiguration? = null)

Configuration for chat prompt template

Link copied to clipboard

Configuration for chat prompt template

Link copied to clipboard

Configuration for chat prompt template

Link copied to clipboard

Target resource to invoke with Prompt

Link copied to clipboard

Model inference configuration

Link copied to clipboard
data class PromptInputVariable(val name: String? = null)

Input variable

Link copied to clipboard

Chat prompt Message

Link copied to clipboard
data class PromptMetadataEntry(val key: String, val value: String)

Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant.

Link copied to clipboard
data class PromptModelInferenceConfiguration(val maxTokens: Double? = null, val stopSequences: List<String>? = null, val temperature: Double? = null, val topP: Double? = null)

Prompt model inference configuration

Link copied to clipboard
data class PromptSpecificToolChoice(val name: String)

Specific Tool choice

Link copied to clipboard

Configuration for chat prompt template

Link copied to clipboard

Configuration for chat prompt template

Link copied to clipboard

Prompt template configuration

Link copied to clipboard

Prompt template configuration

Link copied to clipboard
data class PromptTextPromptTemplateConfiguration(val cachePoint: PromptCachePointBlock? = null, val inputVariables: List<PromptInputVariable>? = null, val text: String? = null, val textS3Location: PromptTextS3Location? = null)

Configuration for text prompt template

Link copied to clipboard
data class PromptTextS3Location(val bucket: String, val key: String, val version: String? = null)

The identifier for the S3 resource.

Link copied to clipboard

Tool details

Link copied to clipboard
data class PromptTool1Properties(val cachePoint: PromptCachePointBlock)

Tool details

Link copied to clipboard

Tool choice

Link copied to clipboard

Tool choice

Link copied to clipboard

Tool choice

Link copied to clipboard
data class PromptToolConfiguration(val toolChoice: Any? = null, val tools: List<Either<PromptTool0Properties, PromptTool1Properties>>)

Tool configuration

Link copied to clipboard
data class PromptToolInputSchemaProperties(val json: Any)

Tool input schema json

Link copied to clipboard
data class PromptToolSpecification(val description: String? = null, val inputSchema: PromptToolInputSchemaProperties, val name: String)

Tool specification

Link copied to clipboard
data class PromptVariant(val additionalModelRequestFields: PromptAdditionalModelRequestFields? = null, val genAiResource: PromptGenAiResourceProperties? = null, val inferenceConfiguration: PromptInferenceConfigurationProperties? = null, val metadata: List<PromptMetadataEntry>? = null, val modelId: String? = null, val name: String, val templateConfiguration: Either<PromptTemplateConfiguration0Properties, PromptTemplateConfiguration1Properties>, val templateType: PromptTemplateType)

Prompt variant

Contains model-specific configurations

Link copied to clipboard

Any Tool choice

Link copied to clipboard

Auto Tool choice

Link copied to clipboard

CachePointBlock

Configuration for chat prompt template

Link copied to clipboard

Configuration for chat prompt template

Link copied to clipboard

Configuration for chat prompt template

Link copied to clipboard
Link copied to clipboard
data class PromptVersionPromptAgentResource(val agentIdentifier: String)

Target Agent to invoke with Prompt

Target resource to invoke with Prompt

Link copied to clipboard
data class PromptVersionPromptInputVariable(val name: String? = null)

Input variable

Link copied to clipboard
data class PromptVersionPromptMetadataEntry(val key: String, val value: String)

Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant.

data class PromptVersionPromptModelInferenceConfiguration(val maxTokens: Double? = null, val stopSequences: List<String>? = null, val temperature: Double? = null, val topP: Double? = null)

Prompt model inference configuration

Link copied to clipboard
data class PromptVersionPromptVariant(val additionalModelRequestFields: PromptVersionAdditionalModelRequestFields? = null, val genAiResource: PromptVersionPromptGenAiResourceProperties? = null, val inferenceConfiguration: PromptVersionPromptInferenceConfigurationProperties? = null, val metadata: List<PromptVersionPromptMetadataEntry>? = null, val modelId: String? = null, val name: String, val templateConfiguration: Either<PromptVersionPromptTemplateConfiguration0Properties, PromptVersionPromptTemplateConfiguration1Properties>, val templateType: PromptVersionPromptTemplateType)

Prompt variant

Link copied to clipboard

Specific Tool choice

Configuration for chat prompt template

Configuration for chat prompt template

data class PromptVersionTextPromptTemplateConfiguration(val cachePoint: PromptVersionCachePointBlock? = null, val inputVariables: List<PromptVersionPromptInputVariable>? = null, val text: String)

Configuration for text prompt template

Link copied to clipboard

Tool details

Link copied to clipboard

Tool details

Link copied to clipboard
data class PromptVersionToolConfiguration(val toolChoice: Any? = null, val tools: List<Either<PromptVersionTool0Properties, PromptVersionTool1Properties>>)

Tool configuration

Link copied to clipboard

Tool input schema json

Link copied to clipboard
data class PromptVersionToolSpecification(val description: String? = null, val inputSchema: PromptVersionToolInputSchemaProperties, val name: String)

Tool specification