Package-level declarations

Types

Link copied to clipboard
data class AgentActionGroupArgs(val actionGroupExecutor: Output<Either<AgentActionGroupExecutor0PropertiesArgs, AgentActionGroupExecutor1PropertiesArgs>>? = null, val actionGroupName: Output<String>, val actionGroupState: Output<AgentActionGroupState>? = null, val apiSchema: Output<Either<AgentApiSchema0PropertiesArgs, AgentApiSchema1PropertiesArgs>>? = null, val description: Output<String>? = null, val functionSchema: Output<AgentFunctionSchemaArgs>? = null, val parentActionGroupSignature: Output<AgentActionGroupSignature>? = null, val skipResourceInUseCheckOnDelete: Output<Boolean>? = null) : ConvertibleToJava<AgentActionGroupArgs>

Contains the information of an Agent Action Group

Link copied to clipboard
data class AgentActionGroupExecutor0PropertiesArgs(val lambda: Output<String>) : ConvertibleToJava<AgentActionGroupExecutor0PropertiesArgs>

Type of Executors for an Action Group

Link copied to clipboard
data class AgentActionGroupExecutor1PropertiesArgs(val customControl: Output<AgentCustomControlMethod>) : ConvertibleToJava<AgentActionGroupExecutor1PropertiesArgs>

Type of Executors for an Action Group

data class AgentAliasRoutingConfigurationListItemArgs(val agentVersion: Output<String>) : ConvertibleToJava<AgentAliasRoutingConfigurationListItemArgs>

Details about the routing configuration for an Agent alias.

Link copied to clipboard
data class AgentApiSchema0PropertiesArgs(val s3: Output<AgentS3IdentifierArgs>) : ConvertibleToJava<AgentApiSchema0PropertiesArgs>

Contains information about the API Schema for the Action Group

Link copied to clipboard
data class AgentApiSchema1PropertiesArgs(val payload: Output<String>) : ConvertibleToJava<AgentApiSchema1PropertiesArgs>

Contains information about the API Schema for the Action Group

Link copied to clipboard
data class AgentFunctionArgs(val description: Output<String>? = null, val name: Output<String>, val parameters: Output<Map<String, AgentParameterDetailArgs>>? = null) : ConvertibleToJava<AgentFunctionArgs>

Function definition

Link copied to clipboard
Link copied to clipboard
data class AgentFunctionSchemaArgs(val functions: Output<List<AgentFunctionArgs>>) : ConvertibleToJava<AgentFunctionSchemaArgs>

Schema of Functions

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

Configuration for inference in prompt configuration

Link copied to clipboard
data class AgentKnowledgeBaseArgs(val description: Output<String>, val knowledgeBaseId: Output<String>, val knowledgeBaseState: Output<AgentKnowledgeBaseState>? = null) : ConvertibleToJava<AgentKnowledgeBaseArgs>

Agent Knowledge Base

Link copied to clipboard
data class AgentParameterDetailArgs(val description: Output<String>? = null, val required: Output<Boolean>? = null, val type: Output<AgentType>) : ConvertibleToJava<AgentParameterDetailArgs>

Parameter detail

Link copied to clipboard
data class AgentPromptConfigurationArgs(val basePromptTemplate: Output<String>? = null, val inferenceConfiguration: Output<AgentInferenceConfigurationArgs>? = null, val parserMode: Output<AgentCreationMode>? = null, val promptCreationMode: Output<AgentCreationMode>? = null, val promptState: Output<AgentPromptState>? = null, val promptType: Output<AgentPromptType>? = null) : ConvertibleToJava<AgentPromptConfigurationArgs>

BasePromptConfiguration per Prompt Type.

Link copied to clipboard
data class AgentPromptOverrideConfigurationArgs(val overrideLambda: Output<String>? = null, val promptConfigurations: Output<List<AgentPromptConfigurationArgs>>) : ConvertibleToJava<AgentPromptOverrideConfigurationArgs>

Configuration for prompt override.

Link copied to clipboard
data class AgentS3IdentifierArgs(val s3BucketName: Output<String>? = null, val s3ObjectKey: Output<String>? = null) : ConvertibleToJava<AgentS3IdentifierArgs>

The identifier for the S3 resource.

Link copied to clipboard
data class DataSourceChunkingConfigurationArgs(val chunkingStrategy: Output<DataSourceChunkingStrategy>, val fixedSizeChunkingConfiguration: Output<DataSourceFixedSizeChunkingConfigurationArgs>? = null) : ConvertibleToJava<DataSourceChunkingConfigurationArgs>

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 DataSourceConfigurationArgs(val s3Configuration: Output<DataSourceS3DataSourceConfigurationArgs>, val type: Output<DataSourceType>) : ConvertibleToJava<DataSourceConfigurationArgs>

Specifies a raw data source location to ingest.

data class DataSourceFixedSizeChunkingConfigurationArgs(val maxTokens: Output<Int>, val overlapPercentage: Output<Int>) : ConvertibleToJava<DataSourceFixedSizeChunkingConfigurationArgs>

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

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

Contains information about the S3 configuration of the data source.

data class DataSourceServerSideEncryptionConfigurationArgs(val kmsKeyArn: Output<String>? = null) : ConvertibleToJava<DataSourceServerSideEncryptionConfigurationArgs>

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

data class DataSourceVectorIngestionConfigurationArgs(val chunkingConfiguration: Output<DataSourceChunkingConfigurationArgs>? = null) : ConvertibleToJava<DataSourceVectorIngestionConfigurationArgs>

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 GetAgentAliasPlainArgs(val agentAliasId: String, val agentId: String) : ConvertibleToJava<GetAgentAliasPlainArgs>
Link copied to clipboard
data class GetAgentPlainArgs(val agentId: String) : ConvertibleToJava<GetAgentPlainArgs>
Link copied to clipboard
Link copied to clipboard
data class GetDataSourcePlainArgs(val dataSourceId: String, val knowledgeBaseId: String) : ConvertibleToJava<GetDataSourcePlainArgs>
Link copied to clipboard
data class GetGuardrailPlainArgs(val guardrailArn: String) : ConvertibleToJava<GetGuardrailPlainArgs>
Link copied to clipboard
data class GetGuardrailVersionPlainArgs(val guardrailId: String, val version: String) : ConvertibleToJava<GetGuardrailVersionPlainArgs>
Link copied to clipboard
data class GetKnowledgeBasePlainArgs(val knowledgeBaseId: String) : ConvertibleToJava<GetKnowledgeBasePlainArgs>
Link copied to clipboard
data class GuardrailContentFilterConfigArgs(val inputStrength: Output<GuardrailFilterStrength>, val outputStrength: Output<GuardrailFilterStrength>, val type: Output<GuardrailContentFilterType>) : ConvertibleToJava<GuardrailContentFilterConfigArgs>

Content filter config in content policy.

Link copied to clipboard
data class GuardrailContentPolicyConfigArgs(val filtersConfig: Output<List<GuardrailContentFilterConfigArgs>>) : ConvertibleToJava<GuardrailContentPolicyConfigArgs>

Content policy config for a guardrail.

Link copied to clipboard
data class GuardrailManagedWordsConfigArgs(val type: Output<GuardrailManagedWordsType>) : ConvertibleToJava<GuardrailManagedWordsConfigArgs>

A managed words config.

Link copied to clipboard
data class GuardrailPiiEntityConfigArgs(val action: Output<GuardrailSensitiveInformationAction>, val type: Output<GuardrailPiiEntityType>) : ConvertibleToJava<GuardrailPiiEntityConfigArgs>

Pii entity configuration.

Link copied to clipboard
data class GuardrailRegexConfigArgs(val action: Output<GuardrailSensitiveInformationAction>, val description: Output<String>? = null, val name: Output<String>, val pattern: Output<String>) : ConvertibleToJava<GuardrailRegexConfigArgs>

A regex configuration.

data class GuardrailSensitiveInformationPolicyConfigArgs(val piiEntitiesConfig: Output<List<GuardrailPiiEntityConfigArgs>>? = null, val regexesConfig: Output<List<GuardrailRegexConfigArgs>>? = null) : ConvertibleToJava<GuardrailSensitiveInformationPolicyConfigArgs>

Sensitive information policy config for a guardrail.

Link copied to clipboard
data class GuardrailTopicConfigArgs(val definition: Output<String>, val examples: Output<List<String>>? = null, val name: Output<String>, val type: Output<GuardrailTopicType>) : ConvertibleToJava<GuardrailTopicConfigArgs>

Topic config in topic policy.

Link copied to clipboard
data class GuardrailTopicPolicyConfigArgs(val topicsConfig: Output<List<GuardrailTopicConfigArgs>>) : ConvertibleToJava<GuardrailTopicPolicyConfigArgs>

Topic policy config for a guardrail.

Link copied to clipboard
data class GuardrailWordConfigArgs(val text: Output<String>) : ConvertibleToJava<GuardrailWordConfigArgs>

A custom word config.

Link copied to clipboard
data class GuardrailWordPolicyConfigArgs(val managedWordListsConfig: Output<List<GuardrailManagedWordsConfigArgs>>? = null, val wordsConfig: Output<List<GuardrailWordConfigArgs>>? = null) : ConvertibleToJava<GuardrailWordPolicyConfigArgs>

Word policy config for a guardrail.

Link copied to clipboard
data class KnowledgeBaseConfigurationArgs(val type: Output<KnowledgeBaseType>, val vectorKnowledgeBaseConfiguration: Output<KnowledgeBaseVectorKnowledgeBaseConfigurationArgs>) : ConvertibleToJava<KnowledgeBaseConfigurationArgs>

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

data class KnowledgeBaseOpenSearchServerlessConfigurationArgs(val collectionArn: Output<String>, val fieldMapping: Output<KnowledgeBaseOpenSearchServerlessFieldMappingArgs>, val vectorIndexName: Output<String>) : ConvertibleToJava<KnowledgeBaseOpenSearchServerlessConfigurationArgs>

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

data class KnowledgeBaseOpenSearchServerlessFieldMappingArgs(val metadataField: Output<String>, val textField: Output<String>, val vectorField: Output<String>) : ConvertibleToJava<KnowledgeBaseOpenSearchServerlessFieldMappingArgs>

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

Link copied to clipboard
data class KnowledgeBasePineconeConfigurationArgs(val connectionString: Output<String>, val credentialsSecretArn: Output<String>, val fieldMapping: Output<KnowledgeBasePineconeFieldMappingArgs>, val namespace: Output<String>? = null) : ConvertibleToJava<KnowledgeBasePineconeConfigurationArgs>

Contains the storage configuration of the knowledge base in Pinecone.

Link copied to clipboard
data class KnowledgeBasePineconeFieldMappingArgs(val metadataField: Output<String>, val textField: Output<String>) : ConvertibleToJava<KnowledgeBasePineconeFieldMappingArgs>

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

Link copied to clipboard
data class KnowledgeBaseRdsConfigurationArgs(val credentialsSecretArn: Output<String>, val databaseName: Output<String>, val fieldMapping: Output<KnowledgeBaseRdsFieldMappingArgs>, val resourceArn: Output<String>, val tableName: Output<String>) : ConvertibleToJava<KnowledgeBaseRdsConfigurationArgs>

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 KnowledgeBaseRdsFieldMappingArgs(val metadataField: Output<String>, val primaryKeyField: Output<String>, val textField: Output<String>, val vectorField: Output<String>) : ConvertibleToJava<KnowledgeBaseRdsFieldMappingArgs>

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

Link copied to clipboard
data class KnowledgeBaseStorageConfigurationArgs(val opensearchServerlessConfiguration: Output<KnowledgeBaseOpenSearchServerlessConfigurationArgs>? = null, val pineconeConfiguration: Output<KnowledgeBasePineconeConfigurationArgs>? = null, val rdsConfiguration: Output<KnowledgeBaseRdsConfigurationArgs>? = null, val type: Output<KnowledgeBaseStorageType>) : ConvertibleToJava<KnowledgeBaseStorageConfigurationArgs>

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

data class KnowledgeBaseVectorKnowledgeBaseConfigurationArgs(val embeddingModelArn: Output<String>) : ConvertibleToJava<KnowledgeBaseVectorKnowledgeBaseConfigurationArgs>

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