Package-level declarations

Types

Link copied to clipboard
Link copied to clipboard
data class AiAgentAiAgentConfiguration1Properties(val answerRecommendationAiAgentConfiguration: AiAgentAnswerRecommendationAiAgentConfiguration)
Link copied to clipboard
data class AiAgentAnswerRecommendationAiAgentConfiguration(val answerGenerationAiGuardrailId: String? = null, val answerGenerationAiPromptId: String? = null, val associationConfigurations: List<AiAgentAssociationConfiguration>? = null, val intentLabelingGenerationAiPromptId: String? = null, val locale: String? = null, val queryReformulationAiPromptId: String? = null)
Link copied to clipboard
data class AiAgentAssociationConfiguration(val associationConfigurationData: AiAgentAssociationConfigurationDataProperties? = null, val associationId: String? = null, val associationType: AiAgentAiAgentAssociationConfigurationType? = null)
data class AiAgentKnowledgeBaseAssociationConfigurationData(val contentTagFilter: Any? = null, val maxResults: Double? = null, val overrideKnowledgeBaseSearchType: AiAgentKnowledgeBaseSearchType? = null)
Link copied to clipboard
data class AiAgentManualSearchAiAgentConfiguration(val answerGenerationAiGuardrailId: String? = null, val answerGenerationAiPromptId: String? = null, val associationConfigurations: List<AiAgentAssociationConfiguration>? = null, val locale: String? = null)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class AiAgentSelfServiceAiAgentConfiguration(val associationConfigurations: List<AiAgentAssociationConfiguration>? = null, val selfServiceAiGuardrailId: String? = null, val selfServiceAnswerGenerationAiPromptId: String? = null, val selfServicePreProcessingAiPromptId: String? = null)
Link copied to clipboard
data class AiAgentTagCondition(val key: String, val value: String? = null)
Link copied to clipboard
data class AiAgentTagFilter0Properties(val tagCondition: AiAgentTagCondition)
Link copied to clipboard
data class AiAgentTagFilter1Properties(val andConditions: List<AiAgentTagCondition>)

Content policy config for a guardrail.

Contextual grounding policy config for a guardrail.

Sensitive information policy config for a guardrail.

Link copied to clipboard

Topic policy config for a guardrail.

Link copied to clipboard
data class AiGuardrailAiGuardrailWordPolicyConfig(val managedWordListsConfig: List<AiGuardrailGuardrailManagedWordsConfig>? = null, val wordsConfig: List<AiGuardrailGuardrailWordConfig>? = null)

Word policy config for a guardrail.

Link copied to clipboard

Content filter config in content policy.

Link copied to clipboard
data class AiGuardrailGuardrailRegexConfig(val action: AiGuardrailGuardrailSensitiveInformationAction, val description: String? = null, val name: String, val pattern: String)

A regex configuration.

Link copied to clipboard
data class AiGuardrailGuardrailTopicConfig(val definition: String, val examples: List<String>? = null, val name: String, val type: AiGuardrailGuardrailTopicType)

Topic config in topic policy.

Link copied to clipboard

A custom word config.

Link copied to clipboard
data class AssistantAssociationAssociationData(val knowledgeBaseId: String)
data class AssistantServerSideEncryptionConfiguration(val kmsKeyId: String? = null)
Link copied to clipboard
data class GetAiAgentResult(val aiAgentArn: String? = null, val aiAgentId: String? = null, val assistantArn: String? = null, val configuration: Any? = null, val description: String? = null, val modifiedTimeSeconds: Double? = null)
Link copied to clipboard
data class GetAiAgentVersionResult(val aiAgentArn: String? = null, val aiAgentVersionId: String? = null, val assistantArn: String? = null, val versionNumber: Double? = null)
Link copied to clipboard
data class GetAiGuardrailResult(val aiGuardrailArn: String? = null, val aiGuardrailId: String? = null, val assistantArn: String? = null, val blockedInputMessaging: String? = null, val blockedOutputsMessaging: String? = null, val contentPolicyConfig: AiGuardrailAiGuardrailContentPolicyConfig? = null, val contextualGroundingPolicyConfig: AiGuardrailAiGuardrailContextualGroundingPolicyConfig? = null, val description: String? = null, val sensitiveInformationPolicyConfig: AiGuardrailAiGuardrailSensitiveInformationPolicyConfig? = null, val topicPolicyConfig: AiGuardrailAiGuardrailTopicPolicyConfig? = null, val wordPolicyConfig: AiGuardrailAiGuardrailWordPolicyConfig? = null)
Link copied to clipboard
data class GetAiGuardrailVersionResult(val aiGuardrailArn: String? = null, val aiGuardrailVersionId: String? = null, val assistantArn: String? = null, val versionNumber: Double? = null)
Link copied to clipboard
data class GetAiPromptResult(val aiPromptArn: String? = null, val aiPromptId: String? = null, val assistantArn: String? = null, val description: String? = null, val modifiedTimeSeconds: Double? = null, val templateConfiguration: AiPromptAiPromptTemplateConfiguration? = null)
Link copied to clipboard
data class GetAiPromptVersionResult(val aiPromptArn: String? = null, val aiPromptVersionId: String? = null, val assistantArn: String? = null, val versionNumber: Double? = null)
Link copied to clipboard
data class GetAssistantAssociationResult(val assistantArn: String? = null, val assistantAssociationArn: String? = null, val assistantAssociationId: String? = null)
Link copied to clipboard
data class GetAssistantResult(val assistantArn: String? = null, val assistantId: String? = null)
Link copied to clipboard
data class GetKnowledgeBaseResult(val knowledgeBaseArn: String? = null, val knowledgeBaseId: String? = null, val renderingConfiguration: KnowledgeBaseRenderingConfiguration? = null, val vectorIngestionConfiguration: KnowledgeBaseVectorIngestionConfiguration? = null)
Link copied to clipboard
data class GetMessageTemplateResult(val content: MessageTemplateContent? = null, val defaultAttributes: MessageTemplateAttributes? = null, val description: String? = null, val groupingConfiguration: MessageTemplateGroupingConfiguration? = null, val language: String? = null, val messageTemplateArn: String? = null, val messageTemplateContentSha256: String? = null, val messageTemplateId: String? = null, val name: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetMessageTemplateVersionResult(val messageTemplateContentSha256: String? = null, val messageTemplateVersionArn: String? = null, val messageTemplateVersionNumber: Double? = null)
data class KnowledgeBaseAppIntegrationsConfiguration(val appIntegrationArn: String, val objectFields: List<String>? = null)

The parsing prompt of the Bedrock foundation model configuration.

data class KnowledgeBaseFixedSizeChunkingConfiguration(val maxTokens: Double, val overlapPercentage: Double)
Link copied to clipboard
data class KnowledgeBaseRenderingConfiguration(val templateUri: String? = null)
Link copied to clipboard
data class KnowledgeBaseSeedUrl(val url: String? = null)
data class KnowledgeBaseSemanticChunkingConfiguration(val breakpointPercentileThreshold: Double, val bufferSize: Double, val maxTokens: Double)

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 KnowledgeBaseWebCrawlerConfiguration(val crawlerLimits: KnowledgeBaseWebCrawlerConfigurationCrawlerLimitsProperties? = null, val exclusionFilters: List<String>? = null, val inclusionFilters: List<String>? = null, val scope: KnowledgeBaseWebCrawlerConfigurationScope? = null, val urlConfiguration: KnowledgeBaseWebCrawlerConfigurationUrlConfigurationProperties)
Link copied to clipboard
data class MessageTemplateAgentAttributes(val firstName: String? = null, val lastName: String? = null)

The agent attributes that are used with the message template.

Link copied to clipboard
data class MessageTemplateAttributes(val agentAttributes: MessageTemplateAgentAttributes? = null, val customAttributes: Map<String, String>? = null, val customerProfileAttributes: MessageTemplateCustomerProfileAttributes? = null, val systemAttributes: MessageTemplateSystemAttributes? = null)

An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.

Link copied to clipboard
data class MessageTemplateBodyContentProvider(val content: String? = null)

The container of message template body.

Link copied to clipboard
data class MessageTemplateContent(val emailMessageTemplateContent: MessageTemplateEmailMessageTemplateContent? = null, val smsMessageTemplateContent: MessageTemplateSmsMessageTemplateContent? = null)

The content of the message template.

Link copied to clipboard
data class MessageTemplateCustomerProfileAttributes(val accountNumber: String? = null, val additionalInformation: String? = null, val address1: String? = null, val address2: String? = null, val address3: String? = null, val address4: String? = null, val billingAddress1: String? = null, val billingAddress2: String? = null, val billingAddress3: String? = null, val billingAddress4: String? = null, val billingCity: String? = null, val billingCountry: String? = null, val billingCounty: String? = null, val billingPostalCode: String? = null, val billingProvince: String? = null, val billingState: String? = null, val birthDate: String? = null, val businessEmailAddress: String? = null, val businessName: String? = null, val businessPhoneNumber: String? = null, val city: String? = null, val country: String? = null, val county: String? = null, val custom: Map<String, String>? = null, val emailAddress: String? = null, val firstName: String? = null, val gender: String? = null, val homePhoneNumber: String? = null, val lastName: String? = null, val mailingAddress1: String? = null, val mailingAddress2: String? = null, val mailingAddress3: String? = null, val mailingAddress4: String? = null, val mailingCity: String? = null, val mailingCountry: String? = null, val mailingCounty: String? = null, val mailingPostalCode: String? = null, val mailingProvince: String? = null, val mailingState: String? = null, val middleName: String? = null, val mobilePhoneNumber: String? = null, val partyType: String? = null, val phoneNumber: String? = null, val postalCode: String? = null, val profileArn: String? = null, val profileId: String? = null, val province: String? = null, val shippingAddress1: String? = null, val shippingAddress2: String? = null, val shippingAddress3: String? = null, val shippingAddress4: String? = null, val shippingCity: String? = null, val shippingCountry: String? = null, val shippingCounty: String? = null, val shippingPostalCode: String? = null, val shippingProvince: String? = null, val shippingState: String? = null, val state: String? = null)

The customer profile attributes that are used with the message template.

The content of message template that applies to email channel subtype.

The body to use in email messages.

data class MessageTemplateEmailMessageTemplateHeader(val name: String? = null, val value: String? = null)

The email header to include in email messages.

Link copied to clipboard
data class MessageTemplateGroupingConfiguration(val criteria: String, val values: List<String>)

The configuration information of the user groups that the message template is accessible to.

Link copied to clipboard

The content of message template that applies to SMS channel subtype.

The body to use in SMS messages.

Link copied to clipboard
data class MessageTemplateSystemAttributes(val customerEndpoint: MessageTemplateSystemEndpointAttributes? = null, val name: String? = null, val systemEndpoint: MessageTemplateSystemEndpointAttributes? = null)

The system attributes that are used with the message template.

Link copied to clipboard
data class MessageTemplateSystemEndpointAttributes(val address: String? = null)

The system endpoint attributes that are used with the message template.