@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api AWSKendraFrontendService
@version 2019-02-03
@auth AWS SigV4
@endpoints 66
@hint download_for_search
@toc root(66)

@endpoint POST /
@required {Id: str, IndexId: str, EntityList: [EntityConfiguration]}
@returns(200) {FailedEntityList: [FailedEntity]?}

@endpoint POST /
@required {Id: str, IndexId: str, Personas: [EntityPersonaConfiguration]}
@returns(200) {FailedEntityList: [FailedEntity]?}

@endpoint POST /
@required {IndexId: str, DocumentIdList: [str]}
@optional {DataSourceSyncJobMetricTarget: DataSourceSyncJobMetricTarget}
@returns(200) {FailedDocuments: [BatchDeleteDocumentResponseFailedDocument]?}

@endpoint POST /
@required {IndexId: str, FeaturedResultsSetIds: [str]}
@returns(200) {Errors: [BatchDeleteFeaturedResultsSetError]}

@endpoint POST /
@required {IndexId: str, DocumentInfoList: [DocumentInfo]}
@returns(200) {Errors: [BatchGetDocumentStatusResponseError]?, DocumentStatusList: [Status]?}

@endpoint POST /
@required {IndexId: str, Documents: [Document]}
@optional {RoleArn: str, CustomDocumentEnrichmentConfiguration: CustomDocumentEnrichmentConfiguration}
@returns(200) {FailedDocuments: [BatchPutDocumentResponseFailedDocument]?}

@endpoint POST /
@required {IndexId: str}

@endpoint POST /
@required {IndexId: str, Name: str}
@optional {Description: str, AccessControlList: [Principal], HierarchicalAccessControlList: [HierarchicalPrincipal], ClientToken: str}
@returns(200) {Id: str}

@endpoint POST /
@required {Name: str, IndexId: str, Type: str}
@optional {Configuration: DataSourceConfiguration, VpcConfiguration: DataSourceVpcConfiguration, Description: str, Schedule: str, RoleArn: str, Tags: [Tag], ClientToken: str, LanguageCode: str, CustomDocumentEnrichmentConfiguration: CustomDocumentEnrichmentConfiguration}
@returns(200) {Id: str}

@endpoint POST /
@required {Name: str, IndexId: str}
@optional {RoleArn: str, Configuration: ExperienceConfiguration, Description: str, ClientToken: str}
@returns(200) {Id: str}

@endpoint POST /
@required {IndexId: str, Name: str, S3Path: S3Path, RoleArn: str}
@optional {Description: str, Tags: [Tag], FileFormat: str, ClientToken: str, LanguageCode: str}
@returns(200) {Id: str?}

@endpoint POST /
@required {IndexId: str, FeaturedResultsSetName: str}
@optional {Description: str, ClientToken: str, Status: str, QueryTexts: [str], FeaturedDocuments: [FeaturedDocument], Tags: [Tag]}
@returns(200) {FeaturedResultsSet: FeaturedResultsSet?{FeaturedResultsSetId: str?, FeaturedResultsSetName: str?, Description: str?, Status: str?, QueryTexts: [str]?, FeaturedDocuments: [FeaturedDocument]?, LastUpdatedTimestamp: int(i64)?, CreationTimestamp: int(i64)?}}

@endpoint POST /
@required {Name: str, RoleArn: str}
@optional {Edition: str, ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration, Description: str, ClientToken: str, Tags: [Tag], UserTokenConfigurations: [UserTokenConfiguration], UserContextPolicy: str, UserGroupResolutionConfiguration: UserGroupResolutionConfiguration}
@returns(200) {Id: str?}

@endpoint POST /
@required {IndexId: str, Name: str, SourceS3Path: S3Path, RoleArn: str}
@optional {Description: str, ClientToken: str, Tags: [Tag]}
@returns(200) {Id: str?}

@endpoint POST /
@required {IndexId: str, Name: str, RoleArn: str, SourceS3Path: S3Path}
@optional {Description: str, Tags: [Tag], ClientToken: str}
@returns(200) {Id: str?}

@endpoint POST /
@required {IndexId: str, Id: str}

@endpoint POST /
@required {Id: str, IndexId: str}

@endpoint POST /
@required {Id: str, IndexId: str}

@endpoint POST /
@required {Id: str, IndexId: str}

@endpoint POST /
@required {Id: str}

@endpoint POST /
@required {IndexId: str, GroupId: str}
@optional {DataSourceId: str, OrderingId: int(i64)}

@endpoint POST /
@required {IndexId: str, Id: str}

@endpoint POST /
@required {Id: str, IndexId: str}

@endpoint POST /
@required {IndexId: str, Id: str}
@returns(200) {Name: str, Description: str?, ErrorMessage: str?, AccessControlList: [Principal]?, HierarchicalAccessControlList: [HierarchicalPrincipal]?}

@endpoint POST /
@required {Id: str, IndexId: str}
@returns(200) {Id: str?, IndexId: str?, Name: str?, Type: str?, Configuration: DataSourceConfiguration?{S3Configuration: S3DataSourceConfiguration?{BucketName: str, InclusionPrefixes: [str]?, InclusionPatterns: [str]?, ExclusionPatterns: [str]?, DocumentsMetadataConfiguration: DocumentsMetadataConfiguration?{S3Prefix: str?}, AccessControlListConfiguration: AccessControlListConfiguration?{KeyPath: str?}}, SharePointConfiguration: SharePointConfiguration?{SharePointVersion: str, Urls: [str], SecretArn: str, CrawlAttachments: bool?, UseChangeLog: bool?, InclusionPatterns: [str]?, ExclusionPatterns: [str]?, VpcConfiguration: DataSourceVpcConfiguration?{SubnetIds: [str], SecurityGroupIds: [str]}, FieldMappings: [DataSourceToIndexFieldMapping]?, DocumentTitleFieldName: str?, DisableLocalGroups: bool?, SslCertificateS3Path: S3Path?{Bucket: str, Key: str}, AuthenticationType: str?, ProxyConfiguration: ProxyConfiguration?{Host: str, Port: int, Credentials: str?}}, DatabaseConfiguration: DatabaseConfiguration?{DatabaseEngineType: str, ConnectionConfiguration: ConnectionConfiguration{DatabaseHost: str, DatabasePort: int, DatabaseName: str, TableName: str, SecretArn: str}, VpcConfiguration: DataSourceVpcConfiguration?{SubnetIds: [str], SecurityGroupIds: [str]}, ColumnConfiguration: ColumnConfiguration{DocumentIdColumnName: str, DocumentDataColumnName: str, DocumentTitleColumnName: str?, FieldMappings: [DataSourceToIndexFieldMapping]?, ChangeDetectingColumns: [str]}, AclConfiguration: AclConfiguration?{AllowedGroupsColumnName: str}, SqlConfiguration: SqlConfiguration?{QueryIdentifiersEnclosingOption: str?}}, SalesforceConfiguration: SalesforceConfiguration?{ServerUrl: str, SecretArn: str, StandardObjectConfigurations: [SalesforceStandardObjectConfiguration]?, KnowledgeArticleConfiguration: SalesforceKnowledgeArticleConfiguration?{IncludedStates: [str], StandardKnowledgeArticleTypeConfiguration: SalesforceStandardKnowledgeArticleTypeConfiguration?, CustomKnowledgeArticleTypeConfigurations: [SalesforceCustomKnowledgeArticleTypeConfiguration]?}, ChatterFeedConfiguration: SalesforceChatterFeedConfiguration?{DocumentDataFieldName: str, DocumentTitleFieldName: str?, FieldMappings: [DataSourceToIndexFieldMapping]?, IncludeFilterTypes: [str]?}, CrawlAttachments: bool?, StandardObjectAttachmentConfiguration: SalesforceStandardObjectAttachmentConfiguration?{DocumentTitleFieldName: str?, FieldMappings: [DataSourceToIndexFieldMapping]?}, IncludeAttachmentFilePatterns: [str]?, ExcludeAttachmentFilePatterns: [str]?}, OneDriveConfiguration: OneDriveConfiguration?{TenantDomain: str, SecretArn: str, OneDriveUsers: OneDriveUsers{OneDriveUserList: [str]?, OneDriveUserS3Path: S3Path?}, InclusionPatterns: [str]?, ExclusionPatterns: [str]?, FieldMappings: [DataSourceToIndexFieldMapping]?, DisableLocalGroups: bool?}, ServiceNowConfiguration: ServiceNowConfiguration?{HostUrl: str, SecretArn: str, ServiceNowBuildVersion: str, KnowledgeArticleConfiguration: ServiceNowKnowledgeArticleConfiguration?{CrawlAttachments: bool?, IncludeAttachmentFilePatterns: [str]?, ExcludeAttachmentFilePatterns: [str]?, DocumentDataFieldName: str, DocumentTitleFieldName: str?, FieldMappings: [DataSourceToIndexFieldMapping]?, FilterQuery: str?}, ServiceCatalogConfiguration: ServiceNowServiceCatalogConfiguration?{CrawlAttachments: bool?, IncludeAttachmentFilePatterns: [str]?, ExcludeAttachmentFilePatterns: [str]?, DocumentDataFieldName: str, DocumentTitleFieldName: str?, FieldMappings: [DataSourceToIndexFieldMapping]?}, AuthenticationType: str?}, ConfluenceConfiguration: ConfluenceConfiguration?{ServerUrl: str, SecretArn: str, Version: str, SpaceConfiguration: ConfluenceSpaceConfiguration?{CrawlPersonalSpaces: bool?, CrawlArchivedSpaces: bool?, IncludeSpaces: [str]?, ExcludeSpaces: [str]?, SpaceFieldMappings: [ConfluenceSpaceToIndexFieldMapping]?}, PageConfiguration: ConfluencePageConfiguration?{PageFieldMappings: [ConfluencePageToIndexFieldMapping]?}, BlogConfiguration: ConfluenceBlogConfiguration?{BlogFieldMappings: [ConfluenceBlogToIndexFieldMapping]?}, AttachmentConfiguration: ConfluenceAttachmentConfiguration?{CrawlAttachments: bool?, AttachmentFieldMappings: [ConfluenceAttachmentToIndexFieldMapping]?}, VpcConfiguration: DataSourceVpcConfiguration?{SubnetIds: [str], SecurityGroupIds: [str]}, InclusionPatterns: [str]?, ExclusionPatterns: [str]?, ProxyConfiguration: ProxyConfiguration?{Host: str, Port: int, Credentials: str?}, AuthenticationType: str?}, GoogleDriveConfiguration: GoogleDriveConfiguration?{SecretArn: str, InclusionPatterns: [str]?, ExclusionPatterns: [str]?, FieldMappings: [DataSourceToIndexFieldMapping]?, ExcludeMimeTypes: [str]?, ExcludeUserAccounts: [str]?, ExcludeSharedDrives: [str]?}, WebCrawlerConfiguration: WebCrawlerConfiguration?{Urls: Urls{SeedUrlConfiguration: SeedUrlConfiguration?, SiteMapsConfiguration: SiteMapsConfiguration?}, CrawlDepth: int?, MaxLinksPerPage: int?, MaxContentSizePerPageInMegaBytes: num(f32)?, MaxUrlsPerMinuteCrawlRate: int?, UrlInclusionPatterns: [str]?, UrlExclusionPatterns: [str]?, ProxyConfiguration: ProxyConfiguration?{Host: str, Port: int, Credentials: str?}, AuthenticationConfiguration: AuthenticationConfiguration?{BasicAuthentication: [BasicAuthenticationConfiguration]?}}, WorkDocsConfiguration: WorkDocsConfiguration?{OrganizationId: str, CrawlComments: bool?, UseChangeLog: bool?, InclusionPatterns: [str]?, ExclusionPatterns: [str]?, FieldMappings: [DataSourceToIndexFieldMapping]?}, FsxConfiguration: FsxConfiguration?{FileSystemId: str, FileSystemType: str, VpcConfiguration: DataSourceVpcConfiguration{SubnetIds: [str], SecurityGroupIds: [str]}, SecretArn: str?, InclusionPatterns: [str]?, ExclusionPatterns: [str]?, FieldMappings: [DataSourceToIndexFieldMapping]?}, SlackConfiguration: SlackConfiguration?{TeamId: str, SecretArn: str, VpcConfiguration: DataSourceVpcConfiguration?{SubnetIds: [str], SecurityGroupIds: [str]}, SlackEntityList: [str], UseChangeLog: bool?, CrawlBotMessage: bool?, ExcludeArchived: bool?, SinceCrawlDate: str, LookBackPeriod: int?, PrivateChannelFilter: [str]?, PublicChannelFilter: [str]?, InclusionPatterns: [str]?, ExclusionPatterns: [str]?, FieldMappings: [DataSourceToIndexFieldMapping]?}, BoxConfiguration: BoxConfiguration?{EnterpriseId: str, SecretArn: str, UseChangeLog: bool?, CrawlComments: bool?, CrawlTasks: bool?, CrawlWebLinks: bool?, FileFieldMappings: [DataSourceToIndexFieldMapping]?, TaskFieldMappings: [DataSourceToIndexFieldMapping]?, CommentFieldMappings: [DataSourceToIndexFieldMapping]?, WebLinkFieldMappings: [DataSourceToIndexFieldMapping]?, InclusionPatterns: [str]?, ExclusionPatterns: [str]?, VpcConfiguration: DataSourceVpcConfiguration?{SubnetIds: [str], SecurityGroupIds: [str]}}, QuipConfiguration: QuipConfiguration?{Domain: str, SecretArn: str, CrawlFileComments: bool?, CrawlChatRooms: bool?, CrawlAttachments: bool?, FolderIds: [str]?, ThreadFieldMappings: [DataSourceToIndexFieldMapping]?, MessageFieldMappings: [DataSourceToIndexFieldMapping]?, AttachmentFieldMappings: [DataSourceToIndexFieldMapping]?, InclusionPatterns: [str]?, ExclusionPatterns: [str]?, VpcConfiguration: DataSourceVpcConfiguration?{SubnetIds: [str], SecurityGroupIds: [str]}}, JiraConfiguration: JiraConfiguration?{JiraAccountUrl: str, SecretArn: str, UseChangeLog: bool?, Project: [str]?, IssueType: [str]?, Status: [str]?, IssueSubEntityFilter: [str]?, AttachmentFieldMappings: [DataSourceToIndexFieldMapping]?, CommentFieldMappings: [DataSourceToIndexFieldMapping]?, IssueFieldMappings: [DataSourceToIndexFieldMapping]?, ProjectFieldMappings: [DataSourceToIndexFieldMapping]?, WorkLogFieldMappings: [DataSourceToIndexFieldMapping]?, InclusionPatterns: [str]?, ExclusionPatterns: [str]?, VpcConfiguration: DataSourceVpcConfiguration?{SubnetIds: [str], SecurityGroupIds: [str]}}, GitHubConfiguration: GitHubConfiguration?{SaaSConfiguration: SaaSConfiguration?{OrganizationName: str, HostUrl: str}, OnPremiseConfiguration: OnPremiseConfiguration?{HostUrl: str, OrganizationName: str, SslCertificateS3Path: S3Path}, Type: str?, SecretArn: str, UseChangeLog: bool?, GitHubDocumentCrawlProperties: GitHubDocumentCrawlProperties?{CrawlRepositoryDocuments: bool?, CrawlIssue: bool?, CrawlIssueComment: bool?, CrawlIssueCommentAttachment: bool?, CrawlPullRequest: bool?, CrawlPullRequestComment: bool?, CrawlPullRequestCommentAttachment: bool?}, RepositoryFilter: [str]?, InclusionFolderNamePatterns: [str]?, InclusionFileTypePatterns: [str]?, InclusionFileNamePatterns: [str]?, ExclusionFolderNamePatterns: [str]?, ExclusionFileTypePatterns: [str]?, ExclusionFileNamePatterns: [str]?, VpcConfiguration: DataSourceVpcConfiguration?{SubnetIds: [str], SecurityGroupIds: [str]}, GitHubRepositoryConfigurationFieldMappings: [DataSourceToIndexFieldMapping]?, GitHubCommitConfigurationFieldMappings: [DataSourceToIndexFieldMapping]?, GitHubIssueDocumentConfigurationFieldMappings: [DataSourceToIndexFieldMapping]?, GitHubIssueCommentConfigurationFieldMappings: [DataSourceToIndexFieldMapping]?, GitHubIssueAttachmentConfigurationFieldMappings: [DataSourceToIndexFieldMapping]?, GitHubPullRequestCommentConfigurationFieldMappings: [DataSourceToIndexFieldMapping]?, GitHubPullRequestDocumentConfigurationFieldMappings: [DataSourceToIndexFieldMapping]?, GitHubPullRequestDocumentAttachmentConfigurationFieldMappings: [DataSourceToIndexFieldMapping]?}, AlfrescoConfiguration: AlfrescoConfiguration?{SiteUrl: str, SiteId: str, SecretArn: str, SslCertificateS3Path: S3Path{Bucket: str, Key: str}, CrawlSystemFolders: bool?, CrawlComments: bool?, EntityFilter: [str]?, DocumentLibraryFieldMappings: [DataSourceToIndexFieldMapping]?, BlogFieldMappings: [DataSourceToIndexFieldMapping]?, WikiFieldMappings: [DataSourceToIndexFieldMapping]?, InclusionPatterns: [str]?, ExclusionPatterns: [str]?, VpcConfiguration: DataSourceVpcConfiguration?{SubnetIds: [str], SecurityGroupIds: [str]}}, TemplateConfiguration: TemplateConfiguration?{Template: Template?}}, VpcConfiguration: DataSourceVpcConfiguration?{SubnetIds: [str], SecurityGroupIds: [str]}, CreatedAt: str(timestamp)?, UpdatedAt: str(timestamp)?, Description: str?, Status: str?, Schedule: str?, RoleArn: str?, ErrorMessage: str?, LanguageCode: str?, CustomDocumentEnrichmentConfiguration: CustomDocumentEnrichmentConfiguration?{InlineConfigurations: [InlineCustomDocumentEnrichmentConfiguration]?, PreExtractionHookConfiguration: HookConfiguration?{InvocationCondition: DocumentAttributeCondition?{ConditionDocumentAttributeKey: str, Operator: str, ConditionOnValue: DocumentAttributeValue?}, LambdaArn: str, S3Bucket: str}, PostExtractionHookConfiguration: HookConfiguration?{InvocationCondition: DocumentAttributeCondition?{ConditionDocumentAttributeKey: str, Operator: str, ConditionOnValue: DocumentAttributeValue?}, LambdaArn: str, S3Bucket: str}, RoleArn: str?}}

@endpoint POST /
@required {Id: str, IndexId: str}
@returns(200) {Id: str?, IndexId: str?, Name: str?, Endpoints: [ExperienceEndpoint]?, Configuration: ExperienceConfiguration?{ContentSourceConfiguration: ContentSourceConfiguration?{DataSourceIds: [str]?, FaqIds: [str]?, DirectPutContent: bool?}, UserIdentityConfiguration: UserIdentityConfiguration?{IdentityAttributeName: str?}}, CreatedAt: str(timestamp)?, UpdatedAt: str(timestamp)?, Description: str?, Status: str?, RoleArn: str?, ErrorMessage: str?}

@endpoint POST /
@required {Id: str, IndexId: str}
@returns(200) {Id: str?, IndexId: str?, Name: str?, Description: str?, CreatedAt: str(timestamp)?, UpdatedAt: str(timestamp)?, S3Path: S3Path?{Bucket: str, Key: str}, Status: str?, RoleArn: str?, ErrorMessage: str?, FileFormat: str?, LanguageCode: str?}

@endpoint POST /
@required {IndexId: str, FeaturedResultsSetId: str}
@returns(200) {FeaturedResultsSetId: str?, FeaturedResultsSetName: str?, Description: str?, Status: str?, QueryTexts: [str]?, FeaturedDocumentsWithMetadata: [FeaturedDocumentWithMetadata]?, FeaturedDocumentsMissing: [FeaturedDocumentMissing]?, LastUpdatedTimestamp: int(i64)?, CreationTimestamp: int(i64)?}

@endpoint POST /
@required {Id: str}
@returns(200) {Name: str?, Id: str?, Edition: str?, RoleArn: str?, ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration?{KmsKeyId: str?}, Status: str?, Description: str?, CreatedAt: str(timestamp)?, UpdatedAt: str(timestamp)?, DocumentMetadataConfigurations: [DocumentMetadataConfiguration]?, IndexStatistics: IndexStatistics?{FaqStatistics: FaqStatistics{IndexedQuestionAnswersCount: int}, TextDocumentStatistics: TextDocumentStatistics{IndexedTextDocumentsCount: int, IndexedTextBytes: int(i64)}}, ErrorMessage: str?, CapacityUnits: CapacityUnitsConfiguration?{StorageCapacityUnits: int, QueryCapacityUnits: int}, UserTokenConfigurations: [UserTokenConfiguration]?, UserContextPolicy: str?, UserGroupResolutionConfiguration: UserGroupResolutionConfiguration?{UserGroupResolutionMode: str}}

@endpoint POST /
@required {IndexId: str, GroupId: str}
@optional {DataSourceId: str}
@returns(200) {IndexId: str?, DataSourceId: str?, GroupId: str?, GroupOrderingIdSummaries: [GroupOrderingIdSummary]?}

@endpoint POST /
@required {IndexId: str, Id: str}
@returns(200) {IndexId: str?, Id: str?, Name: str?, Description: str?, Status: str?, ErrorMessage: str?, CreatedAt: str(timestamp)?, UpdatedAt: str(timestamp)?, SourceS3Path: S3Path?{Bucket: str, Key: str}, ItemCount: int?, FileSizeBytes: int(i64)?, RoleArn: str?}

@endpoint POST /
@required {IndexId: str}
@returns(200) {Mode: str?, Status: str?, QueryLogLookBackWindowInDays: int?, IncludeQueriesWithoutUserInformation: bool?, MinimumNumberOfQueryingUsers: int?, MinimumQueryCount: int?, LastSuggestionsBuildTime: str(timestamp)?, LastClearTime: str(timestamp)?, TotalSuggestionsCount: int?, AttributeSuggestionsConfig: AttributeSuggestionsDescribeConfig?{SuggestableConfigList: [SuggestableConfig]?, AttributeSuggestionsMode: str?}}

@endpoint POST /
@required {Id: str, IndexId: str}
@returns(200) {Id: str?, IndexId: str?, Name: str?, Description: str?, Status: str?, ErrorMessage: str?, CreatedAt: str(timestamp)?, UpdatedAt: str(timestamp)?, RoleArn: str?, SourceS3Path: S3Path?{Bucket: str, Key: str}, FileSizeBytes: int(i64)?, TermCount: int(i64)?, SynonymRuleCount: int(i64)?}

@endpoint POST /
@required {Id: str, IndexId: str, EntityList: [EntityConfiguration]}
@returns(200) {FailedEntityList: [FailedEntity]?}

@endpoint POST /
@required {Id: str, IndexId: str, EntityIds: [str]}
@returns(200) {FailedEntityList: [FailedEntity]?}

@endpoint POST /
@required {IndexId: str, QueryText: str}
@optional {MaxSuggestionsCount: int, SuggestionTypes: [str], AttributeSuggestionsConfig: AttributeSuggestionsGetConfig}
@returns(200) {QuerySuggestionsId: str?, Suggestions: [Suggestion]?}

@endpoint POST /
@required {IndexId: str, Interval: str, MetricType: str}
@optional {NextToken: str, MaxResults: int}
@returns(200) {SnapShotTimeFilter: TimeRange?{StartTime: str(timestamp)?, EndTime: str(timestamp)?}, SnapshotsDataHeader: [str]?, SnapshotsData: [[str]]?, NextToken: str?}

@endpoint POST /
@required {IndexId: str}
@optional {NextToken: str, MaxResults: int}
@returns(200) {NextToken: str?, AccessControlConfigurations: [AccessControlConfigurationSummary]}

@endpoint POST /
@required {Id: str, IndexId: str}
@optional {NextToken: str, MaxResults: int, StartTimeFilter: TimeRange, StatusFilter: str}
@returns(200) {History: [DataSourceSyncJob]?, NextToken: str?}

@endpoint POST /
@required {IndexId: str}
@optional {NextToken: str, MaxResults: int}
@returns(200) {SummaryItems: [DataSourceSummary]?, NextToken: str?}

@endpoint POST /
@required {Id: str, IndexId: str}
@optional {NextToken: str, MaxResults: int}
@returns(200) {SummaryItems: [PersonasSummary]?, NextToken: str?}

@endpoint POST /
@required {Id: str, IndexId: str}
@optional {NextToken: str}
@returns(200) {SummaryItems: [ExperienceEntitiesSummary]?, NextToken: str?}

@endpoint POST /
@required {IndexId: str}
@optional {NextToken: str, MaxResults: int}
@returns(200) {SummaryItems: [ExperiencesSummary]?, NextToken: str?}

@endpoint POST /
@required {IndexId: str}
@optional {NextToken: str, MaxResults: int}
@returns(200) {NextToken: str?, FaqSummaryItems: [FaqSummary]?}

@endpoint POST /
@required {IndexId: str}
@optional {NextToken: str, MaxResults: int}
@returns(200) {FeaturedResultsSetSummaryItems: [FeaturedResultsSetSummary]?, NextToken: str?}

@endpoint POST /
@required {IndexId: str, OrderingId: int(i64)}
@optional {DataSourceId: str, NextToken: str, MaxResults: int}
@returns(200) {GroupsSummaries: [GroupSummary]?, NextToken: str?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int}
@returns(200) {IndexConfigurationSummaryItems: [IndexConfigurationSummary]?, NextToken: str?}

@endpoint POST /
@required {IndexId: str}
@optional {NextToken: str, MaxResults: int}
@returns(200) {BlockListSummaryItems: [QuerySuggestionsBlockListSummary]?, NextToken: str?}

@endpoint POST /
@required {ResourceARN: str}
@returns(200) {Tags: [Tag]?}

@endpoint POST /
@required {IndexId: str}
@optional {NextToken: str, MaxResults: int}
@returns(200) {NextToken: str?, ThesaurusSummaryItems: [ThesaurusSummary]?}

@endpoint POST /
@required {IndexId: str, GroupId: str, GroupMembers: GroupMembers}
@optional {DataSourceId: str, OrderingId: int(i64), RoleArn: str}

@endpoint POST /
@required {IndexId: str}
@optional {QueryText: str, AttributeFilter: AttributeFilter, Facets: [Facet], RequestedDocumentAttributes: [str], QueryResultTypeFilter: str, DocumentRelevanceOverrideConfigurations: [DocumentRelevanceConfiguration], PageNumber: int, PageSize: int, SortingConfiguration: SortingConfiguration, SortingConfigurations: [SortingConfiguration], UserContext: UserContext, VisitorId: str, SpellCorrectionConfiguration: SpellCorrectionConfiguration, CollapseConfiguration: CollapseConfiguration}
@returns(200) {QueryId: str?, ResultItems: [QueryResultItem]?, FacetResults: [FacetResult]?, TotalNumberOfResults: int?, Warnings: [Warning]?, SpellCorrectedQueries: [SpellCorrectedQuery]?, FeaturedResultsItems: [FeaturedResultsItem]?}

@endpoint POST /
@required {IndexId: str, QueryText: str}
@optional {AttributeFilter: AttributeFilter, RequestedDocumentAttributes: [str], DocumentRelevanceOverrideConfigurations: [DocumentRelevanceConfiguration], PageNumber: int, PageSize: int, UserContext: UserContext}
@returns(200) {QueryId: str?, ResultItems: [RetrieveResultItem]?}

@endpoint POST /
@required {Id: str, IndexId: str}
@returns(200) {ExecutionId: str?}

@endpoint POST /
@required {Id: str, IndexId: str}

@endpoint POST /
@required {IndexId: str, QueryId: str}
@optional {ClickFeedbackItems: [ClickFeedback], RelevanceFeedbackItems: [RelevanceFeedback]}

@endpoint POST /
@required {ResourceARN: str, Tags: [Tag]}

@endpoint POST /
@required {ResourceARN: str, TagKeys: [str]}

@endpoint POST /
@required {IndexId: str, Id: str}
@optional {Name: str, Description: str, AccessControlList: [Principal], HierarchicalAccessControlList: [HierarchicalPrincipal]}

@endpoint POST /
@required {Id: str, IndexId: str}
@optional {Name: str, Configuration: DataSourceConfiguration, VpcConfiguration: DataSourceVpcConfiguration, Description: str, Schedule: str, RoleArn: str, LanguageCode: str, CustomDocumentEnrichmentConfiguration: CustomDocumentEnrichmentConfiguration}

@endpoint POST /
@required {Id: str, IndexId: str}
@optional {Name: str, RoleArn: str, Configuration: ExperienceConfiguration, Description: str}

@endpoint POST /
@required {IndexId: str, FeaturedResultsSetId: str}
@optional {FeaturedResultsSetName: str, Description: str, Status: str, QueryTexts: [str], FeaturedDocuments: [FeaturedDocument]}
@returns(200) {FeaturedResultsSet: FeaturedResultsSet?{FeaturedResultsSetId: str?, FeaturedResultsSetName: str?, Description: str?, Status: str?, QueryTexts: [str]?, FeaturedDocuments: [FeaturedDocument]?, LastUpdatedTimestamp: int(i64)?, CreationTimestamp: int(i64)?}}

@endpoint POST /
@required {Id: str}
@optional {Name: str, RoleArn: str, Description: str, DocumentMetadataConfigurationUpdates: [DocumentMetadataConfiguration], CapacityUnits: CapacityUnitsConfiguration, UserTokenConfigurations: [UserTokenConfiguration], UserContextPolicy: str, UserGroupResolutionConfiguration: UserGroupResolutionConfiguration}

@endpoint POST /
@required {IndexId: str, Id: str}
@optional {Name: str, Description: str, SourceS3Path: S3Path, RoleArn: str}

@endpoint POST /
@required {IndexId: str}
@optional {Mode: str, QueryLogLookBackWindowInDays: int, IncludeQueriesWithoutUserInformation: bool, MinimumNumberOfQueryingUsers: int, MinimumQueryCount: int, AttributeSuggestionsConfig: AttributeSuggestionsUpdateConfig}

@endpoint POST /
@required {Id: str, IndexId: str}
@optional {Name: str, Description: str, RoleArn: str, SourceS3Path: S3Path}

@end