UNPKG

aws-sdk

Version:
2,138 lines • 98.6 kB
{ "version": "2.0", "metadata": { "apiVersion": "2019-02-03", "endpointPrefix": "kendra", "jsonVersion": "1.1", "protocol": "json", "serviceAbbreviation": "kendra", "serviceFullName": "AWSKendraFrontendService", "serviceId": "kendra", "signatureVersion": "v4", "signingName": "kendra", "targetPrefix": "AWSKendraFrontendService", "uid": "kendra-2019-02-03" }, "operations": { "AssociateEntitiesToExperience": { "input": { "type": "structure", "required": [ "Id", "IndexId", "EntityList" ], "members": { "Id": {}, "IndexId": {}, "EntityList": { "type": "list", "member": { "shape": "S5" } } } }, "output": { "type": "structure", "members": { "FailedEntityList": { "type": "list", "member": { "shape": "Sa" } } } } }, "AssociatePersonasToEntities": { "input": { "type": "structure", "required": [ "Id", "IndexId", "Personas" ], "members": { "Id": {}, "IndexId": {}, "Personas": { "type": "list", "member": { "type": "structure", "required": [ "EntityId", "Persona" ], "members": { "EntityId": {}, "Persona": {} } } } } }, "output": { "type": "structure", "members": { "FailedEntityList": { "shape": "Sh" } } } }, "BatchDeleteDocument": { "input": { "type": "structure", "required": [ "IndexId", "DocumentIdList" ], "members": { "IndexId": {}, "DocumentIdList": { "type": "list", "member": {} }, "DataSourceSyncJobMetricTarget": { "type": "structure", "required": [ "DataSourceId" ], "members": { "DataSourceId": {}, "DataSourceSyncJobId": {} } } } }, "output": { "type": "structure", "members": { "FailedDocuments": { "type": "list", "member": { "type": "structure", "members": { "Id": {}, "ErrorCode": {}, "ErrorMessage": {} } } } } } }, "BatchDeleteFeaturedResultsSet": { "input": { "type": "structure", "required": [ "IndexId", "FeaturedResultsSetIds" ], "members": { "IndexId": {}, "FeaturedResultsSetIds": { "type": "list", "member": {} } } }, "output": { "type": "structure", "required": [ "Errors" ], "members": { "Errors": { "type": "list", "member": { "type": "structure", "required": [ "Id", "ErrorCode", "ErrorMessage" ], "members": { "Id": {}, "ErrorCode": {}, "ErrorMessage": {} } } } } } }, "BatchGetDocumentStatus": { "input": { "type": "structure", "required": [ "IndexId", "DocumentInfoList" ], "members": { "IndexId": {}, "DocumentInfoList": { "type": "list", "member": { "type": "structure", "required": [ "DocumentId" ], "members": { "DocumentId": {}, "Attributes": { "shape": "S11" } } } } } }, "output": { "type": "structure", "members": { "Errors": { "type": "list", "member": { "type": "structure", "members": { "DocumentId": {}, "ErrorCode": {}, "ErrorMessage": {} } } }, "DocumentStatusList": { "type": "list", "member": { "type": "structure", "members": { "DocumentId": {}, "DocumentStatus": {}, "FailureCode": {}, "FailureReason": {} } } } } } }, "BatchPutDocument": { "input": { "type": "structure", "required": [ "IndexId", "Documents" ], "members": { "IndexId": {}, "RoleArn": {}, "Documents": { "type": "list", "member": { "type": "structure", "required": [ "Id" ], "members": { "Id": {}, "Title": {}, "Blob": { "type": "blob" }, "S3Path": { "shape": "S1m" }, "Attributes": { "shape": "S11" }, "AccessControlList": { "shape": "S1p" }, "HierarchicalAccessControlList": { "shape": "S1u" }, "ContentType": {}, "AccessControlConfigurationId": {} } } }, "CustomDocumentEnrichmentConfiguration": { "shape": "S1y" } } }, "output": { "type": "structure", "members": { "FailedDocuments": { "type": "list", "member": { "type": "structure", "members": { "Id": {}, "ErrorCode": {}, "ErrorMessage": {} } } } } } }, "ClearQuerySuggestions": { "input": { "type": "structure", "required": [ "IndexId" ], "members": { "IndexId": {} } } }, "CreateAccessControlConfiguration": { "input": { "type": "structure", "required": [ "IndexId", "Name" ], "members": { "IndexId": {}, "Name": {}, "Description": {}, "AccessControlList": { "shape": "S1p" }, "HierarchicalAccessControlList": { "shape": "S1u" }, "ClientToken": { "idempotencyToken": true } } }, "output": { "type": "structure", "required": [ "Id" ], "members": { "Id": {} } } }, "CreateDataSource": { "input": { "type": "structure", "required": [ "Name", "IndexId", "Type" ], "members": { "Name": {}, "IndexId": {}, "Type": {}, "Configuration": { "shape": "S2j" }, "VpcConfiguration": { "shape": "S2u" }, "Description": {}, "Schedule": {}, "RoleArn": {}, "Tags": { "shape": "S6r" }, "ClientToken": { "idempotencyToken": true }, "LanguageCode": {}, "CustomDocumentEnrichmentConfiguration": { "shape": "S1y" } } }, "output": { "type": "structure", "required": [ "Id" ], "members": { "Id": {} } } }, "CreateExperience": { "input": { "type": "structure", "required": [ "Name", "IndexId" ], "members": { "Name": {}, "IndexId": {}, "RoleArn": {}, "Configuration": { "shape": "S6z" }, "Description": {}, "ClientToken": { "idempotencyToken": true } } }, "output": { "type": "structure", "required": [ "Id" ], "members": { "Id": {} } } }, "CreateFaq": { "input": { "type": "structure", "required": [ "IndexId", "Name", "S3Path", "RoleArn" ], "members": { "IndexId": {}, "Name": {}, "Description": {}, "S3Path": { "shape": "S1m" }, "RoleArn": {}, "Tags": { "shape": "S6r" }, "FileFormat": {}, "ClientToken": { "idempotencyToken": true }, "LanguageCode": {} } }, "output": { "type": "structure", "members": { "Id": {} } } }, "CreateFeaturedResultsSet": { "input": { "type": "structure", "required": [ "IndexId", "FeaturedResultsSetName" ], "members": { "IndexId": {}, "FeaturedResultsSetName": {}, "Description": {}, "ClientToken": {}, "Status": {}, "QueryTexts": { "shape": "S7f" }, "FeaturedDocuments": { "shape": "S7h" }, "Tags": { "shape": "S6r" } } }, "output": { "type": "structure", "members": { "FeaturedResultsSet": { "shape": "S7k" } } } }, "CreateIndex": { "input": { "type": "structure", "required": [ "Name", "RoleArn" ], "members": { "Name": {}, "Edition": {}, "RoleArn": {}, "ServerSideEncryptionConfiguration": { "shape": "S7o" }, "Description": {}, "ClientToken": { "idempotencyToken": true }, "Tags": { "shape": "S6r" }, "UserTokenConfigurations": { "shape": "S7q" }, "UserContextPolicy": {}, "UserGroupResolutionConfiguration": { "shape": "S80" } } }, "output": { "type": "structure", "members": { "Id": {} } } }, "CreateQuerySuggestionsBlockList": { "input": { "type": "structure", "required": [ "IndexId", "Name", "SourceS3Path", "RoleArn" ], "members": { "IndexId": {}, "Name": {}, "Description": {}, "SourceS3Path": { "shape": "S1m" }, "ClientToken": { "idempotencyToken": true }, "RoleArn": {}, "Tags": { "shape": "S6r" } } }, "output": { "type": "structure", "members": { "Id": {} } } }, "CreateThesaurus": { "input": { "type": "structure", "required": [ "IndexId", "Name", "RoleArn", "SourceS3Path" ], "members": { "IndexId": {}, "Name": {}, "Description": {}, "RoleArn": {}, "Tags": { "shape": "S6r" }, "SourceS3Path": { "shape": "S1m" }, "ClientToken": { "idempotencyToken": true } } }, "output": { "type": "structure", "members": { "Id": {} } } }, "DeleteAccessControlConfiguration": { "input": { "type": "structure", "required": [ "IndexId", "Id" ], "members": { "IndexId": {}, "Id": {} } }, "output": { "type": "structure", "members": {} } }, "DeleteDataSource": { "input": { "type": "structure", "required": [ "Id", "IndexId" ], "members": { "Id": {}, "IndexId": {} } } }, "DeleteExperience": { "input": { "type": "structure", "required": [ "Id", "IndexId" ], "members": { "Id": {}, "IndexId": {} } }, "output": { "type": "structure", "members": {} } }, "DeleteFaq": { "input": { "type": "structure", "required": [ "Id", "IndexId" ], "members": { "Id": {}, "IndexId": {} } } }, "DeleteIndex": { "input": { "type": "structure", "required": [ "Id" ], "members": { "Id": {} } } }, "DeletePrincipalMapping": { "input": { "type": "structure", "required": [ "IndexId", "GroupId" ], "members": { "IndexId": {}, "DataSourceId": {}, "GroupId": {}, "OrderingId": { "type": "long" } } } }, "DeleteQuerySuggestionsBlockList": { "input": { "type": "structure", "required": [ "IndexId", "Id" ], "members": { "IndexId": {}, "Id": {} } } }, "DeleteThesaurus": { "input": { "type": "structure", "required": [ "Id", "IndexId" ], "members": { "Id": {}, "IndexId": {} } } }, "DescribeAccessControlConfiguration": { "input": { "type": "structure", "required": [ "IndexId", "Id" ], "members": { "IndexId": {}, "Id": {} } }, "output": { "type": "structure", "required": [ "Name" ], "members": { "Name": {}, "Description": {}, "ErrorMessage": {}, "AccessControlList": { "shape": "S1p" }, "HierarchicalAccessControlList": { "shape": "S1u" } } } }, "DescribeDataSource": { "input": { "type": "structure", "required": [ "Id", "IndexId" ], "members": { "Id": {}, "IndexId": {} } }, "output": { "type": "structure", "members": { "Id": {}, "IndexId": {}, "Name": {}, "Type": {}, "Configuration": { "shape": "S2j" }, "VpcConfiguration": { "shape": "S2u" }, "CreatedAt": { "type": "timestamp" }, "UpdatedAt": { "type": "timestamp" }, "Description": {}, "Status": {}, "Schedule": {}, "RoleArn": {}, "ErrorMessage": {}, "LanguageCode": {}, "CustomDocumentEnrichmentConfiguration": { "shape": "S1y" } } } }, "DescribeExperience": { "input": { "type": "structure", "required": [ "Id", "IndexId" ], "members": { "Id": {}, "IndexId": {} } }, "output": { "type": "structure", "members": { "Id": {}, "IndexId": {}, "Name": {}, "Endpoints": { "shape": "S8u" }, "Configuration": { "shape": "S6z" }, "CreatedAt": { "type": "timestamp" }, "UpdatedAt": { "type": "timestamp" }, "Description": {}, "Status": {}, "RoleArn": {}, "ErrorMessage": {} } } }, "DescribeFaq": { "input": { "type": "structure", "required": [ "Id", "IndexId" ], "members": { "Id": {}, "IndexId": {} } }, "output": { "type": "structure", "members": { "Id": {}, "IndexId": {}, "Name": {}, "Description": {}, "CreatedAt": { "type": "timestamp" }, "UpdatedAt": { "type": "timestamp" }, "S3Path": { "shape": "S1m" }, "Status": {}, "RoleArn": {}, "ErrorMessage": {}, "FileFormat": {}, "LanguageCode": {} } } }, "DescribeFeaturedResultsSet": { "input": { "type": "structure", "required": [ "IndexId", "FeaturedResultsSetId" ], "members": { "IndexId": {}, "FeaturedResultsSetId": {} } }, "output": { "type": "structure", "members": { "FeaturedResultsSetId": {}, "FeaturedResultsSetName": {}, "Description": {}, "Status": {}, "QueryTexts": { "shape": "S7f" }, "FeaturedDocumentsWithMetadata": { "type": "list", "member": { "type": "structure", "members": { "Id": {}, "Title": {}, "URI": {} } } }, "FeaturedDocumentsMissing": { "type": "list", "member": { "type": "structure", "members": { "Id": {} } } }, "LastUpdatedTimestamp": { "type": "long" }, "CreationTimestamp": { "type": "long" } } } }, "DescribeIndex": { "input": { "type": "structure", "required": [ "Id" ], "members": { "Id": {} } }, "output": { "type": "structure", "members": { "Name": {}, "Id": {}, "Edition": {}, "RoleArn": {}, "ServerSideEncryptionConfiguration": { "shape": "S7o" }, "Status": {}, "Description": {}, "CreatedAt": { "type": "timestamp" }, "UpdatedAt": { "type": "timestamp" }, "DocumentMetadataConfigurations": { "shape": "S9b" }, "IndexStatistics": { "type": "structure", "required": [ "FaqStatistics", "TextDocumentStatistics" ], "members": { "FaqStatistics": { "type": "structure", "required": [ "IndexedQuestionAnswersCount" ], "members": { "IndexedQuestionAnswersCount": { "type": "integer" } } }, "TextDocumentStatistics": { "type": "structure", "required": [ "IndexedTextDocumentsCount", "IndexedTextBytes" ], "members": { "IndexedTextDocumentsCount": { "type": "integer" }, "IndexedTextBytes": { "type": "long" } } } } }, "ErrorMessage": {}, "CapacityUnits": { "shape": "S9t" }, "UserTokenConfigurations": { "shape": "S7q" }, "UserContextPolicy": {}, "UserGroupResolutionConfiguration": { "shape": "S80" } } } }, "DescribePrincipalMapping": { "input": { "type": "structure", "required": [ "IndexId", "GroupId" ], "members": { "IndexId": {}, "DataSourceId": {}, "GroupId": {} } }, "output": { "type": "structure", "members": { "IndexId": {}, "DataSourceId": {}, "GroupId": {}, "GroupOrderingIdSummaries": { "type": "list", "member": { "type": "structure", "members": { "Status": {}, "LastUpdatedAt": { "type": "timestamp" }, "ReceivedAt": { "type": "timestamp" }, "OrderingId": { "type": "long" }, "FailureReason": {} } } } } } }, "DescribeQuerySuggestionsBlockList": { "input": { "type": "structure", "required": [ "IndexId", "Id" ], "members": { "IndexId": {}, "Id": {} } }, "output": { "type": "structure", "members": { "IndexId": {}, "Id": {}, "Name": {}, "Description": {}, "Status": {}, "ErrorMessage": {}, "CreatedAt": { "type": "timestamp" }, "UpdatedAt": { "type": "timestamp" }, "SourceS3Path": { "shape": "S1m" }, "ItemCount": { "type": "integer" }, "FileSizeBytes": { "type": "long" }, "RoleArn": {} } } }, "DescribeQuerySuggestionsConfig": { "input": { "type": "structure", "required": [ "IndexId" ], "members": { "IndexId": {} } }, "output": { "type": "structure", "members": { "Mode": {}, "Status": {}, "QueryLogLookBackWindowInDays": { "type": "integer" }, "IncludeQueriesWithoutUserInformation": { "type": "boolean" }, "MinimumNumberOfQueryingUsers": { "type": "integer" }, "MinimumQueryCount": { "type": "integer" }, "LastSuggestionsBuildTime": { "type": "timestamp" }, "LastClearTime": { "type": "timestamp" }, "TotalSuggestionsCount": { "type": "integer" }, "AttributeSuggestionsConfig": { "type": "structure", "members": { "SuggestableConfigList": { "shape": "Sae" }, "AttributeSuggestionsMode": {} } } } } }, "DescribeThesaurus": { "input": { "type": "structure", "required": [ "Id", "IndexId" ], "members": { "Id": {}, "IndexId": {} } }, "output": { "type": "structure", "members": { "Id": {}, "IndexId": {}, "Name": {}, "Description": {}, "Status": {}, "ErrorMessage": {}, "CreatedAt": { "type": "timestamp" }, "UpdatedAt": { "type": "timestamp" }, "RoleArn": {}, "SourceS3Path": { "shape": "S1m" }, "FileSizeBytes": { "type": "long" }, "TermCount": { "type": "long" }, "SynonymRuleCount": { "type": "long" } } } }, "DisassociateEntitiesFromExperience": { "input": { "type": "structure", "required": [ "Id", "IndexId", "EntityList" ], "members": { "Id": {}, "IndexId": {}, "EntityList": { "type": "list", "member": { "shape": "S5" } } } }, "output": { "type": "structure", "members": { "FailedEntityList": { "shape": "Sh" } } } }, "DisassociatePersonasFromEntities": { "input": { "type": "structure", "required": [ "Id", "IndexId", "EntityIds" ], "members": { "Id": {}, "IndexId": {}, "EntityIds": { "type": "list", "member": {} } } }, "output": { "type": "structure", "members": { "FailedEntityList": { "shape": "Sh" } } } }, "GetQuerySuggestions": { "input": { "type": "structure", "required": [ "IndexId", "QueryText" ], "members": { "IndexId": {}, "QueryText": {}, "MaxSuggestionsCount": { "type": "integer" }, "SuggestionTypes": { "type": "list", "member": {} }, "AttributeSuggestionsConfig": { "type": "structure", "members": { "SuggestionAttributes": { "shape": "Sav" }, "AdditionalResponseAttributes": { "shape": "Sav" }, "AttributeFilter": { "shape": "Saw" }, "UserContext": { "shape": "Say" } } } } }, "output": { "type": "structure", "members": { "QuerySuggestionsId": {}, "Suggestions": { "type": "list", "member": { "type": "structure", "members": { "Id": {}, "Value": { "type": "structure", "members": { "Text": { "type": "structure", "members": { "Text": {}, "Highlights": { "type": "list", "member": { "type": "structure", "members": { "BeginOffset": { "type": "integer" }, "EndOffset": { "type": "integer" } } } } } } } }, "SourceDocuments": { "type": "list", "member": { "type": "structure", "members": { "DocumentId": {}, "SuggestionAttributes": { "shape": "Sav" }, "AdditionalAttributes": { "shape": "S11" } } } } } } } } } }, "GetSnapshots": { "input": { "type": "structure", "required": [ "IndexId", "Interval", "MetricType" ], "members": { "IndexId": {}, "Interval": {}, "MetricType": {}, "NextToken": {}, "MaxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "SnapShotTimeFilter": { "shape": "Sbj" }, "SnapshotsDataHeader": { "type": "list", "member": {} }, "SnapshotsData": { "type": "list", "member": { "type": "list", "member": {} } }, "NextToken": {} } } }, "ListAccessControlConfigurations": { "input": { "type": "structure", "required": [ "IndexId" ], "members": { "IndexId": {}, "NextToken": {}, "MaxResults": { "type": "integer" } } }, "output": { "type": "structure", "required": [ "AccessControlConfigurations" ], "members": { "NextToken": {}, "AccessControlConfigurations": { "type": "list", "member": { "type": "structure", "required": [ "Id" ], "members": { "Id": {} } } } } } }, "ListDataSourceSyncJobs": { "input": { "type": "structure", "required": [ "Id", "IndexId" ], "members": { "Id": {}, "IndexId": {}, "NextToken": {}, "MaxResults": { "type": "integer" }, "StartTimeFilter": { "shape": "Sbj" }, "StatusFilter": {} } }, "output": { "type": "structure", "members": { "History": { "type": "list", "member": { "type": "structure", "members": { "ExecutionId": {}, "StartTime": { "type": "timestamp" }, "EndTime": { "type": "timestamp" }, "Status": {}, "ErrorMessage": {}, "ErrorCode": {}, "DataSourceErrorCode": {}, "Metrics": { "type": "structure", "members": { "DocumentsAdded": {}, "DocumentsModified": {}, "DocumentsDeleted": {}, "DocumentsFailed": {}, "DocumentsScanned": {} } } } } }, "NextToken": {} } } }, "ListDataSources": { "input": { "type": "structure", "required": [ "IndexId" ], "members": { "IndexId": {}, "NextToken": {}, "MaxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "SummaryItems": { "type": "list", "member": { "type": "structure", "members": { "Name": {}, "Id": {}, "Type": {}, "CreatedAt": { "type": "timestamp" }, "UpdatedAt": { "type": "timestamp" }, "Status": {}, "LanguageCode": {} } } }, "NextToken": {} } } }, "ListEntityPersonas": { "input": { "type": "structure", "required": [ "Id", "IndexId" ], "members": { "Id": {}, "IndexId": {}, "NextToken": {}, "MaxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "SummaryItems": { "type": "list", "member": { "type": "structure", "members": { "EntityId": {}, "Persona": {}, "CreatedAt": { "type": "timestamp" }, "UpdatedAt": { "type": "timestamp" } } } }, "NextToken": {} } } }, "ListExperienceEntities": { "input": { "type": "structure", "required": [ "Id", "IndexId" ], "members": { "Id": {}, "IndexId": {}, "NextToken": {} } }, "output": { "type": "structure", "members": { "SummaryItems": { "type": "list", "member": { "type": "structure", "members": { "EntityId": {}, "EntityType": {}, "DisplayData": { "type": "structure", "members": { "UserName": { "shape": "Scf" }, "GroupName": { "shape": "Scf" }, "IdentifiedUserName": { "shape": "Scf" }, "FirstName": { "shape": "Scf" }, "LastName": { "shape": "Scf" } } } } } }, "NextToken": {} } } }, "ListExperiences": { "input": { "type": "structure", "required": [ "IndexId" ], "members": { "IndexId": {}, "NextToken": {}, "MaxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "SummaryItems": { "type": "list", "member": { "type": "structure", "members": { "Name": {}, "Id": {}, "CreatedAt": { "type": "timestamp" }, "Status": {}, "Endpoints": { "shape": "S8u" } } } }, "NextToken": {} } } }, "ListFaqs": { "input": { "type": "structure", "required": [ "IndexId" ], "members": { "IndexId": {}, "NextToken": {}, "MaxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "NextToken": {}, "FaqSummaryItems": { "type": "list", "member": { "type": "structure", "members": { "Id": {}, "Name": {}, "Status": {}, "CreatedAt": { "type": "timestamp" }, "UpdatedAt": { "type": "timestamp" }, "FileFormat": {}, "LanguageCode": {} } } } } } }, "ListFeaturedResultsSets": { "input": { "type": "structure", "required": [ "IndexId" ], "members": { "IndexId": {}, "NextToken": {}, "MaxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "FeaturedResultsSetSummaryItems": { "type": "list", "member": { "type": "structure", "members": { "FeaturedResultsSetId": {}, "FeaturedResultsSetName": {}, "Status": {}, "LastUpdatedTimestamp": { "type": "long" }, "CreationTimestamp": { "type": "long" } } } }, "NextToken": {} } } }, "ListGroupsOlderThanOrderingId": { "input": { "type": "structure", "required": [ "IndexId", "OrderingId" ], "members": { "IndexId": {}, "DataSourceId": {}, "OrderingId": { "type": "long" }, "NextToken": {}, "MaxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "GroupsSummaries": { "type": "list", "member": { "type": "structure", "members": { "GroupId": {}, "OrderingId": { "type": "long" } } } }, "NextToken": {} } } }, "ListIndices": { "input": { "type": "structure", "members": { "NextToken": {}, "MaxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "IndexConfigurationSummaryItems": { "type": "list", "member": { "type": "structure", "required": [ "CreatedAt", "UpdatedAt", "Status" ], "members": { "Name": {}, "Id": {}, "Edition": {}, "CreatedAt": { "type": "timestamp" }, "UpdatedAt": { "type": "timestamp" }, "Status": {} } } }, "NextToken": {} } } }, "ListQuerySuggestionsBlockLists": { "input": { "type": "structure", "required": [ "IndexId" ], "members": { "IndexId": {}, "NextToken": {}, "MaxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "BlockListSummaryItems": { "type": "list", "member": { "type": "structure", "members": { "Id": {}, "Name": {}, "Status": {}, "CreatedAt": { "type": "timestamp" }, "UpdatedAt": { "type": "timestamp" }, "ItemCount": { "type": "integer" } } } }, "NextToken": {} } } }, "ListTagsForResource": { "input": { "type": "structure", "required": [ "ResourceARN" ], "members": { "ResourceARN": {} } }, "output": { "type": "structure", "members": { "Tags": { "shape": "S6r" } } } }, "ListThesauri": { "input": { "type": "structure", "required": [ "IndexId" ], "members": { "IndexId": {}, "NextToken": {}, "MaxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "NextToken": {}, "ThesaurusSummaryItems": { "type": "list", "member": { "type": "structure", "members": { "Id": {}, "Name": {}, "Status": {}, "CreatedAt": { "type": "timestamp" }, "UpdatedAt": { "type": "timestamp" } } } } } } }, "PutPrincipalMapping": { "input": { "type": "structure", "required": [ "IndexId", "GroupId", "GroupMembers" ], "members": { "IndexId": {}, "DataSourceId": {}, "GroupId": {}, "GroupMembers": { "type": "structure", "members": { "MemberGroups": { "type": "list", "member": { "type": "structure", "required": [ "GroupId" ], "members": { "GroupId": {}, "DataSourceId": {} } } }, "MemberUsers": { "type": "list", "member": { "type": "structure", "required": [ "UserId" ], "members": { "UserId": {} } } }, "S3PathforGroupMembers": { "shape": "S1m" } } }, "OrderingId": { "type": "long" }, "RoleArn": {} } } }, "Query": { "input": { "type": "structure", "required": [ "IndexId" ], "members": { "IndexId": {}, "QueryText": {}, "AttributeFilter": { "shape": "Saw" }, "Facets": { "shape": "Sdq" }, "RequestedDocumentAttributes": { "shape": "Sav" }, "QueryResultTypeFilter": {}, "DocumentRelevanceOverrideConfigurations": { "shape": "Sdu" }, "PageNumber": { "type": "integer" }, "PageSize": { "type": "integer" }, "SortingConfiguration": { "shape": "Sdw" }, "SortingConfigurations": { "shape": "Sdy" }, "UserContext": { "shape": "Say" }, "VisitorId": {}, "SpellCorrectionConfiguration": { "type": "structure", "required": [ "IncludeQuerySpellCheckSuggestions" ], "members": { "IncludeQuerySpellCheckSuggestions": { "type": "boolean" } } }, "CollapseConfiguration": { "type": "structure", "required": [ "DocumentAttributeKey" ], "members": { "DocumentAttributeKey": {}, "SortingConfigurations": { "shape": "Sdy" }, "MissingAttributeKeyStrategy": {}, "Expand": { "type": "boolean" }, "ExpandConfiguration": { "type": "structure", "members": { "MaxResultItemsToExpand": { "type": "integer" }, "MaxExpandedResultsPerItem": { "type": "integer" } } } } } } }, "output": { "type": "structure", "members": { "QueryId": {}, "ResultItems": { "type": "list", "member": { "type": "structure", "members": { "Id": {}, "Type": {}, "Format": {}, "AdditionalAttributes": { "shape": "Se9" }, "DocumentId": {}, "DocumentTitle": { "shape": "Sed" }, "DocumentExcerpt": { "shape": "Sed" }, "DocumentURI": {}, "DocumentAttributes": { "shape": "S11" }, "ScoreAttributes": { "shape": "Seh" }, "FeedbackToken": {}, "TableExcerpt": { "type": "structure", "members": { "Rows": { "type": "list", "member": { "type": "structure", "members": { "Cells": { "type": "list", "member": { "type": "structure", "members": { "Value": {}, "TopAnswer": { "type": "boolean" }, "Highlighted": { "type": "boolean" }, "Header": { "type": "boolean" } } } } } } }, "TotalNumberOfRows": { "type": "integer" } } }, "CollapsedResultDetail": { "type": "structure", "required": [ "DocumentAttribute" ], "members": { "DocumentAttribute": { "shape": "S12" }, "ExpandedResults": { "type": "list", "member": { "type": "structure", "members": { "Id": {}, "DocumentId": {}, "DocumentTitle": { "shape": "Sed" }, "DocumentExcerpt": { "shape": "Sed" }, "DocumentURI": {}, "DocumentAttributes": { "shape": "S11" } } } } } } } } }, "FacetResults": { "shape": "Ses" }, "TotalNumberOfResults": { "type": "integer" }, "Warnings": { "type": "list", "member": { "type": "structure", "members": { "Message": {}, "Code": {} } } }, "SpellCorrectedQueries": { "type": "list", "member": { "type": "structure", "members": { "SuggestedQueryText": {}, "Corrections": { "type": "list", "member": { "type": "structure", "members": { "BeginOffset": { "type": "integer" }, "EndOffset": { "type": "integer" }, "Term": {}, "CorrectedTerm": {} } } } } } }, "FeaturedResultsItems": { "type": "list", "member": { "type": "structure", "members": { "Id": {}, "Type": {}, "AdditionalAttributes": { "shape": "Se9" }, "DocumentId": {}, "DocumentTitle": { "shape": "Sed" }, "DocumentExcerpt": { "shape": "Sed" }, "DocumentURI": {}, "DocumentAttributes": { "shape": "S11" }, "FeedbackToken": {} } } } } } }, "Retrieve": { "input": { "type": "structure", "required": [ "IndexId", "QueryText" ], "members": { "IndexId": {}, "QueryText": {}, "AttributeFilter": { "shape": "Saw" }, "RequestedDocumentAttribute