AppIntegrationsConfiguration
Configuration information for Amazon AppIntegrations to automatically ingest content.
Contents
appIntegrationArn
The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: ^arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+$
Required: Yes objectFields
The fields from the source that are made available to your agents in Wisdom.
• For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.
• For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.
Make sure to include additional fields. These fields are indexed and used to source recommendations.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AssistantAssociationData
AssistantAssociationData
Information about the assistant association.
Contents
assistantArn
The Amazon Resource Name (ARN) of the Wisdom assistant.
Type: String
The Amazon Resource Name (ARN) of the assistant association.
Type: String
The identifier of the assistant association.
Type: String
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: Yes assistantId
The identifier of the Wisdom assistant.
Type: String
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: Yes associationData
A union type that currently has a single argument, the knowledge base ID.
Type: AssistantAssociationOutputData (p. 91) object Required: Yes
associationType
The type of association.
Type: String
See Also
Valid Values: KNOWLEDGE_BASE Required: Yes
tags
The tags used to organize, track, or control access for this resource.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AssistantAssociationInputData
AssistantAssociationInputData
The data that is input into Wisdom as a result of the assistant association.
Contents
knowledgeBaseId
The identifier of the knowledge base.
Type: String
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AssistantAssociationOutputData
AssistantAssociationOutputData
The data that is output as a result of the assistant association.
Contents
knowledgeBaseAssociation
The knowledge base where output data is sent.
Type: KnowledgeBaseAssociationData (p. 110) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AssistantAssociationSummary
AssistantAssociationSummary
Summary information about the assistant association.
Contents
assistantArn
The Amazon Resource Name (ARN) of the Wisdom assistant.
Type: String
The Amazon Resource Name (ARN) of the assistant association.
Type: String
The identifier of the assistant association.
Type: String
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: Yes assistantId
The identifier of the Wisdom assistant.
Type: String
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: Yes associationData
The association data.
Type: AssistantAssociationOutputData (p. 91) object Required: Yes
associationType
The type of association.
Type: String
See Also
Valid Values: KNOWLEDGE_BASE Required: Yes
tags
The tags used to organize, track, or control access for this resource.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AssistantData
AssistantData
The assistant data.
Contents
assistantArn
The Amazon Resource Name (ARN) of the Wisdom assistant.
Type: String
Pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a- f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$
Required: Yes assistantId
The identifier of the Wisdom assistant.
Type: String
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: Yes description
The description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\s_.,-]+
Required: No name
The name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\s_.,-]+
Required: Yes
serverSideEncryptionConfiguration The KMS key used for encryption.
Type: ServerSideEncryptionConfiguration (p. 121) object Required: No
status
The status of the assistant.
See Also
Type: String
Valid Values: CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS
| DELETE_FAILED | DELETED Required: Yes
tags
The tags used to organize, track, or control access for this resource.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No type
The type of assistant.
Type: String
Valid Values: AGENT Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AssistantSummary
AssistantSummary
Summary information about the assistant.
Contents
assistantArn
The Amazon Resource Name (ARN) of the Wisdom assistant.
Type: String
Pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a- f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$
Required: Yes assistantId
The identifier of the Wisdom assistant.
Type: String
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: Yes description
The description of the assistant.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\s_.,-]+
Required: No name
The name of the assistant.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\s_.,-]+
Required: Yes
serverSideEncryptionConfiguration The KMS key used for encryption.
Type: ServerSideEncryptionConfiguration (p. 121) object Required: No
status
The status of the assistant.
See Also
Type: String
Valid Values: CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS
| DELETE_FAILED | DELETED Required: Yes
tags
The tags used to organize, track, or control access for this resource.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No type
The type of the assistant.
Type: String
Valid Values: AGENT Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ContentData
ContentData
Information about the content.
Contents
contentArn
The Amazon Resource Name (ARN) of the content.
Type: String
The identifier of the content.
Type: String
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: Yes contentType
The media type of the content.
Type: String
Pattern: ^(text/(plain|html))|(application/x\.wisdom-json;source=(salesforce|
servicenow))$
Required: Yes knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
Type: String
The identifier of the knowledge base.
Type: String
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: Yes linkOutUri
The URI of the content.
Contents
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: No metadata
A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 4096.
Value Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: Yes name
The name of the content.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\s_.,-]+
Required: Yes revisionId
The identifier of the content revision.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: Yes status
The status of the content.
Type: String
Valid Values: CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS
| DELETE_FAILED | DELETED | UPDATE_FAILED Required: Yes
tags
The tags used to organize, track, or control access for this resource.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
See Also
title
The title of the content.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes url
The URL of the content.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: Yes urlExpiry
The expiration time of the URL as an epoch timestamp.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ContentReference
ContentReference
Reference information about the content.
Contents
contentArn
The Amazon Resource Name (ARN) of the content.
Type: String
Pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a- f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$
Required: No contentId
The identifier of the content.
Type: String
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: No knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
Type: String
Pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a- f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$
Required: No knowledgeBaseId
The identifier of the knowledge base.
Type: String
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
See Also
ContentSummary
ContentSummary
Summary information about the content.
Contents
contentArn
The Amazon Resource Name (ARN) of the content.
Type: String
Pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a- f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$
Required: Yes contentId
The identifier of the content.
Type: String
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: Yes contentType
The media type of the content.
Type: String
Pattern: ^(text/(plain|html))|(application/x\.wisdom-json;source=(salesforce|
servicenow))$
Required: Yes knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
Type: String
Pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a- f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$
Required: Yes knowledgeBaseId
The identifier of the knowledge base.
Type: String
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: Yes
Contents
metadata
A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 4096.
Value Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: Yes name
The name of the content.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\s_.,-]+
Required: Yes revisionId
The identifier of the revision of the content.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: Yes status
The status of the content.
Type: String
Valid Values: CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS
| DELETE_FAILED | DELETED | UPDATE_FAILED Required: Yes
tags
The tags used to organize, track, or control access for this resource.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No title
The title of the content.
Type: String
See Also
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Document
Document
The document.
Contents
contentReference
A reference to the content resource.
Type: ContentReference (p. 101) object Required: Yes
excerpt
The excerpt from the document.
Type: DocumentText (p. 107) object Required: No
title
The title of the document.
Type: DocumentText (p. 107) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DocumentText
DocumentText
The text of the document.
Contents
highlights
Highlights in the document text.
Type: Array of Highlight (p. 109) objects Required: No
text
Text in the document.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Filter
Filter
A search filter.
Contents
field
The field on which to filter.
Type: String Valid Values: NAME Required: Yes operator
The operator to use for comparing the field’s value with the provided value.
Type: String
Valid Values: EQUALS Required: Yes
value
The desired field value on which to filter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Highlight
Highlight
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
Contents
beginOffsetInclusive
The offset for the start of the highlight.
Type: Integer Required: No endOffsetExclusive
The offset for the end of the highlight.
Type: Integer Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
KnowledgeBaseAssociationData
KnowledgeBaseAssociationData
Association information about the knowledge base.
Contents
knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
Type: String
Pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a- f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$
Required: No knowledgeBaseId
The identifier of the knowledge base.
Type: String
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
KnowledgeBaseData
KnowledgeBaseData
Information about the knowledge base.
Contents
description
The description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\s_.,-]+
Required: No knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
Type: String
Pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a- f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$
Required: Yes knowledgeBaseId
The identifier of the knowledge base.
Type: String
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: Yes knowledgeBaseType
The type of knowledge base.
Type: String
Valid Values: EXTERNAL | CUSTOM Required: Yes
lastContentModificationTime
An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.
Type: Timestamp Required: No name
The name of the knowledge base.
See Also
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\s_.,-]+
Required: Yes renderingConfiguration
Information about how to render the content.
Type: RenderingConfiguration (p. 118) object Required: No
serverSideEncryptionConfiguration The KMS key used for encryption.
Type: ServerSideEncryptionConfiguration (p. 121) object Required: No
sourceConfiguration
Source configuration information about the knowledge base.
Type: SourceConfiguration (p. 126) object Required: No
status
The status of the knowledge base.
Type: String
Valid Values: CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS
| DELETE_FAILED | DELETED Required: Yes
tags
The tags used to organize, track, or control access for this resource.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
See Also
• AWS SDK for Java V2
• AWS SDK for Ruby V3
KnowledgeBaseSummary
KnowledgeBaseSummary
Summary information about the knowledge base.
Contents
description
The description of the knowledge base.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\s_.,-]+
Required: No knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
Type: String
Pattern: ^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a- f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$
Required: Yes knowledgeBaseId
The identifier of the knowledge base.
Type: String
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: Yes knowledgeBaseType
The type of knowledge base.
Type: String
Valid Values: EXTERNAL | CUSTOM Required: Yes
name
The name of the knowledge base.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z0-9\s_.,-]+
Required: Yes
See Also
renderingConfiguration
Information about how to render the content.
Type: RenderingConfiguration (p. 118) object Required: No
serverSideEncryptionConfiguration The KMS key used for encryption.
Type: ServerSideEncryptionConfiguration (p. 121) object Required: No
sourceConfiguration
Configuration information about the external data source.
Type: SourceConfiguration (p. 126) object Required: No
status
The status of the knowledge base summary.
Type: String
Valid Values: CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS
| DELETE_FAILED | DELETED Required: Yes
tags
The tags used to organize, track, or control access for this resource.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
NotifyRecommendationsReceivedError
NotifyRecommendationsReceivedError
An error occurred when creating a recommendation.
Contents
message
A recommendation is causing an error.
Type: String Required: No recommendationId
The identifier of the recommendation that is in error.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
RecommendationData
RecommendationData
Information about the recommendation.
Contents
document
The recommended document.
Type: Document (p. 106) object Required: Yes
recommendationId
The identifier of the recommendation.
Type: String Required: Yes relevanceLevel
The relevance level of the recommendation.
Type: String
Valid Values: HIGH | MEDIUM | LOW Required: No
relevanceScore
The relevance score of the recommendation.
Type: Double
Valid Range: Minimum value of 0.0.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3