Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they\'re actively speaking with customers. Agents can search across connected repositories from within their agent desktop to find answers quickly. Use Amazon Connect Wisdom to create an assistant and a knowledge base, for example, or manage content by uploading custom files.
', 'operations' => [ 'CreateAssistant' => 'Creates an Amazon Connect Wisdom assistant.
', 'CreateAssistantAssociation' => 'Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
', 'CreateContent' => 'Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.
', 'CreateKnowledgeBase' => 'Creates a knowledge base.
When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you\'ll get an InvalidRequestException error.
For example, you\'re programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:
Call DeleteKnowledgeBase.
Call DeleteDataIntegration.
Call CreateDataIntegration to recreate the DataIntegration or a create different one.
Call CreateKnowledgeBase.
Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled.
', 'DeleteAssistant' => 'Deletes an assistant.
', 'DeleteAssistantAssociation' => 'Deletes an assistant association.
', 'DeleteContent' => 'Deletes the content.
', 'DeleteKnowledgeBase' => 'Deletes the knowledge base.
When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can\'t reuse the DataIntegration after it\'s been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.
Retrieves information about an assistant.
', 'GetAssistantAssociation' => 'Retrieves information about an assistant association.
', 'GetContent' => 'Retrieves content, including a pre-signed URL to download the content.
', 'GetContentSummary' => 'Retrieves summary information about the content.
', 'GetKnowledgeBase' => 'Retrieves information about the knowledge base.
', 'GetRecommendations' => 'Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.
Retrieves information for a specified session.
', 'ListAssistantAssociations' => 'Lists information about assistant associations.
', 'ListAssistants' => 'Lists information about assistants.
', 'ListContents' => 'Lists the content.
', 'ListKnowledgeBases' => 'Lists the knowledge bases.
', 'ListTagsForResource' => 'Lists the tags for the specified resource.
', 'NotifyRecommendationsReceived' => 'Removes the specified recommendations from the specified assistant\'s queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.
Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
', 'RemoveKnowledgeBaseTemplateUri' => 'Removes a URI template from a knowledge base.
', 'SearchContent' => 'Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
', 'SearchSessions' => 'Searches for sessions.
', 'StartContentUpload' => 'Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.
', 'TagResource' => 'Adds the specified tags to the specified resource.
', 'UntagResource' => 'Removes the specified tags from the specified resource.
', 'UpdateContent' => 'Updates information about the content.
', 'UpdateKnowledgeBaseTemplateUri' => 'Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable} format; this interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.
You do not have sufficient access to perform this action.
', 'refs' => [], ], 'AppIntegrationsConfiguration' => [ 'base' => 'Configuration information for Amazon AppIntegrations to automatically ingest content.
', 'refs' => [ 'SourceConfiguration$appIntegrations' => 'Configuration information for Amazon AppIntegrations to automatically ingest content.
', ], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'AssistantAssociationData$assistantArn' => 'The Amazon Resource Name (ARN) of the Wisdom assistant.
', 'AssistantAssociationData$assistantAssociationArn' => 'The Amazon Resource Name (ARN) of the assistant association.
', 'AssistantAssociationSummary$assistantArn' => 'The Amazon Resource Name (ARN) of the Wisdom assistant.
', 'AssistantAssociationSummary$assistantAssociationArn' => 'The Amazon Resource Name (ARN) of the assistant association.
', 'AssistantData$assistantArn' => 'The Amazon Resource Name (ARN) of the Wisdom assistant.
', 'AssistantSummary$assistantArn' => 'The Amazon Resource Name (ARN) of the Wisdom assistant.
', 'ContentData$contentArn' => 'The Amazon Resource Name (ARN) of the content.
', 'ContentData$knowledgeBaseArn' => 'The Amazon Resource Name (ARN) of the knowledge base.
', 'ContentReference$contentArn' => 'The Amazon Resource Name (ARN) of the content.
', 'ContentReference$knowledgeBaseArn' => 'The Amazon Resource Name (ARN) of the knowledge base.
', 'ContentSummary$contentArn' => 'The Amazon Resource Name (ARN) of the content.
', 'ContentSummary$knowledgeBaseArn' => 'The Amazon Resource Name (ARN) of the knowledge base.
', 'KnowledgeBaseAssociationData$knowledgeBaseArn' => 'The Amazon Resource Name (ARN) of the knowledge base.
', 'KnowledgeBaseData$knowledgeBaseArn' => 'The Amazon Resource Name (ARN) of the knowledge base.
', 'KnowledgeBaseSummary$knowledgeBaseArn' => 'The Amazon Resource Name (ARN) of the knowledge base.
', 'ListTagsForResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource.
', 'SessionData$sessionArn' => 'The Amazon Resource Name (ARN) of the session.
', 'SessionSummary$assistantArn' => 'The Amazon Resource Name (ARN) of the Wisdom assistant.
', 'SessionSummary$sessionArn' => 'The Amazon Resource Name (ARN) of the session.
', 'TagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource.
', 'UntagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource.
', ], ], 'AssistantAssociationData' => [ 'base' => 'Information about the assistant association.
', 'refs' => [ 'CreateAssistantAssociationResponse$assistantAssociation' => 'The assistant association.
', 'GetAssistantAssociationResponse$assistantAssociation' => 'The assistant association.
', ], ], 'AssistantAssociationInputData' => [ 'base' => 'The data that is input into Wisdom as a result of the assistant association.
', 'refs' => [ 'CreateAssistantAssociationRequest$association' => 'The identifier of the associated resource.
', ], ], 'AssistantAssociationOutputData' => [ 'base' => 'The data that is output as a result of the assistant association.
', 'refs' => [ 'AssistantAssociationData$associationData' => 'A union type that currently has a single argument, the knowledge base ID.
', 'AssistantAssociationSummary$associationData' => 'The association data.
', ], ], 'AssistantAssociationSummary' => [ 'base' => 'Summary information about the assistant association.
', 'refs' => [ 'AssistantAssociationSummaryList$member' => NULL, ], ], 'AssistantAssociationSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListAssistantAssociationsResponse$assistantAssociationSummaries' => 'Summary information about assistant associations.
', ], ], 'AssistantData' => [ 'base' => 'The assistant data.
', 'refs' => [ 'CreateAssistantResponse$assistant' => 'Information about the assistant.
', 'GetAssistantResponse$assistant' => 'Information about the assistant.
', ], ], 'AssistantIntegrationConfiguration' => [ 'base' => 'The configuration information for the Wisdom assistant integration.
', 'refs' => [ 'AssistantData$integrationConfiguration' => 'The configuration information for the Wisdom assistant integration.
', 'AssistantSummary$integrationConfiguration' => 'The configuration information for the Wisdom assistant integration.
', ], ], 'AssistantList' => [ 'base' => NULL, 'refs' => [ 'ListAssistantsResponse$assistantSummaries' => 'Information about the assistants.
', ], ], 'AssistantStatus' => [ 'base' => NULL, 'refs' => [ 'AssistantData$status' => 'The status of the assistant.
', 'AssistantSummary$status' => 'The status of the assistant.
', ], ], 'AssistantSummary' => [ 'base' => 'Summary information about the assistant.
', 'refs' => [ 'AssistantList$member' => NULL, ], ], 'AssistantType' => [ 'base' => NULL, 'refs' => [ 'AssistantData$type' => 'The type of assistant.
', 'AssistantSummary$type' => 'The type of the assistant.
', 'CreateAssistantRequest$type' => 'The type of assistant.
', ], ], 'AssociationType' => [ 'base' => NULL, 'refs' => [ 'AssistantAssociationData$associationType' => 'The type of association.
', 'AssistantAssociationSummary$associationType' => 'The type of association.
', 'CreateAssistantAssociationRequest$associationType' => 'The type of association.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'UpdateContentRequest$removeOverrideLinkOutUri' => 'Unset the existing overrideLinkOutUri if it exists.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'CreateAssistantRequest$clientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'CreateSessionRequest$clientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', ], ], 'ConflictException' => [ 'base' => 'The request could not be processed because of conflict in the current state of the resource. For example, if you\'re using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
Information about the content.
', 'refs' => [ 'CreateContentResponse$content' => 'The content.
', 'GetContentResponse$content' => 'The content.
', 'UpdateContentResponse$content' => 'The content.
', ], ], 'ContentMetadata' => [ 'base' => NULL, 'refs' => [ 'ContentData$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.
', 'ContentSummary$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.
', 'CreateContentRequest$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.
', 'UpdateContentRequest$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.
', ], ], 'ContentReference' => [ 'base' => 'Reference information about the content.
', 'refs' => [ 'Document$contentReference' => 'A reference to the content resource.
', ], ], 'ContentStatus' => [ 'base' => NULL, 'refs' => [ 'ContentData$status' => 'The status of the content.
', 'ContentSummary$status' => 'The status of the content.
', ], ], 'ContentSummary' => [ 'base' => 'Summary information about the content.
', 'refs' => [ 'ContentSummaryList$member' => NULL, 'GetContentSummaryResponse$contentSummary' => 'The content summary.
', ], ], 'ContentSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListContentsResponse$contentSummaries' => 'Information about the content.
', 'SearchContentResponse$contentSummaries' => 'Summary information about the content.
', ], ], 'ContentTitle' => [ 'base' => NULL, 'refs' => [ 'ContentData$title' => 'The title of the content.
', 'ContentSummary$title' => 'The title of the content.
', 'CreateContentRequest$title' => 'The title of the content. If not set, the title is equal to the name.
', 'UpdateContentRequest$title' => 'The title of the content.
', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'ContentData$contentType' => 'The media type of the content.
', 'ContentSummary$contentType' => 'The media type of the content.
', 'StartContentUploadRequest$contentType' => 'The type of content to upload.
', ], ], 'CreateAssistantAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAssistantAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateAssistantRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateAssistantResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateKnowledgeBaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateKnowledgeBaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAssistantAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAssistantAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAssistantRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAssistantResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteKnowledgeBaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteKnowledgeBaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'AssistantData$description' => 'The description.
', 'AssistantSummary$description' => 'The description of the assistant.
', 'CreateAssistantRequest$description' => 'The description of the assistant.
', 'CreateKnowledgeBaseRequest$description' => 'The description.
', 'CreateSessionRequest$description' => 'The description.
', 'KnowledgeBaseData$description' => 'The description.
', 'KnowledgeBaseSummary$description' => 'The description of the knowledge base.
', 'SessionData$description' => 'The description of the session.
', ], ], 'Document' => [ 'base' => 'The document.
', 'refs' => [ 'RecommendationData$document' => 'The recommended document.
', 'ResultData$document' => 'The document.
', ], ], 'DocumentText' => [ 'base' => 'The text of the document.
', 'refs' => [ 'Document$excerpt' => 'The excerpt from the document.
', 'Document$title' => 'The title of the document.
', ], ], 'Filter' => [ 'base' => 'A search filter.
', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterField' => [ 'base' => NULL, 'refs' => [ 'Filter$field' => 'The field on which to filter.
', ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'SearchExpression$filters' => 'The search expression filters.
', ], ], 'FilterOperator' => [ 'base' => NULL, 'refs' => [ 'Filter$operator' => 'The operator to use for comparing the field’s value with the provided value.
', ], ], 'GenericArn' => [ 'base' => NULL, 'refs' => [ 'AppIntegrationsConfiguration$appIntegrationArn' => 'The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields.
For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields.
For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields.
For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt.
The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
', 'SessionIntegrationConfiguration$topicIntegrationArn' => 'The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
', ], ], 'GetAssistantAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAssistantAssociationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAssistantRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAssistantResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetContentSummaryRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetContentSummaryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetKnowledgeBaseRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetKnowledgeBaseResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRecommendationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRecommendationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'Headers' => [ 'base' => NULL, 'refs' => [ 'StartContentUploadResponse$headersToInclude' => 'The headers to include in the upload.
', ], ], 'Highlight' => [ 'base' => 'Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
', 'refs' => [ 'Highlights$member' => NULL, ], ], 'HighlightOffset' => [ 'base' => NULL, 'refs' => [ 'Highlight$beginOffsetInclusive' => 'The offset for the start of the highlight.
', 'Highlight$endOffsetExclusive' => 'The offset for the end of the highlight.
', ], ], 'Highlights' => [ 'base' => NULL, 'refs' => [ 'DocumentText$highlights' => 'Highlights in the document text.
', ], ], 'KnowledgeBaseAssociationData' => [ 'base' => 'Association information about the knowledge base.
', 'refs' => [ 'AssistantAssociationOutputData$knowledgeBaseAssociation' => 'The knowledge base where output data is sent.
', ], ], 'KnowledgeBaseData' => [ 'base' => 'Information about the knowledge base.
', 'refs' => [ 'CreateKnowledgeBaseResponse$knowledgeBase' => 'The knowledge base.
', 'GetKnowledgeBaseResponse$knowledgeBase' => 'The knowledge base.
', 'UpdateKnowledgeBaseTemplateUriResponse$knowledgeBase' => 'The knowledge base to update.
', ], ], 'KnowledgeBaseList' => [ 'base' => NULL, 'refs' => [ 'ListKnowledgeBasesResponse$knowledgeBaseSummaries' => 'Information about the knowledge bases.
', ], ], 'KnowledgeBaseStatus' => [ 'base' => NULL, 'refs' => [ 'KnowledgeBaseData$status' => 'The status of the knowledge base.
', 'KnowledgeBaseSummary$status' => 'The status of the knowledge base summary.
', ], ], 'KnowledgeBaseSummary' => [ 'base' => 'Summary information about the knowledge base.
', 'refs' => [ 'KnowledgeBaseList$member' => NULL, ], ], 'KnowledgeBaseType' => [ 'base' => NULL, 'refs' => [ 'CreateKnowledgeBaseRequest$knowledgeBaseType' => 'The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
', 'KnowledgeBaseData$knowledgeBaseType' => 'The type of knowledge base.
', 'KnowledgeBaseSummary$knowledgeBaseType' => 'The type of knowledge base.
', ], ], 'ListAssistantAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAssistantAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListAssistantsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAssistantsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListContentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListContentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListKnowledgeBasesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListKnowledgeBasesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'GetRecommendationsRequest$maxResults' => 'The maximum number of results to return per page.
', 'ListAssistantAssociationsRequest$maxResults' => 'The maximum number of results to return per page.
', 'ListAssistantsRequest$maxResults' => 'The maximum number of results to return per page.
', 'ListContentsRequest$maxResults' => 'The maximum number of results to return per page.
', 'ListKnowledgeBasesRequest$maxResults' => 'The maximum number of results to return per page.
', 'QueryAssistantRequest$maxResults' => 'The maximum number of results to return per page.
', 'SearchContentRequest$maxResults' => 'The maximum number of results to return per page.
', 'SearchSessionsRequest$maxResults' => 'The maximum number of results to return per page.
', ], ], 'Name' => [ 'base' => NULL, 'refs' => [ 'AssistantData$name' => 'The name.
', 'AssistantSummary$name' => 'The name of the assistant.
', 'ContentData$name' => 'The name of the content.
', 'ContentSummary$name' => 'The name of the content.
', 'CreateAssistantRequest$name' => 'The name of the assistant.
', 'CreateContentRequest$name' => 'The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the SearchContent API.
', 'CreateKnowledgeBaseRequest$name' => 'The name of the knowledge base.
', 'CreateSessionRequest$name' => 'The name of the session.
', 'KnowledgeBaseData$name' => 'The name of the knowledge base.
', 'KnowledgeBaseSummary$name' => 'The name of the knowledge base.
', 'SessionData$name' => 'The name of the session.
', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListAssistantAssociationsRequest$nextToken' => 'The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
', 'ListAssistantAssociationsResponse$nextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListAssistantsRequest$nextToken' => 'The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
', 'ListAssistantsResponse$nextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ListContentsRequest$nextToken' => 'The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
', 'ListContentsResponse$nextToken' => 'If there are additional results, this is the token for the next set of results.
', 'QueryAssistantRequest$nextToken' => 'The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
', 'QueryAssistantResponse$nextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchContentRequest$nextToken' => 'The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
', 'SearchContentResponse$nextToken' => 'If there are additional results, this is the token for the next set of results.
', 'SearchSessionsRequest$nextToken' => 'The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
', 'SearchSessionsResponse$nextToken' => 'If there are additional results, this is the token for the next set of results.
', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'ContentData$revisionId' => 'The identifier of the content revision.
', 'ContentMetadata$key' => NULL, 'ContentMetadata$value' => NULL, 'ContentSummary$revisionId' => 'The identifier of the revision of the content.
', 'CreateContentRequest$clientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'CreateKnowledgeBaseRequest$clientToken' => 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
', 'Filter$value' => 'The desired field value on which to filter.
', 'Headers$key' => NULL, 'Headers$value' => NULL, 'ListKnowledgeBasesRequest$nextToken' => 'The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
', 'ListKnowledgeBasesResponse$nextToken' => 'If there are additional results, this is the token for the next set of results.
', 'ObjectFieldsList$member' => NULL, 'ServerSideEncryptionConfiguration$kmsKeyId' => 'The KMS key. For information about valid ID values, see Key identifiers (KeyId).
', 'UpdateContentRequest$revisionId' => 'The revisionId of the content resource to update, taken from an earlier call to GetContent, GetContentSummary, SearchContent, or ListContents. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a PreconditionFailedException.
An error occurred when creating a recommendation.
', 'refs' => [ 'NotifyRecommendationsReceivedErrorList$member' => NULL, ], ], 'NotifyRecommendationsReceivedErrorList' => [ 'base' => NULL, 'refs' => [ 'NotifyRecommendationsReceivedResponse$errors' => 'The identifiers of recommendations that are causing errors.
', ], ], 'NotifyRecommendationsReceivedErrorMessage' => [ 'base' => NULL, 'refs' => [ 'NotifyRecommendationsReceivedError$message' => 'A recommendation is causing an error.
', ], ], 'NotifyRecommendationsReceivedRequest' => [ 'base' => NULL, 'refs' => [], ], 'NotifyRecommendationsReceivedResponse' => [ 'base' => NULL, 'refs' => [], ], 'ObjectFieldsList' => [ 'base' => NULL, 'refs' => [ 'AppIntegrationsConfiguration$objectFields' => 'The fields from the source that are made available to your agents in Wisdom. Optional if ObjectConfiguration is included in the provided DataIntegration.
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.
For Zendesk, you must include at least id, title, updated_at, and draft.
Make sure to include additional fields. These fields are indexed and used to source recommendations.
', ], ], 'PreconditionFailedException' => [ 'base' => 'The provided revisionId does not match, indicating the content has been modified since it was last read.
Data associated with the QUERY RecommendationTriggerType.
', 'refs' => [ 'RecommendationTriggerData$query' => 'Data associated with the QUERY RecommendationTriggerType.
', ], ], 'QueryResultsList' => [ 'base' => NULL, 'refs' => [ 'QueryAssistantResponse$results' => 'The results of the query.
', ], ], 'QueryText' => [ 'base' => NULL, 'refs' => [ 'QueryAssistantRequest$queryText' => 'The text to search for.
', 'QueryRecommendationTriggerData$text' => 'The text associated with the recommendation trigger.
', ], ], 'RecommendationData' => [ 'base' => 'Information about the recommendation.
', 'refs' => [ 'RecommendationList$member' => NULL, ], ], 'RecommendationIdList' => [ 'base' => NULL, 'refs' => [ 'NotifyRecommendationsReceivedRequest$recommendationIds' => 'The identifiers of the recommendations.
', 'NotifyRecommendationsReceivedResponse$recommendationIds' => 'The identifiers of the recommendations.
', 'RecommendationTrigger$recommendationIds' => 'The identifiers of the recommendations.
', ], ], 'RecommendationList' => [ 'base' => NULL, 'refs' => [ 'GetRecommendationsResponse$recommendations' => 'The recommendations.
', ], ], 'RecommendationSourceType' => [ 'base' => NULL, 'refs' => [ 'RecommendationTrigger$source' => 'The source of the recommendation trigger.
ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.
RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.
A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.
A union type containing information related to the trigger.
', 'refs' => [ 'RecommendationTrigger$data' => 'A union type containing information related to the trigger.
', ], ], 'RecommendationTriggerList' => [ 'base' => NULL, 'refs' => [ 'GetRecommendationsResponse$triggers' => 'The triggers corresponding to recommendations.
', ], ], 'RecommendationTriggerType' => [ 'base' => NULL, 'refs' => [ 'RecommendationTrigger$type' => 'The type of recommendation trigger.
', ], ], 'RecommendationType' => [ 'base' => NULL, 'refs' => [ 'RecommendationData$type' => 'The type of recommendation.
', ], ], 'RelevanceLevel' => [ 'base' => NULL, 'refs' => [ 'RecommendationData$relevanceLevel' => 'The relevance level of the recommendation.
', ], ], 'RelevanceScore' => [ 'base' => NULL, 'refs' => [ 'RecommendationData$relevanceScore' => 'The relevance score of the recommendation.
', 'ResultData$relevanceScore' => 'The relevance score of the results.
', ], ], 'RemoveKnowledgeBaseTemplateUriRequest' => [ 'base' => NULL, 'refs' => [], ], 'RemoveKnowledgeBaseTemplateUriResponse' => [ 'base' => NULL, 'refs' => [], ], 'RenderingConfiguration' => [ 'base' => 'Information about how to render the content.
', 'refs' => [ 'CreateKnowledgeBaseRequest$renderingConfiguration' => 'Information about how to render the content.
', 'KnowledgeBaseData$renderingConfiguration' => 'Information about how to render the content.
', 'KnowledgeBaseSummary$renderingConfiguration' => 'Information about how to render the content.
', ], ], 'ResourceNotFoundException' => [ 'base' => 'The specified resource does not exist.
', 'refs' => [], ], 'ResultData' => [ 'base' => 'Information about the result.
', 'refs' => [ 'QueryResultsList$member' => NULL, ], ], 'SearchContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'SearchExpression' => [ 'base' => 'The search expression.
', 'refs' => [ 'SearchContentRequest$searchExpression' => 'The search expression to filter results.
', 'SearchSessionsRequest$searchExpression' => 'The search expression to filter results.
', ], ], 'SearchSessionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'SearchSessionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'SensitiveString' => [ 'base' => NULL, 'refs' => [ 'DocumentText$text' => 'Text in the document.
', ], ], 'ServerSideEncryptionConfiguration' => [ 'base' => 'The KMS key used for encryption.
', 'refs' => [ 'AssistantData$serverSideEncryptionConfiguration' => 'The KMS key used for encryption.
', 'AssistantSummary$serverSideEncryptionConfiguration' => 'The KMS key used for encryption.
', 'CreateAssistantRequest$serverSideEncryptionConfiguration' => 'The KMS key used for encryption.
', 'CreateKnowledgeBaseRequest$serverSideEncryptionConfiguration' => 'The KMS key used for encryption.
', 'KnowledgeBaseData$serverSideEncryptionConfiguration' => 'The KMS key used for encryption.
', 'KnowledgeBaseSummary$serverSideEncryptionConfiguration' => 'The KMS key used for encryption.
', ], ], 'ServiceQuotaExceededException' => [ 'base' => 'You\'ve exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
', 'refs' => [], ], 'SessionData' => [ 'base' => 'Information about the session.
', 'refs' => [ 'CreateSessionResponse$session' => 'The session.
', 'GetSessionResponse$session' => 'The session.
', ], ], 'SessionIntegrationConfiguration' => [ 'base' => 'The configuration information for the session integration.
', 'refs' => [ 'SessionData$integrationConfiguration' => 'The configuration information for the session integration.
', ], ], 'SessionSummaries' => [ 'base' => NULL, 'refs' => [ 'SearchSessionsResponse$sessionSummaries' => 'Summary information about the sessions.
', ], ], 'SessionSummary' => [ 'base' => 'Summary information about the session.
', 'refs' => [ 'SessionSummaries$member' => NULL, ], ], 'SourceConfiguration' => [ 'base' => 'Configuration information about the external data source.
', 'refs' => [ 'CreateKnowledgeBaseRequest$sourceConfiguration' => 'The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.
', 'KnowledgeBaseData$sourceConfiguration' => 'Source configuration information about the knowledge base.
', 'KnowledgeBaseSummary$sourceConfiguration' => 'Configuration information about the external data source.
', ], ], 'StartContentUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartContentUploadResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'ConflictException$message' => NULL, 'NotifyRecommendationsReceivedError$recommendationId' => 'The identifier of the recommendation that is in error.
', 'PreconditionFailedException$message' => NULL, 'RecommendationData$recommendationId' => 'The identifier of the recommendation.
', 'RecommendationIdList$member' => NULL, 'ResourceNotFoundException$message' => NULL, 'ResourceNotFoundException$resourceName' => 'The specified resource name.
', 'ServiceQuotaExceededException$message' => NULL, 'TooManyTagsException$message' => NULL, 'TooManyTagsException$resourceName' => 'The specified resource name.
', 'ValidationException$message' => NULL, ], ], 'SyntheticTimestamp_epoch_seconds' => [ 'base' => NULL, 'refs' => [ 'ContentData$urlExpiry' => 'The expiration time of the URL as an epoch timestamp.
', 'KnowledgeBaseData$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.
', 'StartContentUploadResponse$urlExpiry' => 'The expiration time of the URL as an epoch timestamp.
', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'Tags$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => 'The tag keys.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tags$value' => NULL, ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'AssistantAssociationData$tags' => 'The tags used to organize, track, or control access for this resource.
', 'AssistantAssociationSummary$tags' => 'The tags used to organize, track, or control access for this resource.
', 'AssistantData$tags' => 'The tags used to organize, track, or control access for this resource.
', 'AssistantSummary$tags' => 'The tags used to organize, track, or control access for this resource.
', 'ContentData$tags' => 'The tags used to organize, track, or control access for this resource.
', 'ContentSummary$tags' => 'The tags used to organize, track, or control access for this resource.
', 'CreateAssistantAssociationRequest$tags' => 'The tags used to organize, track, or control access for this resource.
', 'CreateAssistantRequest$tags' => 'The tags used to organize, track, or control access for this resource.
', 'CreateContentRequest$tags' => 'The tags used to organize, track, or control access for this resource.
', 'CreateKnowledgeBaseRequest$tags' => 'The tags used to organize, track, or control access for this resource.
', 'CreateSessionRequest$tags' => 'The tags used to organize, track, or control access for this resource.
', 'KnowledgeBaseData$tags' => 'The tags used to organize, track, or control access for this resource.
', 'KnowledgeBaseSummary$tags' => 'The tags used to organize, track, or control access for this resource.
', 'ListTagsForResourceResponse$tags' => 'The tags used to organize, track, or control access for this resource.
', 'SessionData$tags' => 'The tags used to organize, track, or control access for this resource.
', 'TagResourceRequest$tags' => 'The tags used to organize, track, or control access for this resource.
', ], ], 'TooManyTagsException' => [ 'base' => 'Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.
', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateKnowledgeBaseTemplateUriRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateKnowledgeBaseTemplateUriResponse' => [ 'base' => NULL, 'refs' => [], ], 'UploadId' => [ 'base' => NULL, 'refs' => [ 'CreateContentRequest$uploadId' => 'A pointer to the uploaded asset. This value is returned by StartContentUpload.
', 'StartContentUploadResponse$uploadId' => 'The identifier of the upload.
', 'UpdateContentRequest$uploadId' => 'A pointer to the uploaded asset. This value is returned by StartContentUpload.
', ], ], 'Uri' => [ 'base' => NULL, 'refs' => [ 'ContentData$linkOutUri' => 'The URI of the content.
', 'CreateContentRequest$overrideLinkOutUri' => 'The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.
', 'RenderingConfiguration$templateUri' => 'A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:
Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted
ServiceNow: number, short_description, sys_mod_count, workflow_state, or active
Zendesk: id, title, updated_at, or draft
The variable is replaced with the actual value for a piece of content when calling GetContent.
', 'UpdateContentRequest$overrideLinkOutUri' => 'The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing overrideLinkOurUri, exclude this argument and set removeOverrideLinkOutUri to true.
The template URI to update.
', ], ], 'Url' => [ 'base' => NULL, 'refs' => [ 'ContentData$url' => 'The URL of the content.
', 'StartContentUploadResponse$url' => 'The URL of the upload.
', ], ], 'Uuid' => [ 'base' => NULL, 'refs' => [ 'AssistantAssociationData$assistantAssociationId' => 'The identifier of the assistant association.
', 'AssistantAssociationData$assistantId' => 'The identifier of the Wisdom assistant.
', 'AssistantAssociationInputData$knowledgeBaseId' => 'The identifier of the knowledge base.
', 'AssistantAssociationSummary$assistantAssociationId' => 'The identifier of the assistant association.
', 'AssistantAssociationSummary$assistantId' => 'The identifier of the Wisdom assistant.
', 'AssistantData$assistantId' => 'The identifier of the Wisdom assistant.
', 'AssistantSummary$assistantId' => 'The identifier of the Wisdom assistant.
', 'ContentData$contentId' => 'The identifier of the content.
', 'ContentData$knowledgeBaseId' => 'The identifier of the knowledge base.
', 'ContentReference$contentId' => 'The identifier of the content.
', 'ContentReference$knowledgeBaseId' => 'The identifier of the knowledge base.
', 'ContentSummary$contentId' => 'The identifier of the content.
', 'ContentSummary$knowledgeBaseId' => 'The identifier of the knowledge base.
', 'KnowledgeBaseAssociationData$knowledgeBaseId' => 'The identifier of the knowledge base.
', 'KnowledgeBaseData$knowledgeBaseId' => 'The identifier of the knowledge base.
', 'KnowledgeBaseSummary$knowledgeBaseId' => 'The identifier of the knowledge base.
', 'RecommendationTrigger$id' => 'The identifier of the recommendation trigger.
', 'ResultData$resultId' => 'The identifier of the result data.
', 'SessionData$sessionId' => 'The identifier of the session.
', 'SessionSummary$assistantId' => 'The identifier of the Wisdom assistant.
', 'SessionSummary$sessionId' => 'The identifier of the session.
', ], ], 'UuidOrArn' => [ 'base' => NULL, 'refs' => [ 'CreateAssistantAssociationRequest$assistantId' => 'The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'CreateContentRequest$knowledgeBaseId' => 'The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'CreateSessionRequest$assistantId' => 'The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'DeleteAssistantAssociationRequest$assistantAssociationId' => 'The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'DeleteAssistantAssociationRequest$assistantId' => 'The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'DeleteAssistantRequest$assistantId' => 'The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'DeleteContentRequest$contentId' => 'The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'DeleteContentRequest$knowledgeBaseId' => 'The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'DeleteKnowledgeBaseRequest$knowledgeBaseId' => 'The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'GetAssistantAssociationRequest$assistantAssociationId' => 'The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'GetAssistantAssociationRequest$assistantId' => 'The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'GetAssistantRequest$assistantId' => 'The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'GetContentRequest$contentId' => 'The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'GetContentRequest$knowledgeBaseId' => 'The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'GetContentSummaryRequest$contentId' => 'The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'GetContentSummaryRequest$knowledgeBaseId' => 'The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'GetKnowledgeBaseRequest$knowledgeBaseId' => 'The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'GetRecommendationsRequest$assistantId' => 'The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'GetRecommendationsRequest$sessionId' => 'The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'GetSessionRequest$assistantId' => 'The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'GetSessionRequest$sessionId' => 'The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'ListAssistantAssociationsRequest$assistantId' => 'The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'ListContentsRequest$knowledgeBaseId' => 'The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'NotifyRecommendationsReceivedRequest$assistantId' => 'The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'NotifyRecommendationsReceivedRequest$sessionId' => 'The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'QueryAssistantRequest$assistantId' => 'The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'RemoveKnowledgeBaseTemplateUriRequest$knowledgeBaseId' => 'The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'SearchContentRequest$knowledgeBaseId' => 'The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'SearchSessionsRequest$assistantId' => 'The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'StartContentUploadRequest$knowledgeBaseId' => 'The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'UpdateContentRequest$contentId' => 'The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
', 'UpdateContentRequest$knowledgeBaseId' => 'The identifier of the knowledge base. Can be either the ID or the ARN
', 'UpdateKnowledgeBaseTemplateUriRequest$knowledgeBaseId' => 'The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
', ], ], 'ValidationException' => [ 'base' => 'The input fails to satisfy the constraints specified by a service.
', 'refs' => [], ], 'WaitTimeSeconds' => [ 'base' => NULL, 'refs' => [ 'GetRecommendationsRequest$waitTimeSeconds' => 'The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.