Documentation ¶
Overview ¶
Package kendra provides the client and types for making API requests to AWSKendraFrontendService.
Amazon Kendra is a service for indexing large document sets.
See https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03 for more information on this service.
See kendra package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/kendra/
Using the Client ¶
To contact AWSKendraFrontendService with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the AWSKendraFrontendService client Kendra for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/kendra/#New
Index ¶
- Constants
- type AccessControlListConfiguration
- type AccessDeniedException
- func (s AccessDeniedException) Code() string
- func (s AccessDeniedException) Error() string
- func (s AccessDeniedException) GoString() string
- func (s AccessDeniedException) Message() string
- func (s AccessDeniedException) OrigErr() error
- func (s AccessDeniedException) RequestID() string
- func (s AccessDeniedException) StatusCode() int
- func (s AccessDeniedException) String() string
- type AclConfiguration
- type AdditionalResultAttribute
- func (s AdditionalResultAttribute) GoString() string
- func (s *AdditionalResultAttribute) SetKey(v string) *AdditionalResultAttribute
- func (s *AdditionalResultAttribute) SetValue(v *AdditionalResultAttributeValue) *AdditionalResultAttribute
- func (s *AdditionalResultAttribute) SetValueType(v string) *AdditionalResultAttribute
- func (s AdditionalResultAttribute) String() string
- type AdditionalResultAttributeValue
- type AttributeFilter
- func (s AttributeFilter) GoString() string
- func (s *AttributeFilter) SetAndAllFilters(v []*AttributeFilter) *AttributeFilter
- func (s *AttributeFilter) SetContainsAll(v *DocumentAttribute) *AttributeFilter
- func (s *AttributeFilter) SetContainsAny(v *DocumentAttribute) *AttributeFilter
- func (s *AttributeFilter) SetEqualsTo(v *DocumentAttribute) *AttributeFilter
- func (s *AttributeFilter) SetGreaterThan(v *DocumentAttribute) *AttributeFilter
- func (s *AttributeFilter) SetGreaterThanOrEquals(v *DocumentAttribute) *AttributeFilter
- func (s *AttributeFilter) SetLessThan(v *DocumentAttribute) *AttributeFilter
- func (s *AttributeFilter) SetLessThanOrEquals(v *DocumentAttribute) *AttributeFilter
- func (s *AttributeFilter) SetNotFilter(v *AttributeFilter) *AttributeFilter
- func (s *AttributeFilter) SetOrAllFilters(v []*AttributeFilter) *AttributeFilter
- func (s AttributeFilter) String() string
- func (s *AttributeFilter) Validate() error
- type BatchDeleteDocumentInput
- func (s BatchDeleteDocumentInput) GoString() string
- func (s *BatchDeleteDocumentInput) SetDocumentIdList(v []*string) *BatchDeleteDocumentInput
- func (s *BatchDeleteDocumentInput) SetIndexId(v string) *BatchDeleteDocumentInput
- func (s BatchDeleteDocumentInput) String() string
- func (s *BatchDeleteDocumentInput) Validate() error
- type BatchDeleteDocumentOutput
- type BatchDeleteDocumentResponseFailedDocument
- func (s BatchDeleteDocumentResponseFailedDocument) GoString() string
- func (s *BatchDeleteDocumentResponseFailedDocument) SetErrorCode(v string) *BatchDeleteDocumentResponseFailedDocument
- func (s *BatchDeleteDocumentResponseFailedDocument) SetErrorMessage(v string) *BatchDeleteDocumentResponseFailedDocument
- func (s *BatchDeleteDocumentResponseFailedDocument) SetId(v string) *BatchDeleteDocumentResponseFailedDocument
- func (s BatchDeleteDocumentResponseFailedDocument) String() string
- type BatchPutDocumentInput
- func (s BatchPutDocumentInput) GoString() string
- func (s *BatchPutDocumentInput) SetDocuments(v []*Document) *BatchPutDocumentInput
- func (s *BatchPutDocumentInput) SetIndexId(v string) *BatchPutDocumentInput
- func (s *BatchPutDocumentInput) SetRoleArn(v string) *BatchPutDocumentInput
- func (s BatchPutDocumentInput) String() string
- func (s *BatchPutDocumentInput) Validate() error
- type BatchPutDocumentOutput
- type BatchPutDocumentResponseFailedDocument
- func (s BatchPutDocumentResponseFailedDocument) GoString() string
- func (s *BatchPutDocumentResponseFailedDocument) SetErrorCode(v string) *BatchPutDocumentResponseFailedDocument
- func (s *BatchPutDocumentResponseFailedDocument) SetErrorMessage(v string) *BatchPutDocumentResponseFailedDocument
- func (s *BatchPutDocumentResponseFailedDocument) SetId(v string) *BatchPutDocumentResponseFailedDocument
- func (s BatchPutDocumentResponseFailedDocument) String() string
- type ClickFeedback
- type ColumnConfiguration
- func (s ColumnConfiguration) GoString() string
- func (s *ColumnConfiguration) SetChangeDetectingColumns(v []*string) *ColumnConfiguration
- func (s *ColumnConfiguration) SetDocumentDataColumnName(v string) *ColumnConfiguration
- func (s *ColumnConfiguration) SetDocumentIdColumnName(v string) *ColumnConfiguration
- func (s *ColumnConfiguration) SetDocumentTitleColumnName(v string) *ColumnConfiguration
- func (s *ColumnConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *ColumnConfiguration
- func (s ColumnConfiguration) String() string
- func (s *ColumnConfiguration) Validate() error
- type ConflictException
- func (s ConflictException) Code() string
- func (s ConflictException) Error() string
- func (s ConflictException) GoString() string
- func (s ConflictException) Message() string
- func (s ConflictException) OrigErr() error
- func (s ConflictException) RequestID() string
- func (s ConflictException) StatusCode() int
- func (s ConflictException) String() string
- type ConnectionConfiguration
- func (s ConnectionConfiguration) GoString() string
- func (s *ConnectionConfiguration) SetDatabaseHost(v string) *ConnectionConfiguration
- func (s *ConnectionConfiguration) SetDatabaseName(v string) *ConnectionConfiguration
- func (s *ConnectionConfiguration) SetDatabasePort(v int64) *ConnectionConfiguration
- func (s *ConnectionConfiguration) SetSecretArn(v string) *ConnectionConfiguration
- func (s *ConnectionConfiguration) SetTableName(v string) *ConnectionConfiguration
- func (s ConnectionConfiguration) String() string
- func (s *ConnectionConfiguration) Validate() error
- type CreateDataSourceInput
- func (s CreateDataSourceInput) GoString() string
- func (s *CreateDataSourceInput) SetConfiguration(v *DataSourceConfiguration) *CreateDataSourceInput
- func (s *CreateDataSourceInput) SetDescription(v string) *CreateDataSourceInput
- func (s *CreateDataSourceInput) SetIndexId(v string) *CreateDataSourceInput
- func (s *CreateDataSourceInput) SetName(v string) *CreateDataSourceInput
- func (s *CreateDataSourceInput) SetRoleArn(v string) *CreateDataSourceInput
- func (s *CreateDataSourceInput) SetSchedule(v string) *CreateDataSourceInput
- func (s *CreateDataSourceInput) SetType(v string) *CreateDataSourceInput
- func (s CreateDataSourceInput) String() string
- func (s *CreateDataSourceInput) Validate() error
- type CreateDataSourceOutput
- type CreateFaqInput
- func (s CreateFaqInput) GoString() string
- func (s *CreateFaqInput) SetDescription(v string) *CreateFaqInput
- func (s *CreateFaqInput) SetIndexId(v string) *CreateFaqInput
- func (s *CreateFaqInput) SetName(v string) *CreateFaqInput
- func (s *CreateFaqInput) SetRoleArn(v string) *CreateFaqInput
- func (s *CreateFaqInput) SetS3Path(v *S3Path) *CreateFaqInput
- func (s CreateFaqInput) String() string
- func (s *CreateFaqInput) Validate() error
- type CreateFaqOutput
- type CreateIndexInput
- func (s CreateIndexInput) GoString() string
- func (s *CreateIndexInput) SetDescription(v string) *CreateIndexInput
- func (s *CreateIndexInput) SetName(v string) *CreateIndexInput
- func (s *CreateIndexInput) SetRoleArn(v string) *CreateIndexInput
- func (s *CreateIndexInput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *CreateIndexInput
- func (s CreateIndexInput) String() string
- func (s *CreateIndexInput) Validate() error
- type CreateIndexOutput
- type DataSourceConfiguration
- func (s DataSourceConfiguration) GoString() string
- func (s *DataSourceConfiguration) SetDatabaseConfiguration(v *DatabaseConfiguration) *DataSourceConfiguration
- func (s *DataSourceConfiguration) SetS3Configuration(v *S3DataSourceConfiguration) *DataSourceConfiguration
- func (s *DataSourceConfiguration) SetSharePointConfiguration(v *SharePointConfiguration) *DataSourceConfiguration
- func (s DataSourceConfiguration) String() string
- func (s *DataSourceConfiguration) Validate() error
- type DataSourceSummary
- func (s DataSourceSummary) GoString() string
- func (s *DataSourceSummary) SetCreatedAt(v time.Time) *DataSourceSummary
- func (s *DataSourceSummary) SetId(v string) *DataSourceSummary
- func (s *DataSourceSummary) SetName(v string) *DataSourceSummary
- func (s *DataSourceSummary) SetStatus(v string) *DataSourceSummary
- func (s *DataSourceSummary) SetType(v string) *DataSourceSummary
- func (s *DataSourceSummary) SetUpdatedAt(v time.Time) *DataSourceSummary
- func (s DataSourceSummary) String() string
- type DataSourceSyncJob
- func (s DataSourceSyncJob) GoString() string
- func (s *DataSourceSyncJob) SetDataSourceErrorCode(v string) *DataSourceSyncJob
- func (s *DataSourceSyncJob) SetEndTime(v time.Time) *DataSourceSyncJob
- func (s *DataSourceSyncJob) SetErrorCode(v string) *DataSourceSyncJob
- func (s *DataSourceSyncJob) SetErrorMessage(v string) *DataSourceSyncJob
- func (s *DataSourceSyncJob) SetExecutionId(v string) *DataSourceSyncJob
- func (s *DataSourceSyncJob) SetStartTime(v time.Time) *DataSourceSyncJob
- func (s *DataSourceSyncJob) SetStatus(v string) *DataSourceSyncJob
- func (s DataSourceSyncJob) String() string
- type DataSourceToIndexFieldMapping
- func (s DataSourceToIndexFieldMapping) GoString() string
- func (s *DataSourceToIndexFieldMapping) SetDataSourceFieldName(v string) *DataSourceToIndexFieldMapping
- func (s *DataSourceToIndexFieldMapping) SetDateFieldFormat(v string) *DataSourceToIndexFieldMapping
- func (s *DataSourceToIndexFieldMapping) SetIndexFieldName(v string) *DataSourceToIndexFieldMapping
- func (s DataSourceToIndexFieldMapping) String() string
- func (s *DataSourceToIndexFieldMapping) Validate() error
- type DataSourceVpcConfiguration
- func (s DataSourceVpcConfiguration) GoString() string
- func (s *DataSourceVpcConfiguration) SetSecurityGroupIds(v []*string) *DataSourceVpcConfiguration
- func (s *DataSourceVpcConfiguration) SetSubnetIds(v []*string) *DataSourceVpcConfiguration
- func (s DataSourceVpcConfiguration) String() string
- func (s *DataSourceVpcConfiguration) Validate() error
- type DatabaseConfiguration
- func (s DatabaseConfiguration) GoString() string
- func (s *DatabaseConfiguration) SetAclConfiguration(v *AclConfiguration) *DatabaseConfiguration
- func (s *DatabaseConfiguration) SetColumnConfiguration(v *ColumnConfiguration) *DatabaseConfiguration
- func (s *DatabaseConfiguration) SetConnectionConfiguration(v *ConnectionConfiguration) *DatabaseConfiguration
- func (s *DatabaseConfiguration) SetDatabaseEngineType(v string) *DatabaseConfiguration
- func (s *DatabaseConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *DatabaseConfiguration
- func (s DatabaseConfiguration) String() string
- func (s *DatabaseConfiguration) Validate() error
- type DeleteFaqInput
- type DeleteFaqOutput
- type DeleteIndexInput
- type DeleteIndexOutput
- type DescribeDataSourceInput
- func (s DescribeDataSourceInput) GoString() string
- func (s *DescribeDataSourceInput) SetId(v string) *DescribeDataSourceInput
- func (s *DescribeDataSourceInput) SetIndexId(v string) *DescribeDataSourceInput
- func (s DescribeDataSourceInput) String() string
- func (s *DescribeDataSourceInput) Validate() error
- type DescribeDataSourceOutput
- func (s DescribeDataSourceOutput) GoString() string
- func (s *DescribeDataSourceOutput) SetConfiguration(v *DataSourceConfiguration) *DescribeDataSourceOutput
- func (s *DescribeDataSourceOutput) SetCreatedAt(v time.Time) *DescribeDataSourceOutput
- func (s *DescribeDataSourceOutput) SetDescription(v string) *DescribeDataSourceOutput
- func (s *DescribeDataSourceOutput) SetErrorMessage(v string) *DescribeDataSourceOutput
- func (s *DescribeDataSourceOutput) SetId(v string) *DescribeDataSourceOutput
- func (s *DescribeDataSourceOutput) SetIndexId(v string) *DescribeDataSourceOutput
- func (s *DescribeDataSourceOutput) SetName(v string) *DescribeDataSourceOutput
- func (s *DescribeDataSourceOutput) SetRoleArn(v string) *DescribeDataSourceOutput
- func (s *DescribeDataSourceOutput) SetSchedule(v string) *DescribeDataSourceOutput
- func (s *DescribeDataSourceOutput) SetStatus(v string) *DescribeDataSourceOutput
- func (s *DescribeDataSourceOutput) SetType(v string) *DescribeDataSourceOutput
- func (s *DescribeDataSourceOutput) SetUpdatedAt(v time.Time) *DescribeDataSourceOutput
- func (s DescribeDataSourceOutput) String() string
- type DescribeFaqInput
- type DescribeFaqOutput
- func (s DescribeFaqOutput) GoString() string
- func (s *DescribeFaqOutput) SetCreatedAt(v time.Time) *DescribeFaqOutput
- func (s *DescribeFaqOutput) SetDescription(v string) *DescribeFaqOutput
- func (s *DescribeFaqOutput) SetErrorMessage(v string) *DescribeFaqOutput
- func (s *DescribeFaqOutput) SetId(v string) *DescribeFaqOutput
- func (s *DescribeFaqOutput) SetIndexId(v string) *DescribeFaqOutput
- func (s *DescribeFaqOutput) SetName(v string) *DescribeFaqOutput
- func (s *DescribeFaqOutput) SetRoleArn(v string) *DescribeFaqOutput
- func (s *DescribeFaqOutput) SetS3Path(v *S3Path) *DescribeFaqOutput
- func (s *DescribeFaqOutput) SetStatus(v string) *DescribeFaqOutput
- func (s *DescribeFaqOutput) SetUpdatedAt(v time.Time) *DescribeFaqOutput
- func (s DescribeFaqOutput) String() string
- type DescribeIndexInput
- type DescribeIndexOutput
- func (s DescribeIndexOutput) GoString() string
- func (s *DescribeIndexOutput) SetCreatedAt(v time.Time) *DescribeIndexOutput
- func (s *DescribeIndexOutput) SetDescription(v string) *DescribeIndexOutput
- func (s *DescribeIndexOutput) SetDocumentMetadataConfigurations(v []*DocumentMetadataConfiguration) *DescribeIndexOutput
- func (s *DescribeIndexOutput) SetErrorMessage(v string) *DescribeIndexOutput
- func (s *DescribeIndexOutput) SetId(v string) *DescribeIndexOutput
- func (s *DescribeIndexOutput) SetIndexStatistics(v *IndexStatistics) *DescribeIndexOutput
- func (s *DescribeIndexOutput) SetName(v string) *DescribeIndexOutput
- func (s *DescribeIndexOutput) SetRoleArn(v string) *DescribeIndexOutput
- func (s *DescribeIndexOutput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *DescribeIndexOutput
- func (s *DescribeIndexOutput) SetStatus(v string) *DescribeIndexOutput
- func (s *DescribeIndexOutput) SetUpdatedAt(v time.Time) *DescribeIndexOutput
- func (s DescribeIndexOutput) String() string
- type Document
- func (s Document) GoString() string
- func (s *Document) SetAccessControlList(v []*Principal) *Document
- func (s *Document) SetAttributes(v []*DocumentAttribute) *Document
- func (s *Document) SetBlob(v []byte) *Document
- func (s *Document) SetContentType(v string) *Document
- func (s *Document) SetId(v string) *Document
- func (s *Document) SetS3Path(v *S3Path) *Document
- func (s *Document) SetTitle(v string) *Document
- func (s Document) String() string
- func (s *Document) Validate() error
- type DocumentAttribute
- type DocumentAttributeValue
- func (s DocumentAttributeValue) GoString() string
- func (s *DocumentAttributeValue) SetDateValue(v time.Time) *DocumentAttributeValue
- func (s *DocumentAttributeValue) SetLongValue(v int64) *DocumentAttributeValue
- func (s *DocumentAttributeValue) SetStringListValue(v []*string) *DocumentAttributeValue
- func (s *DocumentAttributeValue) SetStringValue(v string) *DocumentAttributeValue
- func (s DocumentAttributeValue) String() string
- func (s *DocumentAttributeValue) Validate() error
- type DocumentAttributeValueCountPair
- func (s DocumentAttributeValueCountPair) GoString() string
- func (s *DocumentAttributeValueCountPair) SetCount(v int64) *DocumentAttributeValueCountPair
- func (s *DocumentAttributeValueCountPair) SetDocumentAttributeValue(v *DocumentAttributeValue) *DocumentAttributeValueCountPair
- func (s DocumentAttributeValueCountPair) String() string
- type DocumentMetadataConfiguration
- func (s DocumentMetadataConfiguration) GoString() string
- func (s *DocumentMetadataConfiguration) SetName(v string) *DocumentMetadataConfiguration
- func (s *DocumentMetadataConfiguration) SetRelevance(v *Relevance) *DocumentMetadataConfiguration
- func (s *DocumentMetadataConfiguration) SetSearch(v *Search) *DocumentMetadataConfiguration
- func (s *DocumentMetadataConfiguration) SetType(v string) *DocumentMetadataConfiguration
- func (s DocumentMetadataConfiguration) String() string
- func (s *DocumentMetadataConfiguration) Validate() error
- type DocumentsMetadataConfiguration
- type Facet
- type FacetResult
- type FaqStatistics
- type FaqSummary
- func (s FaqSummary) GoString() string
- func (s *FaqSummary) SetCreatedAt(v time.Time) *FaqSummary
- func (s *FaqSummary) SetId(v string) *FaqSummary
- func (s *FaqSummary) SetName(v string) *FaqSummary
- func (s *FaqSummary) SetStatus(v string) *FaqSummary
- func (s *FaqSummary) SetUpdatedAt(v time.Time) *FaqSummary
- func (s FaqSummary) String() string
- type Highlight
- type IndexConfigurationSummary
- func (s IndexConfigurationSummary) GoString() string
- func (s *IndexConfigurationSummary) SetCreatedAt(v time.Time) *IndexConfigurationSummary
- func (s *IndexConfigurationSummary) SetId(v string) *IndexConfigurationSummary
- func (s *IndexConfigurationSummary) SetName(v string) *IndexConfigurationSummary
- func (s *IndexConfigurationSummary) SetStatus(v string) *IndexConfigurationSummary
- func (s *IndexConfigurationSummary) SetUpdatedAt(v time.Time) *IndexConfigurationSummary
- func (s IndexConfigurationSummary) String() string
- type IndexStatistics
- type InternalServerException
- func (s InternalServerException) Code() string
- func (s InternalServerException) Error() string
- func (s InternalServerException) GoString() string
- func (s InternalServerException) Message() string
- func (s InternalServerException) OrigErr() error
- func (s InternalServerException) RequestID() string
- func (s InternalServerException) StatusCode() int
- func (s InternalServerException) String() string
- type Kendra
- func (c *Kendra) BatchDeleteDocument(input *BatchDeleteDocumentInput) (*BatchDeleteDocumentOutput, error)
- func (c *Kendra) BatchDeleteDocumentRequest(input *BatchDeleteDocumentInput) (req *request.Request, output *BatchDeleteDocumentOutput)
- func (c *Kendra) BatchDeleteDocumentWithContext(ctx aws.Context, input *BatchDeleteDocumentInput, opts ...request.Option) (*BatchDeleteDocumentOutput, error)
- func (c *Kendra) BatchPutDocument(input *BatchPutDocumentInput) (*BatchPutDocumentOutput, error)
- func (c *Kendra) BatchPutDocumentRequest(input *BatchPutDocumentInput) (req *request.Request, output *BatchPutDocumentOutput)
- func (c *Kendra) BatchPutDocumentWithContext(ctx aws.Context, input *BatchPutDocumentInput, opts ...request.Option) (*BatchPutDocumentOutput, error)
- func (c *Kendra) CreateDataSource(input *CreateDataSourceInput) (*CreateDataSourceOutput, error)
- func (c *Kendra) CreateDataSourceRequest(input *CreateDataSourceInput) (req *request.Request, output *CreateDataSourceOutput)
- func (c *Kendra) CreateDataSourceWithContext(ctx aws.Context, input *CreateDataSourceInput, opts ...request.Option) (*CreateDataSourceOutput, error)
- func (c *Kendra) CreateFaq(input *CreateFaqInput) (*CreateFaqOutput, error)
- func (c *Kendra) CreateFaqRequest(input *CreateFaqInput) (req *request.Request, output *CreateFaqOutput)
- func (c *Kendra) CreateFaqWithContext(ctx aws.Context, input *CreateFaqInput, opts ...request.Option) (*CreateFaqOutput, error)
- func (c *Kendra) CreateIndex(input *CreateIndexInput) (*CreateIndexOutput, error)
- func (c *Kendra) CreateIndexRequest(input *CreateIndexInput) (req *request.Request, output *CreateIndexOutput)
- func (c *Kendra) CreateIndexWithContext(ctx aws.Context, input *CreateIndexInput, opts ...request.Option) (*CreateIndexOutput, error)
- func (c *Kendra) DeleteFaq(input *DeleteFaqInput) (*DeleteFaqOutput, error)
- func (c *Kendra) DeleteFaqRequest(input *DeleteFaqInput) (req *request.Request, output *DeleteFaqOutput)
- func (c *Kendra) DeleteFaqWithContext(ctx aws.Context, input *DeleteFaqInput, opts ...request.Option) (*DeleteFaqOutput, error)
- func (c *Kendra) DeleteIndex(input *DeleteIndexInput) (*DeleteIndexOutput, error)
- func (c *Kendra) DeleteIndexRequest(input *DeleteIndexInput) (req *request.Request, output *DeleteIndexOutput)
- func (c *Kendra) DeleteIndexWithContext(ctx aws.Context, input *DeleteIndexInput, opts ...request.Option) (*DeleteIndexOutput, error)
- func (c *Kendra) DescribeDataSource(input *DescribeDataSourceInput) (*DescribeDataSourceOutput, error)
- func (c *Kendra) DescribeDataSourceRequest(input *DescribeDataSourceInput) (req *request.Request, output *DescribeDataSourceOutput)
- func (c *Kendra) DescribeDataSourceWithContext(ctx aws.Context, input *DescribeDataSourceInput, opts ...request.Option) (*DescribeDataSourceOutput, error)
- func (c *Kendra) DescribeFaq(input *DescribeFaqInput) (*DescribeFaqOutput, error)
- func (c *Kendra) DescribeFaqRequest(input *DescribeFaqInput) (req *request.Request, output *DescribeFaqOutput)
- func (c *Kendra) DescribeFaqWithContext(ctx aws.Context, input *DescribeFaqInput, opts ...request.Option) (*DescribeFaqOutput, error)
- func (c *Kendra) DescribeIndex(input *DescribeIndexInput) (*DescribeIndexOutput, error)
- func (c *Kendra) DescribeIndexRequest(input *DescribeIndexInput) (req *request.Request, output *DescribeIndexOutput)
- func (c *Kendra) DescribeIndexWithContext(ctx aws.Context, input *DescribeIndexInput, opts ...request.Option) (*DescribeIndexOutput, error)
- func (c *Kendra) ListDataSourceSyncJobs(input *ListDataSourceSyncJobsInput) (*ListDataSourceSyncJobsOutput, error)
- func (c *Kendra) ListDataSourceSyncJobsPages(input *ListDataSourceSyncJobsInput, ...) error
- func (c *Kendra) ListDataSourceSyncJobsPagesWithContext(ctx aws.Context, input *ListDataSourceSyncJobsInput, ...) error
- func (c *Kendra) ListDataSourceSyncJobsRequest(input *ListDataSourceSyncJobsInput) (req *request.Request, output *ListDataSourceSyncJobsOutput)
- func (c *Kendra) ListDataSourceSyncJobsWithContext(ctx aws.Context, input *ListDataSourceSyncJobsInput, opts ...request.Option) (*ListDataSourceSyncJobsOutput, error)
- func (c *Kendra) ListDataSources(input *ListDataSourcesInput) (*ListDataSourcesOutput, error)
- func (c *Kendra) ListDataSourcesPages(input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool) error
- func (c *Kendra) ListDataSourcesPagesWithContext(ctx aws.Context, input *ListDataSourcesInput, ...) error
- func (c *Kendra) ListDataSourcesRequest(input *ListDataSourcesInput) (req *request.Request, output *ListDataSourcesOutput)
- func (c *Kendra) ListDataSourcesWithContext(ctx aws.Context, input *ListDataSourcesInput, opts ...request.Option) (*ListDataSourcesOutput, error)
- func (c *Kendra) ListFaqs(input *ListFaqsInput) (*ListFaqsOutput, error)
- func (c *Kendra) ListFaqsRequest(input *ListFaqsInput) (req *request.Request, output *ListFaqsOutput)
- func (c *Kendra) ListFaqsWithContext(ctx aws.Context, input *ListFaqsInput, opts ...request.Option) (*ListFaqsOutput, error)
- func (c *Kendra) ListIndices(input *ListIndicesInput) (*ListIndicesOutput, error)
- func (c *Kendra) ListIndicesPages(input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool) error
- func (c *Kendra) ListIndicesPagesWithContext(ctx aws.Context, input *ListIndicesInput, ...) error
- func (c *Kendra) ListIndicesRequest(input *ListIndicesInput) (req *request.Request, output *ListIndicesOutput)
- func (c *Kendra) ListIndicesWithContext(ctx aws.Context, input *ListIndicesInput, opts ...request.Option) (*ListIndicesOutput, error)
- func (c *Kendra) Query(input *QueryInput) (*QueryOutput, error)
- func (c *Kendra) QueryRequest(input *QueryInput) (req *request.Request, output *QueryOutput)
- func (c *Kendra) QueryWithContext(ctx aws.Context, input *QueryInput, opts ...request.Option) (*QueryOutput, error)
- func (c *Kendra) StartDataSourceSyncJob(input *StartDataSourceSyncJobInput) (*StartDataSourceSyncJobOutput, error)
- func (c *Kendra) StartDataSourceSyncJobRequest(input *StartDataSourceSyncJobInput) (req *request.Request, output *StartDataSourceSyncJobOutput)
- func (c *Kendra) StartDataSourceSyncJobWithContext(ctx aws.Context, input *StartDataSourceSyncJobInput, opts ...request.Option) (*StartDataSourceSyncJobOutput, error)
- func (c *Kendra) StopDataSourceSyncJob(input *StopDataSourceSyncJobInput) (*StopDataSourceSyncJobOutput, error)
- func (c *Kendra) StopDataSourceSyncJobRequest(input *StopDataSourceSyncJobInput) (req *request.Request, output *StopDataSourceSyncJobOutput)
- func (c *Kendra) StopDataSourceSyncJobWithContext(ctx aws.Context, input *StopDataSourceSyncJobInput, opts ...request.Option) (*StopDataSourceSyncJobOutput, error)
- func (c *Kendra) SubmitFeedback(input *SubmitFeedbackInput) (*SubmitFeedbackOutput, error)
- func (c *Kendra) SubmitFeedbackRequest(input *SubmitFeedbackInput) (req *request.Request, output *SubmitFeedbackOutput)
- func (c *Kendra) SubmitFeedbackWithContext(ctx aws.Context, input *SubmitFeedbackInput, opts ...request.Option) (*SubmitFeedbackOutput, error)
- func (c *Kendra) UpdateDataSource(input *UpdateDataSourceInput) (*UpdateDataSourceOutput, error)
- func (c *Kendra) UpdateDataSourceRequest(input *UpdateDataSourceInput) (req *request.Request, output *UpdateDataSourceOutput)
- func (c *Kendra) UpdateDataSourceWithContext(ctx aws.Context, input *UpdateDataSourceInput, opts ...request.Option) (*UpdateDataSourceOutput, error)
- func (c *Kendra) UpdateIndex(input *UpdateIndexInput) (*UpdateIndexOutput, error)
- func (c *Kendra) UpdateIndexRequest(input *UpdateIndexInput) (req *request.Request, output *UpdateIndexOutput)
- func (c *Kendra) UpdateIndexWithContext(ctx aws.Context, input *UpdateIndexInput, opts ...request.Option) (*UpdateIndexOutput, error)
- type ListDataSourceSyncJobsInput
- func (s ListDataSourceSyncJobsInput) GoString() string
- func (s *ListDataSourceSyncJobsInput) SetId(v string) *ListDataSourceSyncJobsInput
- func (s *ListDataSourceSyncJobsInput) SetIndexId(v string) *ListDataSourceSyncJobsInput
- func (s *ListDataSourceSyncJobsInput) SetMaxResults(v int64) *ListDataSourceSyncJobsInput
- func (s *ListDataSourceSyncJobsInput) SetNextToken(v string) *ListDataSourceSyncJobsInput
- func (s *ListDataSourceSyncJobsInput) SetStartTimeFilter(v *TimeRange) *ListDataSourceSyncJobsInput
- func (s *ListDataSourceSyncJobsInput) SetStatusFilter(v string) *ListDataSourceSyncJobsInput
- func (s ListDataSourceSyncJobsInput) String() string
- func (s *ListDataSourceSyncJobsInput) Validate() error
- type ListDataSourceSyncJobsOutput
- func (s ListDataSourceSyncJobsOutput) GoString() string
- func (s *ListDataSourceSyncJobsOutput) SetHistory(v []*DataSourceSyncJob) *ListDataSourceSyncJobsOutput
- func (s *ListDataSourceSyncJobsOutput) SetNextToken(v string) *ListDataSourceSyncJobsOutput
- func (s ListDataSourceSyncJobsOutput) String() string
- type ListDataSourcesInput
- func (s ListDataSourcesInput) GoString() string
- func (s *ListDataSourcesInput) SetIndexId(v string) *ListDataSourcesInput
- func (s *ListDataSourcesInput) SetMaxResults(v int64) *ListDataSourcesInput
- func (s *ListDataSourcesInput) SetNextToken(v string) *ListDataSourcesInput
- func (s ListDataSourcesInput) String() string
- func (s *ListDataSourcesInput) Validate() error
- type ListDataSourcesOutput
- type ListFaqsInput
- func (s ListFaqsInput) GoString() string
- func (s *ListFaqsInput) SetIndexId(v string) *ListFaqsInput
- func (s *ListFaqsInput) SetMaxResults(v int64) *ListFaqsInput
- func (s *ListFaqsInput) SetNextToken(v string) *ListFaqsInput
- func (s ListFaqsInput) String() string
- func (s *ListFaqsInput) Validate() error
- type ListFaqsOutput
- type ListIndicesInput
- type ListIndicesOutput
- type Principal
- type QueryInput
- func (s QueryInput) GoString() string
- func (s *QueryInput) SetAttributeFilter(v *AttributeFilter) *QueryInput
- func (s *QueryInput) SetFacets(v []*Facet) *QueryInput
- func (s *QueryInput) SetIndexId(v string) *QueryInput
- func (s *QueryInput) SetPageNumber(v int64) *QueryInput
- func (s *QueryInput) SetPageSize(v int64) *QueryInput
- func (s *QueryInput) SetQueryResultTypeFilter(v string) *QueryInput
- func (s *QueryInput) SetQueryText(v string) *QueryInput
- func (s *QueryInput) SetRequestedDocumentAttributes(v []*string) *QueryInput
- func (s QueryInput) String() string
- func (s *QueryInput) Validate() error
- type QueryOutput
- func (s QueryOutput) GoString() string
- func (s *QueryOutput) SetFacetResults(v []*FacetResult) *QueryOutput
- func (s *QueryOutput) SetQueryId(v string) *QueryOutput
- func (s *QueryOutput) SetResultItems(v []*QueryResultItem) *QueryOutput
- func (s *QueryOutput) SetTotalNumberOfResults(v int64) *QueryOutput
- func (s QueryOutput) String() string
- type QueryResultItem
- func (s QueryResultItem) GoString() string
- func (s *QueryResultItem) SetAdditionalAttributes(v []*AdditionalResultAttribute) *QueryResultItem
- func (s *QueryResultItem) SetDocumentAttributes(v []*DocumentAttribute) *QueryResultItem
- func (s *QueryResultItem) SetDocumentExcerpt(v *TextWithHighlights) *QueryResultItem
- func (s *QueryResultItem) SetDocumentId(v string) *QueryResultItem
- func (s *QueryResultItem) SetDocumentTitle(v *TextWithHighlights) *QueryResultItem
- func (s *QueryResultItem) SetDocumentURI(v string) *QueryResultItem
- func (s *QueryResultItem) SetId(v string) *QueryResultItem
- func (s *QueryResultItem) SetType(v string) *QueryResultItem
- func (s QueryResultItem) String() string
- type Relevance
- func (s Relevance) GoString() string
- func (s *Relevance) SetDuration(v string) *Relevance
- func (s *Relevance) SetFreshness(v bool) *Relevance
- func (s *Relevance) SetImportance(v int64) *Relevance
- func (s *Relevance) SetRankOrder(v string) *Relevance
- func (s *Relevance) SetValueImportanceMap(v map[string]*int64) *Relevance
- func (s Relevance) String() string
- func (s *Relevance) Validate() error
- type RelevanceFeedback
- type ResourceAlreadyExistException
- func (s ResourceAlreadyExistException) Code() string
- func (s ResourceAlreadyExistException) Error() string
- func (s ResourceAlreadyExistException) GoString() string
- func (s ResourceAlreadyExistException) Message() string
- func (s ResourceAlreadyExistException) OrigErr() error
- func (s ResourceAlreadyExistException) RequestID() string
- func (s ResourceAlreadyExistException) StatusCode() int
- func (s ResourceAlreadyExistException) String() string
- type ResourceInUseException
- func (s ResourceInUseException) Code() string
- func (s ResourceInUseException) Error() string
- func (s ResourceInUseException) GoString() string
- func (s ResourceInUseException) Message() string
- func (s ResourceInUseException) OrigErr() error
- func (s ResourceInUseException) RequestID() string
- func (s ResourceInUseException) StatusCode() int
- func (s ResourceInUseException) String() string
- type ResourceNotFoundException
- func (s ResourceNotFoundException) Code() string
- func (s ResourceNotFoundException) Error() string
- func (s ResourceNotFoundException) GoString() string
- func (s ResourceNotFoundException) Message() string
- func (s ResourceNotFoundException) OrigErr() error
- func (s ResourceNotFoundException) RequestID() string
- func (s ResourceNotFoundException) StatusCode() int
- func (s ResourceNotFoundException) String() string
- type ResourceUnavailableException
- func (s ResourceUnavailableException) Code() string
- func (s ResourceUnavailableException) Error() string
- func (s ResourceUnavailableException) GoString() string
- func (s ResourceUnavailableException) Message() string
- func (s ResourceUnavailableException) OrigErr() error
- func (s ResourceUnavailableException) RequestID() string
- func (s ResourceUnavailableException) StatusCode() int
- func (s ResourceUnavailableException) String() string
- type S3DataSourceConfiguration
- func (s S3DataSourceConfiguration) GoString() string
- func (s *S3DataSourceConfiguration) SetAccessControlListConfiguration(v *AccessControlListConfiguration) *S3DataSourceConfiguration
- func (s *S3DataSourceConfiguration) SetBucketName(v string) *S3DataSourceConfiguration
- func (s *S3DataSourceConfiguration) SetDocumentsMetadataConfiguration(v *DocumentsMetadataConfiguration) *S3DataSourceConfiguration
- func (s *S3DataSourceConfiguration) SetExclusionPatterns(v []*string) *S3DataSourceConfiguration
- func (s *S3DataSourceConfiguration) SetInclusionPrefixes(v []*string) *S3DataSourceConfiguration
- func (s S3DataSourceConfiguration) String() string
- func (s *S3DataSourceConfiguration) Validate() error
- type S3Path
- type Search
- type ServerSideEncryptionConfiguration
- type ServiceQuotaExceededException
- func (s ServiceQuotaExceededException) Code() string
- func (s ServiceQuotaExceededException) Error() string
- func (s ServiceQuotaExceededException) GoString() string
- func (s ServiceQuotaExceededException) Message() string
- func (s ServiceQuotaExceededException) OrigErr() error
- func (s ServiceQuotaExceededException) RequestID() string
- func (s ServiceQuotaExceededException) StatusCode() int
- func (s ServiceQuotaExceededException) String() string
- type SharePointConfiguration
- func (s SharePointConfiguration) GoString() string
- func (s *SharePointConfiguration) SetCrawlAttachments(v bool) *SharePointConfiguration
- func (s *SharePointConfiguration) SetDocumentTitleFieldName(v string) *SharePointConfiguration
- func (s *SharePointConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *SharePointConfiguration
- func (s *SharePointConfiguration) SetSecretArn(v string) *SharePointConfiguration
- func (s *SharePointConfiguration) SetSharePointVersion(v string) *SharePointConfiguration
- func (s *SharePointConfiguration) SetUrls(v []*string) *SharePointConfiguration
- func (s *SharePointConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *SharePointConfiguration
- func (s SharePointConfiguration) String() string
- func (s *SharePointConfiguration) Validate() error
- type StartDataSourceSyncJobInput
- func (s StartDataSourceSyncJobInput) GoString() string
- func (s *StartDataSourceSyncJobInput) SetId(v string) *StartDataSourceSyncJobInput
- func (s *StartDataSourceSyncJobInput) SetIndexId(v string) *StartDataSourceSyncJobInput
- func (s StartDataSourceSyncJobInput) String() string
- func (s *StartDataSourceSyncJobInput) Validate() error
- type StartDataSourceSyncJobOutput
- type StopDataSourceSyncJobInput
- func (s StopDataSourceSyncJobInput) GoString() string
- func (s *StopDataSourceSyncJobInput) SetId(v string) *StopDataSourceSyncJobInput
- func (s *StopDataSourceSyncJobInput) SetIndexId(v string) *StopDataSourceSyncJobInput
- func (s StopDataSourceSyncJobInput) String() string
- func (s *StopDataSourceSyncJobInput) Validate() error
- type StopDataSourceSyncJobOutput
- type SubmitFeedbackInput
- func (s SubmitFeedbackInput) GoString() string
- func (s *SubmitFeedbackInput) SetClickFeedbackItems(v []*ClickFeedback) *SubmitFeedbackInput
- func (s *SubmitFeedbackInput) SetIndexId(v string) *SubmitFeedbackInput
- func (s *SubmitFeedbackInput) SetQueryId(v string) *SubmitFeedbackInput
- func (s *SubmitFeedbackInput) SetRelevanceFeedbackItems(v []*RelevanceFeedback) *SubmitFeedbackInput
- func (s SubmitFeedbackInput) String() string
- func (s *SubmitFeedbackInput) Validate() error
- type SubmitFeedbackOutput
- type TextDocumentStatistics
- type TextWithHighlights
- type ThrottlingException
- func (s ThrottlingException) Code() string
- func (s ThrottlingException) Error() string
- func (s ThrottlingException) GoString() string
- func (s ThrottlingException) Message() string
- func (s ThrottlingException) OrigErr() error
- func (s ThrottlingException) RequestID() string
- func (s ThrottlingException) StatusCode() int
- func (s ThrottlingException) String() string
- type TimeRange
- type UpdateDataSourceInput
- func (s UpdateDataSourceInput) GoString() string
- func (s *UpdateDataSourceInput) SetConfiguration(v *DataSourceConfiguration) *UpdateDataSourceInput
- func (s *UpdateDataSourceInput) SetDescription(v string) *UpdateDataSourceInput
- func (s *UpdateDataSourceInput) SetId(v string) *UpdateDataSourceInput
- func (s *UpdateDataSourceInput) SetIndexId(v string) *UpdateDataSourceInput
- func (s *UpdateDataSourceInput) SetName(v string) *UpdateDataSourceInput
- func (s *UpdateDataSourceInput) SetRoleArn(v string) *UpdateDataSourceInput
- func (s *UpdateDataSourceInput) SetSchedule(v string) *UpdateDataSourceInput
- func (s UpdateDataSourceInput) String() string
- func (s *UpdateDataSourceInput) Validate() error
- type UpdateDataSourceOutput
- type UpdateIndexInput
- func (s UpdateIndexInput) GoString() string
- func (s *UpdateIndexInput) SetDescription(v string) *UpdateIndexInput
- func (s *UpdateIndexInput) SetDocumentMetadataConfigurationUpdates(v []*DocumentMetadataConfiguration) *UpdateIndexInput
- func (s *UpdateIndexInput) SetId(v string) *UpdateIndexInput
- func (s *UpdateIndexInput) SetName(v string) *UpdateIndexInput
- func (s *UpdateIndexInput) SetRoleArn(v string) *UpdateIndexInput
- func (s UpdateIndexInput) String() string
- func (s *UpdateIndexInput) Validate() error
- type UpdateIndexOutput
- type ValidationException
- func (s ValidationException) Code() string
- func (s ValidationException) Error() string
- func (s ValidationException) GoString() string
- func (s ValidationException) Message() string
- func (s ValidationException) OrigErr() error
- func (s ValidationException) RequestID() string
- func (s ValidationException) StatusCode() int
- func (s ValidationException) String() string
Constants ¶
const ( // ContentTypePdf is a ContentType enum value ContentTypePdf = "PDF" // ContentTypeHtml is a ContentType enum value ContentTypeHtml = "HTML" // ContentTypeMsWord is a ContentType enum value ContentTypeMsWord = "MS_WORD" // ContentTypePlainText is a ContentType enum value ContentTypePlainText = "PLAIN_TEXT" // ContentTypePpt is a ContentType enum value ContentTypePpt = "PPT" )
const ( // DataSourceStatusCreating is a DataSourceStatus enum value DataSourceStatusCreating = "CREATING" // DataSourceStatusDeleting is a DataSourceStatus enum value DataSourceStatusDeleting = "DELETING" // DataSourceStatusFailed is a DataSourceStatus enum value DataSourceStatusFailed = "FAILED" // DataSourceStatusUpdating is a DataSourceStatus enum value DataSourceStatusUpdating = "UPDATING" // DataSourceStatusActive is a DataSourceStatus enum value DataSourceStatusActive = "ACTIVE" )
const ( // DataSourceSyncJobStatusFailed is a DataSourceSyncJobStatus enum value DataSourceSyncJobStatusFailed = "FAILED" // DataSourceSyncJobStatusSucceeded is a DataSourceSyncJobStatus enum value DataSourceSyncJobStatusSucceeded = "SUCCEEDED" // DataSourceSyncJobStatusSyncing is a DataSourceSyncJobStatus enum value DataSourceSyncJobStatusSyncing = "SYNCING" // DataSourceSyncJobStatusIncomplete is a DataSourceSyncJobStatus enum value DataSourceSyncJobStatusIncomplete = "INCOMPLETE" // DataSourceSyncJobStatusStopping is a DataSourceSyncJobStatus enum value DataSourceSyncJobStatusStopping = "STOPPING" // DataSourceSyncJobStatusAborted is a DataSourceSyncJobStatus enum value DataSourceSyncJobStatusAborted = "ABORTED" )
const ( // DataSourceTypeS3 is a DataSourceType enum value DataSourceTypeS3 = "S3" DataSourceTypeSharepoint = "SHAREPOINT" // DataSourceTypeDatabase is a DataSourceType enum value DataSourceTypeDatabase = "DATABASE" )
const ( // DatabaseEngineTypeRdsAuroraMysql is a DatabaseEngineType enum value DatabaseEngineTypeRdsAuroraMysql = "RDS_AURORA_MYSQL" // DatabaseEngineTypeRdsAuroraPostgresql is a DatabaseEngineType enum value DatabaseEngineTypeRdsAuroraPostgresql = "RDS_AURORA_POSTGRESQL" // DatabaseEngineTypeRdsMysql is a DatabaseEngineType enum value DatabaseEngineTypeRdsMysql = "RDS_MYSQL" // DatabaseEngineTypeRdsPostgresql is a DatabaseEngineType enum value DatabaseEngineTypeRdsPostgresql = "RDS_POSTGRESQL" )
const ( // DocumentAttributeValueTypeStringValue is a DocumentAttributeValueType enum value DocumentAttributeValueTypeStringValue = "STRING_VALUE" // DocumentAttributeValueTypeStringListValue is a DocumentAttributeValueType enum value DocumentAttributeValueTypeStringListValue = "STRING_LIST_VALUE" // DocumentAttributeValueTypeLongValue is a DocumentAttributeValueType enum value DocumentAttributeValueTypeLongValue = "LONG_VALUE" // DocumentAttributeValueTypeDateValue is a DocumentAttributeValueType enum value DocumentAttributeValueTypeDateValue = "DATE_VALUE" )
const ( // ErrorCodeInternalError is a ErrorCode enum value ErrorCodeInternalError = "InternalError" // ErrorCodeInvalidRequest is a ErrorCode enum value ErrorCodeInvalidRequest = "InvalidRequest" )
const ( // FaqStatusCreating is a FaqStatus enum value FaqStatusCreating = "CREATING" // FaqStatusUpdating is a FaqStatus enum value FaqStatusUpdating = "UPDATING" // FaqStatusActive is a FaqStatus enum value FaqStatusActive = "ACTIVE" // FaqStatusDeleting is a FaqStatus enum value FaqStatusDeleting = "DELETING" // FaqStatusFailed is a FaqStatus enum value FaqStatusFailed = "FAILED" )
const ( // IndexStatusCreating is a IndexStatus enum value IndexStatusCreating = "CREATING" // IndexStatusActive is a IndexStatus enum value IndexStatusActive = "ACTIVE" // IndexStatusDeleting is a IndexStatus enum value IndexStatusDeleting = "DELETING" // IndexStatusFailed is a IndexStatus enum value IndexStatusFailed = "FAILED" // IndexStatusSystemUpdating is a IndexStatus enum value IndexStatusSystemUpdating = "SYSTEM_UPDATING" )
const ( // OrderAscending is a Order enum value OrderAscending = "ASCENDING" // OrderDescending is a Order enum value OrderDescending = "DESCENDING" )
const ( // PrincipalTypeUser is a PrincipalType enum value PrincipalTypeUser = "USER" // PrincipalTypeGroup is a PrincipalType enum value PrincipalTypeGroup = "GROUP" )
const ( // QueryResultTypeDocument is a QueryResultType enum value QueryResultTypeDocument = "DOCUMENT" // QueryResultTypeQuestionAnswer is a QueryResultType enum value QueryResultTypeQuestionAnswer = "QUESTION_ANSWER" // QueryResultTypeAnswer is a QueryResultType enum value QueryResultTypeAnswer = "ANSWER" )
const ( // ReadAccessTypeAllow is a ReadAccessType enum value ReadAccessTypeAllow = "ALLOW" // ReadAccessTypeDeny is a ReadAccessType enum value ReadAccessTypeDeny = "DENY" )
const ( // RelevanceTypeRelevant is a RelevanceType enum value RelevanceTypeRelevant = "RELEVANT" // RelevanceTypeNotRelevant is a RelevanceType enum value RelevanceTypeNotRelevant = "NOT_RELEVANT" )
const ( // ErrCodeAccessDeniedException for service response error code // "AccessDeniedException". ErrCodeAccessDeniedException = "AccessDeniedException" // ErrCodeConflictException for service response error code // "ConflictException". ErrCodeConflictException = "ConflictException" // ErrCodeInternalServerException for service response error code // "InternalServerException". ErrCodeInternalServerException = "InternalServerException" // ErrCodeResourceAlreadyExistException for service response error code // "ResourceAlreadyExistException". ErrCodeResourceAlreadyExistException = "ResourceAlreadyExistException" // ErrCodeResourceInUseException for service response error code // "ResourceInUseException". ErrCodeResourceInUseException = "ResourceInUseException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". ErrCodeResourceNotFoundException = "ResourceNotFoundException" // "ResourceUnavailableException". ErrCodeResourceUnavailableException = "ResourceUnavailableException" // ErrCodeServiceQuotaExceededException for service response error code // "ServiceQuotaExceededException". ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" // ErrCodeThrottlingException for service response error code // "ThrottlingException". ErrCodeThrottlingException = "ThrottlingException" // ErrCodeValidationException for service response error code // "ValidationException". ErrCodeValidationException = "ValidationException" )
const ( ServiceName = "kendra" // Name of service. EndpointsID = ServiceName // ID to lookup a service endpoint with. ServiceID = "kendra" // ServiceID is a unique identifier of a specific service. )
Service information constants
const (
// AdditionalResultAttributeValueTypeTextWithHighlightsValue is a AdditionalResultAttributeValueType enum value
AdditionalResultAttributeValueTypeTextWithHighlightsValue = "TEXT_WITH_HIGHLIGHTS_VALUE"
)
const (
SharePointVersionSharepointOnline = "SHAREPOINT_ONLINE"
)Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessControlListConfiguration ¶
type AccessControlListConfiguration struct { // Path to the AWS S3 bucket that contains the ACL files. KeyPath *string `min:"1" type:"string"` // contains filtered or unexported fields }
Access Control List files for the documents in a data source.
func (AccessControlListConfiguration) GoString ¶
func (s AccessControlListConfiguration) GoString() string
GoString returns the string representation
func (*AccessControlListConfiguration) SetKeyPath ¶
func (s *AccessControlListConfiguration) SetKeyPath(v string) *AccessControlListConfiguration
SetKeyPath sets the KeyPath field's value.
func (AccessControlListConfiguration) String ¶
func (s AccessControlListConfiguration) String() string
String returns the string representation
func (*AccessControlListConfiguration) Validate ¶
func (s *AccessControlListConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AccessDeniedException ¶ added in v1.28.0
type AccessDeniedException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"string"` // contains filtered or unexported fields }
func (AccessDeniedException) Code ¶ added in v1.28.0
func (s AccessDeniedException) Code() string
Code returns the exception type name.
func (AccessDeniedException) Error ¶ added in v1.28.0
func (s AccessDeniedException) Error() string
func (AccessDeniedException) GoString ¶ added in v1.28.0
func (s AccessDeniedException) GoString() string
GoString returns the string representation
func (AccessDeniedException) Message ¶ added in v1.28.0
func (s AccessDeniedException) Message() string
Message returns the exception's message.
func (AccessDeniedException) OrigErr ¶ added in v1.28.0
func (s AccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (AccessDeniedException) RequestID ¶ added in v1.28.0
func (s AccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (AccessDeniedException) StatusCode ¶ added in v1.28.0
func (s AccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (AccessDeniedException) String ¶ added in v1.28.0
func (s AccessDeniedException) String() string
String returns the string representation
type AclConfiguration ¶
type AclConfiguration struct { // A list of groups, separated by semi-colons, that filters a query response // based on user context. The document is only returned to users that are in // one of the groups specified in the UserContext field of the Query operation. // // AllowedGroupsColumnName is a required field AllowedGroupsColumnName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Provides information about the column that should be used for filtering the query response by groups.
func (AclConfiguration) GoString ¶
func (s AclConfiguration) GoString() string
GoString returns the string representation
func (*AclConfiguration) SetAllowedGroupsColumnName ¶
func (s *AclConfiguration) SetAllowedGroupsColumnName(v string) *AclConfiguration
SetAllowedGroupsColumnName sets the AllowedGroupsColumnName field's value.
func (AclConfiguration) String ¶
func (s AclConfiguration) String() string
String returns the string representation
func (*AclConfiguration) Validate ¶
func (s *AclConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdditionalResultAttribute ¶
type AdditionalResultAttribute struct { // Key is a required field Key *string `min:"1" type:"string" required:"true"` // An attribute returned with a document from a search. // // Value is a required field Value *AdditionalResultAttributeValue `type:"structure" required:"true"` // ValueType is a required field ValueType *string `type:"string" required:"true" enum:"AdditionalResultAttributeValueType"` // contains filtered or unexported fields }
func (AdditionalResultAttribute) GoString ¶
func (s AdditionalResultAttribute) GoString() string
GoString returns the string representation
func (*AdditionalResultAttribute) SetKey ¶
func (s *AdditionalResultAttribute) SetKey(v string) *AdditionalResultAttribute
SetKey sets the Key field's value.
func (*AdditionalResultAttribute) SetValue ¶
func (s *AdditionalResultAttribute) SetValue(v *AdditionalResultAttributeValue) *AdditionalResultAttribute
SetValue sets the Value field's value.
func (*AdditionalResultAttribute) SetValueType ¶
func (s *AdditionalResultAttribute) SetValueType(v string) *AdditionalResultAttribute
SetValueType sets the ValueType field's value.
func (AdditionalResultAttribute) String ¶
func (s AdditionalResultAttribute) String() string
String returns the string representation
type AdditionalResultAttributeValue ¶
type AdditionalResultAttributeValue struct { // The text associated with the attribute and information about the highlight // to apply to the text. TextWithHighlightsValue *TextWithHighlights `type:"structure"` // contains filtered or unexported fields }
An attribute returned with a document from a search.
func (AdditionalResultAttributeValue) GoString ¶
func (s AdditionalResultAttributeValue) GoString() string
GoString returns the string representation
func (*AdditionalResultAttributeValue) SetTextWithHighlightsValue ¶
func (s *AdditionalResultAttributeValue) SetTextWithHighlightsValue(v *TextWithHighlights) *AdditionalResultAttributeValue
SetTextWithHighlightsValue sets the TextWithHighlightsValue field's value.
func (AdditionalResultAttributeValue) String ¶
func (s AdditionalResultAttributeValue) String() string
String returns the string representation
type AttributeFilter ¶
type AttributeFilter struct { // Performs a logical AND operation on all supplied filters. AndAllFilters []*AttributeFilter `min:"1" type:"list"` // Returns true when a document contains all of the specified document attributes. ContainsAll *DocumentAttribute `type:"structure"` // Returns true when a document contains any of the specified document attributes. ContainsAny *DocumentAttribute `type:"structure"` // Performs an equals operation on two document attributes. EqualsTo *DocumentAttribute `type:"structure"` // Performs a greater than operation on two document attributes. Use with a // document attribute of type Integer or Long. GreaterThan *DocumentAttribute `type:"structure"` // Performs a greater or equals than operation on two document attributes. Use // with a document attribute of type Integer or Long. GreaterThanOrEquals *DocumentAttribute `type:"structure"` // Performs a less than operation on two document attributes. Use with a document // attribute of type Integer or Long. LessThan *DocumentAttribute `type:"structure"` // Performs a less than or equals operation on two document attributes. Use // with a document attribute of type Integer or Long. LessThanOrEquals *DocumentAttribute `type:"structure"` // Performs a logical NOT operation on all supplied filters. NotFilter *AttributeFilter `type:"structure"` // Performs a logical OR operation on all supplied filters. OrAllFilters []*AttributeFilter `min:"1" type:"list"` // contains filtered or unexported fields }
Provides filtering the query results based on document attributes.
func (AttributeFilter) GoString ¶
func (s AttributeFilter) GoString() string
GoString returns the string representation
func (*AttributeFilter) SetAndAllFilters ¶
func (s *AttributeFilter) SetAndAllFilters(v []*AttributeFilter) *AttributeFilter
SetAndAllFilters sets the AndAllFilters field's value.
func (*AttributeFilter) SetContainsAll ¶
func (s *AttributeFilter) SetContainsAll(v *DocumentAttribute) *AttributeFilter
SetContainsAll sets the ContainsAll field's value.
func (*AttributeFilter) SetContainsAny ¶
func (s *AttributeFilter) SetContainsAny(v *DocumentAttribute) *AttributeFilter
SetContainsAny sets the ContainsAny field's value.
func (*AttributeFilter) SetEqualsTo ¶
func (s *AttributeFilter) SetEqualsTo(v *DocumentAttribute) *AttributeFilter
SetEqualsTo sets the EqualsTo field's value.
func (*AttributeFilter) SetGreaterThan ¶
func (s *AttributeFilter) SetGreaterThan(v *DocumentAttribute) *AttributeFilter
SetGreaterThan sets the GreaterThan field's value.
func (*AttributeFilter) SetGreaterThanOrEquals ¶
func (s *AttributeFilter) SetGreaterThanOrEquals(v *DocumentAttribute) *AttributeFilter
SetGreaterThanOrEquals sets the GreaterThanOrEquals field's value.
func (*AttributeFilter) SetLessThan ¶
func (s *AttributeFilter) SetLessThan(v *DocumentAttribute) *AttributeFilter
SetLessThan sets the LessThan field's value.
func (*AttributeFilter) SetLessThanOrEquals ¶
func (s *AttributeFilter) SetLessThanOrEquals(v *DocumentAttribute) *AttributeFilter
SetLessThanOrEquals sets the LessThanOrEquals field's value.
func (*AttributeFilter) SetNotFilter ¶
func (s *AttributeFilter) SetNotFilter(v *AttributeFilter) *AttributeFilter
SetNotFilter sets the NotFilter field's value.
func (*AttributeFilter) SetOrAllFilters ¶
func (s *AttributeFilter) SetOrAllFilters(v []*AttributeFilter) *AttributeFilter
SetOrAllFilters sets the OrAllFilters field's value.
func (AttributeFilter) String ¶
func (s AttributeFilter) String() string
String returns the string representation
func (*AttributeFilter) Validate ¶
func (s *AttributeFilter) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchDeleteDocumentInput ¶
type BatchDeleteDocumentInput struct { // One or more identifiers for documents to delete from the index. // // DocumentIdList is a required field DocumentIdList []*string `min:"1" type:"list" required:"true"` // The identifier of the index that contains the documents to delete. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (BatchDeleteDocumentInput) GoString ¶
func (s BatchDeleteDocumentInput) GoString() string
GoString returns the string representation
func (*BatchDeleteDocumentInput) SetDocumentIdList ¶
func (s *BatchDeleteDocumentInput) SetDocumentIdList(v []*string) *BatchDeleteDocumentInput
SetDocumentIdList sets the DocumentIdList field's value.
func (*BatchDeleteDocumentInput) SetIndexId ¶
func (s *BatchDeleteDocumentInput) SetIndexId(v string) *BatchDeleteDocumentInput
SetIndexId sets the IndexId field's value.
func (BatchDeleteDocumentInput) String ¶
func (s BatchDeleteDocumentInput) String() string
String returns the string representation
func (*BatchDeleteDocumentInput) Validate ¶
func (s *BatchDeleteDocumentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchDeleteDocumentOutput ¶
type BatchDeleteDocumentOutput struct { // A list of documents that could not be removed from the index. Each entry // contains an error message that indicates why the document couldn't be removed // from the index. FailedDocuments []*BatchDeleteDocumentResponseFailedDocument `type:"list"` // contains filtered or unexported fields }
func (BatchDeleteDocumentOutput) GoString ¶
func (s BatchDeleteDocumentOutput) GoString() string
GoString returns the string representation
func (*BatchDeleteDocumentOutput) SetFailedDocuments ¶
func (s *BatchDeleteDocumentOutput) SetFailedDocuments(v []*BatchDeleteDocumentResponseFailedDocument) *BatchDeleteDocumentOutput
SetFailedDocuments sets the FailedDocuments field's value.
func (BatchDeleteDocumentOutput) String ¶
func (s BatchDeleteDocumentOutput) String() string
String returns the string representation
type BatchDeleteDocumentResponseFailedDocument ¶
type BatchDeleteDocumentResponseFailedDocument struct { // The error code for why the document couldn't be removed from the index. ErrorCode *string `type:"string" enum:"ErrorCode"` // An explanation for why the document couldn't be removed from the index. ErrorMessage *string `min:"1" type:"string"` // The identifier of the document that couldn't be removed from the index. Id *string `min:"1" type:"string"` // contains filtered or unexported fields }
Provides information about documents that could not be removed from an index by the BatchDeleteDocument operation.
func (BatchDeleteDocumentResponseFailedDocument) GoString ¶
func (s BatchDeleteDocumentResponseFailedDocument) GoString() string
GoString returns the string representation
func (*BatchDeleteDocumentResponseFailedDocument) SetErrorCode ¶
func (s *BatchDeleteDocumentResponseFailedDocument) SetErrorCode(v string) *BatchDeleteDocumentResponseFailedDocument
SetErrorCode sets the ErrorCode field's value.
func (*BatchDeleteDocumentResponseFailedDocument) SetErrorMessage ¶
func (s *BatchDeleteDocumentResponseFailedDocument) SetErrorMessage(v string) *BatchDeleteDocumentResponseFailedDocument
SetErrorMessage sets the ErrorMessage field's value.
func (*BatchDeleteDocumentResponseFailedDocument) SetId ¶
func (s *BatchDeleteDocumentResponseFailedDocument) SetId(v string) *BatchDeleteDocumentResponseFailedDocument
SetId sets the Id field's value.
func (BatchDeleteDocumentResponseFailedDocument) String ¶
func (s BatchDeleteDocumentResponseFailedDocument) String() string
String returns the string representation
type BatchPutDocumentInput ¶
type BatchPutDocumentInput struct { // One or more documents to add to the index. // // Each document is limited to 5 Mb, the total size of the list is limited to // 50 Mb. // // Documents is a required field Documents []*Document `min:"1" type:"list" required:"true"` // The identifier of the index to add the documents to. You need to create the // index first using the CreateIndex operation. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` // The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument // operation. For more information, see IAM Roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). RoleArn *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (BatchPutDocumentInput) GoString ¶
func (s BatchPutDocumentInput) GoString() string
GoString returns the string representation
func (*BatchPutDocumentInput) SetDocuments ¶
func (s *BatchPutDocumentInput) SetDocuments(v []*Document) *BatchPutDocumentInput
SetDocuments sets the Documents field's value.
func (*BatchPutDocumentInput) SetIndexId ¶
func (s *BatchPutDocumentInput) SetIndexId(v string) *BatchPutDocumentInput
SetIndexId sets the IndexId field's value.
func (*BatchPutDocumentInput) SetRoleArn ¶
func (s *BatchPutDocumentInput) SetRoleArn(v string) *BatchPutDocumentInput
SetRoleArn sets the RoleArn field's value.
func (BatchPutDocumentInput) String ¶
func (s BatchPutDocumentInput) String() string
String returns the string representation
func (*BatchPutDocumentInput) Validate ¶
func (s *BatchPutDocumentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchPutDocumentOutput ¶
type BatchPutDocumentOutput struct { // A list of documents that were not added to the index because the document // failed a validation check. Each document contains an error message that indicates // why the document couldn't be added to the index. // // If there was an error adding a document to an index the error is reported // in your AWS CloudWatch log. FailedDocuments []*BatchPutDocumentResponseFailedDocument `type:"list"` // contains filtered or unexported fields }
func (BatchPutDocumentOutput) GoString ¶
func (s BatchPutDocumentOutput) GoString() string
GoString returns the string representation
func (*BatchPutDocumentOutput) SetFailedDocuments ¶
func (s *BatchPutDocumentOutput) SetFailedDocuments(v []*BatchPutDocumentResponseFailedDocument) *BatchPutDocumentOutput
SetFailedDocuments sets the FailedDocuments field's value.
func (BatchPutDocumentOutput) String ¶
func (s BatchPutDocumentOutput) String() string
String returns the string representation
type BatchPutDocumentResponseFailedDocument ¶
type BatchPutDocumentResponseFailedDocument struct { // The type of error that caused the document to fail to be indexed. ErrorCode *string `type:"string" enum:"ErrorCode"` // A description of the reason why the document could not be indexed. ErrorMessage *string `min:"1" type:"string"` // The unique identifier of the document. Id *string `min:"1" type:"string"` // contains filtered or unexported fields }
Provides information about a document that could not be indexed.
func (BatchPutDocumentResponseFailedDocument) GoString ¶
func (s BatchPutDocumentResponseFailedDocument) GoString() string
GoString returns the string representation
func (*BatchPutDocumentResponseFailedDocument) SetErrorCode ¶
func (s *BatchPutDocumentResponseFailedDocument) SetErrorCode(v string) *BatchPutDocumentResponseFailedDocument
SetErrorCode sets the ErrorCode field's value.
func (*BatchPutDocumentResponseFailedDocument) SetErrorMessage ¶
func (s *BatchPutDocumentResponseFailedDocument) SetErrorMessage(v string) *BatchPutDocumentResponseFailedDocument
SetErrorMessage sets the ErrorMessage field's value.
func (*BatchPutDocumentResponseFailedDocument) SetId ¶
func (s *BatchPutDocumentResponseFailedDocument) SetId(v string) *BatchPutDocumentResponseFailedDocument
SetId sets the Id field's value.
func (BatchPutDocumentResponseFailedDocument) String ¶
func (s BatchPutDocumentResponseFailedDocument) String() string
String returns the string representation
type ClickFeedback ¶
type ClickFeedback struct { // The Unix timestamp of the data and time that the result was clicked. // // ClickTime is a required field ClickTime *time.Time `type:"timestamp" required:"true"` // The unique identifier of the search result that was clicked. // // ResultId is a required field ResultId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Gathers information about when a particular result was clicked by a user. Your application uses the SubmitFeedback operation to provide click information.
func (ClickFeedback) GoString ¶
func (s ClickFeedback) GoString() string
GoString returns the string representation
func (*ClickFeedback) SetClickTime ¶
func (s *ClickFeedback) SetClickTime(v time.Time) *ClickFeedback
SetClickTime sets the ClickTime field's value.
func (*ClickFeedback) SetResultId ¶
func (s *ClickFeedback) SetResultId(v string) *ClickFeedback
SetResultId sets the ResultId field's value.
func (ClickFeedback) String ¶
func (s ClickFeedback) String() string
String returns the string representation
func (*ClickFeedback) Validate ¶
func (s *ClickFeedback) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ColumnConfiguration ¶
type ColumnConfiguration struct { // One to five columns that indicate when a document in the database has changed. // // ChangeDetectingColumns is a required field ChangeDetectingColumns []*string `min:"1" type:"list" required:"true"` // The column that contains the contents of the document. // // DocumentDataColumnName is a required field DocumentDataColumnName *string `min:"1" type:"string" required:"true"` // The column that provides the document's unique identifier. // // DocumentIdColumnName is a required field DocumentIdColumnName *string `min:"1" type:"string" required:"true"` // The column that contains the title of the document. DocumentTitleColumnName *string `min:"1" type:"string"` // An array of objects that map database column names to the corresponding fields // in an index. You must first create the fields in the index using the UpdateIndex // operation. FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"` // contains filtered or unexported fields }
Provides information about how Amazon Kendra should use the columns of a database in an index.
func (ColumnConfiguration) GoString ¶
func (s ColumnConfiguration) GoString() string
GoString returns the string representation
func (*ColumnConfiguration) SetChangeDetectingColumns ¶
func (s *ColumnConfiguration) SetChangeDetectingColumns(v []*string) *ColumnConfiguration
SetChangeDetectingColumns sets the ChangeDetectingColumns field's value.
func (*ColumnConfiguration) SetDocumentDataColumnName ¶
func (s *ColumnConfiguration) SetDocumentDataColumnName(v string) *ColumnConfiguration
SetDocumentDataColumnName sets the DocumentDataColumnName field's value.
func (*ColumnConfiguration) SetDocumentIdColumnName ¶
func (s *ColumnConfiguration) SetDocumentIdColumnName(v string) *ColumnConfiguration
SetDocumentIdColumnName sets the DocumentIdColumnName field's value.
func (*ColumnConfiguration) SetDocumentTitleColumnName ¶
func (s *ColumnConfiguration) SetDocumentTitleColumnName(v string) *ColumnConfiguration
SetDocumentTitleColumnName sets the DocumentTitleColumnName field's value.
func (*ColumnConfiguration) SetFieldMappings ¶
func (s *ColumnConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *ColumnConfiguration
SetFieldMappings sets the FieldMappings field's value.
func (ColumnConfiguration) String ¶
func (s ColumnConfiguration) String() string
String returns the string representation
func (*ColumnConfiguration) Validate ¶
func (s *ColumnConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ConflictException ¶ added in v1.28.0
type ConflictException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"string"` // contains filtered or unexported fields }
func (ConflictException) Code ¶ added in v1.28.0
func (s ConflictException) Code() string
Code returns the exception type name.
func (ConflictException) Error ¶ added in v1.28.0
func (s ConflictException) Error() string
func (ConflictException) GoString ¶ added in v1.28.0
func (s ConflictException) GoString() string
GoString returns the string representation
func (ConflictException) Message ¶ added in v1.28.0
func (s ConflictException) Message() string
Message returns the exception's message.
func (ConflictException) OrigErr ¶ added in v1.28.0
func (s ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (ConflictException) RequestID ¶ added in v1.28.0
func (s ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (ConflictException) StatusCode ¶ added in v1.28.0
func (s ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ConflictException) String ¶ added in v1.28.0
func (s ConflictException) String() string
String returns the string representation
type ConnectionConfiguration ¶
type ConnectionConfiguration struct { // The name of the host for the database. Can be either a string (host.subdomain.domain.tld) // or an IPv4 or IPv6 address. // // DatabaseHost is a required field DatabaseHost *string `min:"1" type:"string" required:"true"` // The name of the database containing the document data. // // DatabaseName is a required field DatabaseName *string `min:"1" type:"string" required:"true"` // The port that the database uses for connections. // // DatabasePort is a required field DatabasePort *int64 `min:"1" type:"integer" required:"true"` // The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. // The credentials should be a user/password pair. For more information, see // Using a Database Data Source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html). // For more information about AWS Secrets Manager, see What Is AWS Secrets Manager // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) // in the AWS Secrets Manager user guide. // // SecretArn is a required field SecretArn *string `min:"1" type:"string" required:"true"` // The name of the table that contains the document data. // // TableName is a required field TableName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Provides the information necessary to connect to a database.
func (ConnectionConfiguration) GoString ¶
func (s ConnectionConfiguration) GoString() string
GoString returns the string representation
func (*ConnectionConfiguration) SetDatabaseHost ¶
func (s *ConnectionConfiguration) SetDatabaseHost(v string) *ConnectionConfiguration
SetDatabaseHost sets the DatabaseHost field's value.
func (*ConnectionConfiguration) SetDatabaseName ¶
func (s *ConnectionConfiguration) SetDatabaseName(v string) *ConnectionConfiguration
SetDatabaseName sets the DatabaseName field's value.
func (*ConnectionConfiguration) SetDatabasePort ¶
func (s *ConnectionConfiguration) SetDatabasePort(v int64) *ConnectionConfiguration
SetDatabasePort sets the DatabasePort field's value.
func (*ConnectionConfiguration) SetSecretArn ¶
func (s *ConnectionConfiguration) SetSecretArn(v string) *ConnectionConfiguration
SetSecretArn sets the SecretArn field's value.
func (*ConnectionConfiguration) SetTableName ¶
func (s *ConnectionConfiguration) SetTableName(v string) *ConnectionConfiguration
SetTableName sets the TableName field's value.
func (ConnectionConfiguration) String ¶
func (s ConnectionConfiguration) String() string
String returns the string representation
func (*ConnectionConfiguration) Validate ¶
func (s *ConnectionConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDataSourceInput ¶
type CreateDataSourceInput struct { // The connector configuration information that is required to access the repository. // // Configuration is a required field Configuration *DataSourceConfiguration `type:"structure" required:"true"` // A description for the data source. Description *string `min:"1" type:"string"` // The identifier of the index that should be associated with this data source. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` // A unique name for the data source. A data source name can't be changed without // deleting and recreating the data source. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // The Amazon Resource Name (ARN) of a role with permission to access the data // source. For more information, see IAM Roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). // // RoleArn is a required field RoleArn *string `min:"1" type:"string" required:"true"` // Sets the frequency that Amazon Kendra will check the documents in your repository // and update the index. If you don't set a schedule Amazon Kendra will not // periodically update the index. You can call the StartDataSourceSyncJob operation // to update the index. Schedule *string `type:"string"` // The type of repository that contains the data source. // // Type is a required field Type *string `type:"string" required:"true" enum:"DataSourceType"` // contains filtered or unexported fields }
func (CreateDataSourceInput) GoString ¶
func (s CreateDataSourceInput) GoString() string
GoString returns the string representation
func (*CreateDataSourceInput) SetConfiguration ¶
func (s *CreateDataSourceInput) SetConfiguration(v *DataSourceConfiguration) *CreateDataSourceInput
SetConfiguration sets the Configuration field's value.
func (*CreateDataSourceInput) SetDescription ¶
func (s *CreateDataSourceInput) SetDescription(v string) *CreateDataSourceInput
SetDescription sets the Description field's value.
func (*CreateDataSourceInput) SetIndexId ¶
func (s *CreateDataSourceInput) SetIndexId(v string) *CreateDataSourceInput
SetIndexId sets the IndexId field's value.
func (*CreateDataSourceInput) SetName ¶
func (s *CreateDataSourceInput) SetName(v string) *CreateDataSourceInput
SetName sets the Name field's value.
func (*CreateDataSourceInput) SetRoleArn ¶
func (s *CreateDataSourceInput) SetRoleArn(v string) *CreateDataSourceInput
SetRoleArn sets the RoleArn field's value.
func (*CreateDataSourceInput) SetSchedule ¶
func (s *CreateDataSourceInput) SetSchedule(v string) *CreateDataSourceInput
SetSchedule sets the Schedule field's value.
func (*CreateDataSourceInput) SetType ¶
func (s *CreateDataSourceInput) SetType(v string) *CreateDataSourceInput
SetType sets the Type field's value.
func (CreateDataSourceInput) String ¶
func (s CreateDataSourceInput) String() string
String returns the string representation
func (*CreateDataSourceInput) Validate ¶
func (s *CreateDataSourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDataSourceOutput ¶
type CreateDataSourceOutput struct { // A unique identifier for the data source. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (CreateDataSourceOutput) GoString ¶
func (s CreateDataSourceOutput) GoString() string
GoString returns the string representation
func (*CreateDataSourceOutput) SetId ¶
func (s *CreateDataSourceOutput) SetId(v string) *CreateDataSourceOutput
SetId sets the Id field's value.
func (CreateDataSourceOutput) String ¶
func (s CreateDataSourceOutput) String() string
String returns the string representation
type CreateFaqInput ¶
type CreateFaqInput struct { // A description of the FAQ. Description *string `min:"1" type:"string"` // The identifier of the index that contains the FAQ. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` // The name that should be associated with the FAQ. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // The Amazon Resource Name (ARN) of a role with permission to access the S3 // bucket that contains the FAQs. For more information, see IAM Roles for Amazon // Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). // // RoleArn is a required field RoleArn *string `min:"1" type:"string" required:"true"` // The S3 location of the FAQ input data. // // S3Path is a required field S3Path *S3Path `type:"structure" required:"true"` // contains filtered or unexported fields }
func (CreateFaqInput) GoString ¶
func (s CreateFaqInput) GoString() string
GoString returns the string representation
func (*CreateFaqInput) SetDescription ¶
func (s *CreateFaqInput) SetDescription(v string) *CreateFaqInput
SetDescription sets the Description field's value.
func (*CreateFaqInput) SetIndexId ¶
func (s *CreateFaqInput) SetIndexId(v string) *CreateFaqInput
SetIndexId sets the IndexId field's value.
func (*CreateFaqInput) SetName ¶
func (s *CreateFaqInput) SetName(v string) *CreateFaqInput
SetName sets the Name field's value.
func (*CreateFaqInput) SetRoleArn ¶
func (s *CreateFaqInput) SetRoleArn(v string) *CreateFaqInput
SetRoleArn sets the RoleArn field's value.
func (*CreateFaqInput) SetS3Path ¶
func (s *CreateFaqInput) SetS3Path(v *S3Path) *CreateFaqInput
SetS3Path sets the S3Path field's value.
func (CreateFaqInput) String ¶
func (s CreateFaqInput) String() string
String returns the string representation
func (*CreateFaqInput) Validate ¶
func (s *CreateFaqInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateFaqOutput ¶
type CreateFaqOutput struct { // The unique identifier of the FAQ. Id *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (CreateFaqOutput) GoString ¶
func (s CreateFaqOutput) GoString() string
GoString returns the string representation
func (*CreateFaqOutput) SetId ¶
func (s *CreateFaqOutput) SetId(v string) *CreateFaqOutput
SetId sets the Id field's value.
func (CreateFaqOutput) String ¶
func (s CreateFaqOutput) String() string
String returns the string representation
type CreateIndexInput ¶
type CreateIndexInput struct { // A description for the index. Description *string `min:"1" type:"string"` // The name for the new index. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch // logs and metrics. This is also the role used when you use the BatchPutDocument // operation to index documents from an Amazon S3 bucket. // // RoleArn is a required field RoleArn *string `min:"1" type:"string" required:"true"` // The identifier of the AWS KMS customer managed key (CMK) to use to encrypt // data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"` // contains filtered or unexported fields }
func (CreateIndexInput) GoString ¶
func (s CreateIndexInput) GoString() string
GoString returns the string representation
func (*CreateIndexInput) SetDescription ¶
func (s *CreateIndexInput) SetDescription(v string) *CreateIndexInput
SetDescription sets the Description field's value.
func (*CreateIndexInput) SetName ¶
func (s *CreateIndexInput) SetName(v string) *CreateIndexInput
SetName sets the Name field's value.
func (*CreateIndexInput) SetRoleArn ¶
func (s *CreateIndexInput) SetRoleArn(v string) *CreateIndexInput
SetRoleArn sets the RoleArn field's value.
func (*CreateIndexInput) SetServerSideEncryptionConfiguration ¶
func (s *CreateIndexInput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *CreateIndexInput
SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.
func (CreateIndexInput) String ¶
func (s CreateIndexInput) String() string
String returns the string representation
func (*CreateIndexInput) Validate ¶
func (s *CreateIndexInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateIndexOutput ¶
type CreateIndexOutput struct { // The unique identifier of the index. Use this identifier when you query an // index, set up a data source, or index a document. Id *string `min:"36" type:"string"` // contains filtered or unexported fields }
func (CreateIndexOutput) GoString ¶
func (s CreateIndexOutput) GoString() string
GoString returns the string representation
func (*CreateIndexOutput) SetId ¶
func (s *CreateIndexOutput) SetId(v string) *CreateIndexOutput
SetId sets the Id field's value.
func (CreateIndexOutput) String ¶
func (s CreateIndexOutput) String() string
String returns the string representation
type DataSourceConfiguration ¶
type DataSourceConfiguration struct { // Provides information necessary to create a connector for a database. DatabaseConfiguration *DatabaseConfiguration `type:"structure"` // Provides information to create a connector for a document repository in an // Amazon S3 bucket. S3Configuration *S3DataSourceConfiguration `type:"structure"` // site. SharePointConfiguration *SharePointConfiguration `type:"structure"` // contains filtered or unexported fields }
Configuration information for a Amazon Kendra data source.
func (DataSourceConfiguration) GoString ¶
func (s DataSourceConfiguration) GoString() string
GoString returns the string representation
func (*DataSourceConfiguration) SetDatabaseConfiguration ¶
func (s *DataSourceConfiguration) SetDatabaseConfiguration(v *DatabaseConfiguration) *DataSourceConfiguration
SetDatabaseConfiguration sets the DatabaseConfiguration field's value.
func (*DataSourceConfiguration) SetS3Configuration ¶
func (s *DataSourceConfiguration) SetS3Configuration(v *S3DataSourceConfiguration) *DataSourceConfiguration
SetS3Configuration sets the S3Configuration field's value.
func (*DataSourceConfiguration) SetSharePointConfiguration ¶
func (s *DataSourceConfiguration) SetSharePointConfiguration(v *SharePointConfiguration) *DataSourceConfiguration
SetSharePointConfiguration sets the SharePointConfiguration field's value.
func (DataSourceConfiguration) String ¶
func (s DataSourceConfiguration) String() string
String returns the string representation
func (*DataSourceConfiguration) Validate ¶
func (s *DataSourceConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DataSourceSummary ¶
type DataSourceSummary struct { // The UNIX datetime that the data source was created. CreatedAt *time.Time `type:"timestamp"` // The unique identifier for the data source. Id *string `min:"1" type:"string"` // The name of the data source. Name *string `min:"1" type:"string"` // The status of the data source. When the status is ATIVE the data source is // ready to use. Status *string `type:"string" enum:"DataSourceStatus"` // The type of the data source. Type *string `type:"string" enum:"DataSourceType"` // The UNIX datetime that the data source was lasted updated. UpdatedAt *time.Time `type:"timestamp"` // contains filtered or unexported fields }
Summary information for a Amazon Kendra data source. Returned in a call to .
func (DataSourceSummary) GoString ¶
func (s DataSourceSummary) GoString() string
GoString returns the string representation
func (*DataSourceSummary) SetCreatedAt ¶
func (s *DataSourceSummary) SetCreatedAt(v time.Time) *DataSourceSummary
SetCreatedAt sets the CreatedAt field's value.
func (*DataSourceSummary) SetId ¶
func (s *DataSourceSummary) SetId(v string) *DataSourceSummary
SetId sets the Id field's value.
func (*DataSourceSummary) SetName ¶
func (s *DataSourceSummary) SetName(v string) *DataSourceSummary
SetName sets the Name field's value.
func (*DataSourceSummary) SetStatus ¶
func (s *DataSourceSummary) SetStatus(v string) *DataSourceSummary
SetStatus sets the Status field's value.
func (*DataSourceSummary) SetType ¶
func (s *DataSourceSummary) SetType(v string) *DataSourceSummary
SetType sets the Type field's value.
func (*DataSourceSummary) SetUpdatedAt ¶
func (s *DataSourceSummary) SetUpdatedAt(v time.Time) *DataSourceSummary
SetUpdatedAt sets the UpdatedAt field's value.
func (DataSourceSummary) String ¶
func (s DataSourceSummary) String() string
String returns the string representation
type DataSourceSyncJob ¶
type DataSourceSyncJob struct { // If the reason that the synchronization failed is due to an error with the // underlying data source, this field contains a code that identifies the error. DataSourceErrorCode *string `min:"1" type:"string"` // The UNIX datetime that the synchronization job was completed. EndTime *time.Time `type:"timestamp"` // If the Status field is set to FAILED, the ErrorCode field contains a the // reason that the synchronization failed. ErrorCode *string `type:"string" enum:"ErrorCode"` // If the Status field is set to ERROR, the ErrorMessage field contains a description // of the error that caused the synchronization to fail. ErrorMessage *string `min:"1" type:"string"` // A unique identifier for the synchronization job. ExecutionId *string `min:"1" type:"string"` // The UNIX datetime that the synchronization job was started. StartTime *time.Time `type:"timestamp"` // The execution status of the synchronization job. When the Status field is // set to SUCCEEDED, the synchronization job is done. If the status code is // set to FAILED, the ErrorCode and ErrorMessage fields give you the reason // for the failure. Status *string `type:"string" enum:"DataSourceSyncJobStatus"` // contains filtered or unexported fields }
Provides information about a synchronization job.
func (DataSourceSyncJob) GoString ¶
func (s DataSourceSyncJob) GoString() string
GoString returns the string representation
func (*DataSourceSyncJob) SetDataSourceErrorCode ¶
func (s *DataSourceSyncJob) SetDataSourceErrorCode(v string) *DataSourceSyncJob
SetDataSourceErrorCode sets the DataSourceErrorCode field's value.
func (*DataSourceSyncJob) SetEndTime ¶
func (s *DataSourceSyncJob) SetEndTime(v time.Time) *DataSourceSyncJob
SetEndTime sets the EndTime field's value.
func (*DataSourceSyncJob) SetErrorCode ¶
func (s *DataSourceSyncJob) SetErrorCode(v string) *DataSourceSyncJob
SetErrorCode sets the ErrorCode field's value.
func (*DataSourceSyncJob) SetErrorMessage ¶
func (s *DataSourceSyncJob) SetErrorMessage(v string) *DataSourceSyncJob
SetErrorMessage sets the ErrorMessage field's value.
func (*DataSourceSyncJob) SetExecutionId ¶
func (s *DataSourceSyncJob) SetExecutionId(v string) *DataSourceSyncJob
SetExecutionId sets the ExecutionId field's value.
func (*DataSourceSyncJob) SetStartTime ¶
func (s *DataSourceSyncJob) SetStartTime(v time.Time) *DataSourceSyncJob
SetStartTime sets the StartTime field's value.
func (*DataSourceSyncJob) SetStatus ¶
func (s *DataSourceSyncJob) SetStatus(v string) *DataSourceSyncJob
SetStatus sets the Status field's value.
func (DataSourceSyncJob) String ¶
func (s DataSourceSyncJob) String() string
String returns the string representation
type DataSourceToIndexFieldMapping ¶
type DataSourceToIndexFieldMapping struct { // The name of the column or attribute in the data source. // // DataSourceFieldName is a required field DataSourceFieldName *string `min:"1" type:"string" required:"true"` // The type of data stored in the column or attribute. DateFieldFormat *string `min:"4" type:"string"` // The name of the field in the index. // // IndexFieldName is a required field IndexFieldName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.
func (DataSourceToIndexFieldMapping) GoString ¶
func (s DataSourceToIndexFieldMapping) GoString() string
GoString returns the string representation
func (*DataSourceToIndexFieldMapping) SetDataSourceFieldName ¶
func (s *DataSourceToIndexFieldMapping) SetDataSourceFieldName(v string) *DataSourceToIndexFieldMapping
SetDataSourceFieldName sets the DataSourceFieldName field's value.
func (*DataSourceToIndexFieldMapping) SetDateFieldFormat ¶
func (s *DataSourceToIndexFieldMapping) SetDateFieldFormat(v string) *DataSourceToIndexFieldMapping
SetDateFieldFormat sets the DateFieldFormat field's value.
func (*DataSourceToIndexFieldMapping) SetIndexFieldName ¶
func (s *DataSourceToIndexFieldMapping) SetIndexFieldName(v string) *DataSourceToIndexFieldMapping
SetIndexFieldName sets the IndexFieldName field's value.
func (DataSourceToIndexFieldMapping) String ¶
func (s DataSourceToIndexFieldMapping) String() string
String returns the string representation
func (*DataSourceToIndexFieldMapping) Validate ¶
func (s *DataSourceToIndexFieldMapping) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DataSourceVpcConfiguration ¶
type DataSourceVpcConfiguration struct { // A list of identifiers of security groups within your Amazon VPC. The security // groups should enable Amazon Kendra to connect to the data source. // // SecurityGroupIds is a required field SecurityGroupIds []*string `min:"1" type:"list" required:"true"` // A list of identifiers for subnets within your Amazon VPC. The subnets should // be able to connect to each other in the VPC, and they should have outgoing // access to the Internet through a NAT device. // // SubnetIds is a required field SubnetIds []*string `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
Provides information for connecting to an Amazon VPC.
func (DataSourceVpcConfiguration) GoString ¶
func (s DataSourceVpcConfiguration) GoString() string
GoString returns the string representation
func (*DataSourceVpcConfiguration) SetSecurityGroupIds ¶
func (s *DataSourceVpcConfiguration) SetSecurityGroupIds(v []*string) *DataSourceVpcConfiguration
SetSecurityGroupIds sets the SecurityGroupIds field's value.
func (*DataSourceVpcConfiguration) SetSubnetIds ¶
func (s *DataSourceVpcConfiguration) SetSubnetIds(v []*string) *DataSourceVpcConfiguration
SetSubnetIds sets the SubnetIds field's value.
func (DataSourceVpcConfiguration) String ¶
func (s DataSourceVpcConfiguration) String() string
String returns the string representation
func (*DataSourceVpcConfiguration) Validate ¶
func (s *DataSourceVpcConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DatabaseConfiguration ¶
type DatabaseConfiguration struct { // Information about the database column that provides information for user // context filtering. AclConfiguration *AclConfiguration `type:"structure"` // Information about where the index should get the document information from // the database. // // ColumnConfiguration is a required field ColumnConfiguration *ColumnConfiguration `type:"structure" required:"true"` // The information necessary to connect to a database. // // ConnectionConfiguration is a required field ConnectionConfiguration *ConnectionConfiguration `type:"structure" required:"true"` // The type of database engine that runs the database. // // DatabaseEngineType is a required field DatabaseEngineType *string `type:"string" required:"true" enum:"DatabaseEngineType"` // Provides information for connecting to an Amazon VPC. VpcConfiguration *DataSourceVpcConfiguration `type:"structure"` // contains filtered or unexported fields }
Provides the information necessary to connect a database to an index.
func (DatabaseConfiguration) GoString ¶
func (s DatabaseConfiguration) GoString() string
GoString returns the string representation
func (*DatabaseConfiguration) SetAclConfiguration ¶
func (s *DatabaseConfiguration) SetAclConfiguration(v *AclConfiguration) *DatabaseConfiguration
SetAclConfiguration sets the AclConfiguration field's value.
func (*DatabaseConfiguration) SetColumnConfiguration ¶
func (s *DatabaseConfiguration) SetColumnConfiguration(v *ColumnConfiguration) *DatabaseConfiguration
SetColumnConfiguration sets the ColumnConfiguration field's value.
func (*DatabaseConfiguration) SetConnectionConfiguration ¶
func (s *DatabaseConfiguration) SetConnectionConfiguration(v *ConnectionConfiguration) *DatabaseConfiguration
SetConnectionConfiguration sets the ConnectionConfiguration field's value.
func (*DatabaseConfiguration) SetDatabaseEngineType ¶
func (s *DatabaseConfiguration) SetDatabaseEngineType(v string) *DatabaseConfiguration
SetDatabaseEngineType sets the DatabaseEngineType field's value.
func (*DatabaseConfiguration) SetVpcConfiguration ¶
func (s *DatabaseConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *DatabaseConfiguration
SetVpcConfiguration sets the VpcConfiguration field's value.
func (DatabaseConfiguration) String ¶
func (s DatabaseConfiguration) String() string
String returns the string representation
func (*DatabaseConfiguration) Validate ¶
func (s *DatabaseConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteFaqInput ¶
type DeleteFaqInput struct { // The identifier of the FAQ to remove. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` // The index to remove the FAQ from. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteFaqInput) GoString ¶
func (s DeleteFaqInput) GoString() string
GoString returns the string representation
func (*DeleteFaqInput) SetId ¶
func (s *DeleteFaqInput) SetId(v string) *DeleteFaqInput
SetId sets the Id field's value.
func (*DeleteFaqInput) SetIndexId ¶
func (s *DeleteFaqInput) SetIndexId(v string) *DeleteFaqInput
SetIndexId sets the IndexId field's value.
func (DeleteFaqInput) String ¶
func (s DeleteFaqInput) String() string
String returns the string representation
func (*DeleteFaqInput) Validate ¶
func (s *DeleteFaqInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteFaqOutput ¶
type DeleteFaqOutput struct {
// contains filtered or unexported fields
}
func (DeleteFaqOutput) GoString ¶
func (s DeleteFaqOutput) GoString() string
GoString returns the string representation
func (DeleteFaqOutput) String ¶
func (s DeleteFaqOutput) String() string
String returns the string representation
type DeleteIndexInput ¶
type DeleteIndexInput struct { // The identifier of the index to delete. // // Id is a required field Id *string `min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteIndexInput) GoString ¶
func (s DeleteIndexInput) GoString() string
GoString returns the string representation
func (*DeleteIndexInput) SetId ¶
func (s *DeleteIndexInput) SetId(v string) *DeleteIndexInput
SetId sets the Id field's value.
func (DeleteIndexInput) String ¶
func (s DeleteIndexInput) String() string
String returns the string representation
func (*DeleteIndexInput) Validate ¶
func (s *DeleteIndexInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteIndexOutput ¶
type DeleteIndexOutput struct {
// contains filtered or unexported fields
}
func (DeleteIndexOutput) GoString ¶
func (s DeleteIndexOutput) GoString() string
GoString returns the string representation
func (DeleteIndexOutput) String ¶
func (s DeleteIndexOutput) String() string
String returns the string representation
type DescribeDataSourceInput ¶
type DescribeDataSourceInput struct { // The unique identifier of the data source to describe. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` // The identifier of the index that contains the data source. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeDataSourceInput) GoString ¶
func (s DescribeDataSourceInput) GoString() string
GoString returns the string representation
func (*DescribeDataSourceInput) SetId ¶
func (s *DescribeDataSourceInput) SetId(v string) *DescribeDataSourceInput
SetId sets the Id field's value.
func (*DescribeDataSourceInput) SetIndexId ¶
func (s *DescribeDataSourceInput) SetIndexId(v string) *DescribeDataSourceInput
SetIndexId sets the IndexId field's value.
func (DescribeDataSourceInput) String ¶
func (s DescribeDataSourceInput) String() string
String returns the string representation
func (*DescribeDataSourceInput) Validate ¶
func (s *DescribeDataSourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDataSourceOutput ¶
type DescribeDataSourceOutput struct { // Information that describes where the data source is located and how the data // source is configured. The specific information in the description depends // on the data source provider. Configuration *DataSourceConfiguration `type:"structure"` // The Unix timestamp of when the data source was created. CreatedAt *time.Time `type:"timestamp"` // The description of the data source. Description *string `min:"1" type:"string"` // When the Status field value is FAILED, the ErrorMessage field contains a // description of the error that caused the data source to fail. ErrorMessage *string `min:"1" type:"string"` // The identifier of the data source. Id *string `min:"1" type:"string"` // The identifier of the index that contains the data source. IndexId *string `min:"36" type:"string"` // The name that you gave the data source when it was created. Name *string `min:"1" type:"string"` // The Amazon Resource Name (ARN) of the role that enables the data source to // access its resources. RoleArn *string `min:"1" type:"string"` // The schedule that Amazon Kendra will update the data source. Schedule *string `type:"string"` // The current status of the data source. When the status is ACTIVE the data // source is ready to use. When the status is FAILED, the ErrorMessage field // contains the reason that the data source failed. Status *string `type:"string" enum:"DataSourceStatus"` // The type of the data source. Type *string `type:"string" enum:"DataSourceType"` // The Unix timestamp of when the data source was last updated. UpdatedAt *time.Time `type:"timestamp"` // contains filtered or unexported fields }
func (DescribeDataSourceOutput) GoString ¶
func (s DescribeDataSourceOutput) GoString() string
GoString returns the string representation
func (*DescribeDataSourceOutput) SetConfiguration ¶
func (s *DescribeDataSourceOutput) SetConfiguration(v *DataSourceConfiguration) *DescribeDataSourceOutput
SetConfiguration sets the Configuration field's value.
func (*DescribeDataSourceOutput) SetCreatedAt ¶
func (s *DescribeDataSourceOutput) SetCreatedAt(v time.Time) *DescribeDataSourceOutput
SetCreatedAt sets the CreatedAt field's value.
func (*DescribeDataSourceOutput) SetDescription ¶
func (s *DescribeDataSourceOutput) SetDescription(v string) *DescribeDataSourceOutput
SetDescription sets the Description field's value.
func (*DescribeDataSourceOutput) SetErrorMessage ¶
func (s *DescribeDataSourceOutput) SetErrorMessage(v string) *DescribeDataSourceOutput
SetErrorMessage sets the ErrorMessage field's value.
func (*DescribeDataSourceOutput) SetId ¶
func (s *DescribeDataSourceOutput) SetId(v string) *DescribeDataSourceOutput
SetId sets the Id field's value.
func (*DescribeDataSourceOutput) SetIndexId ¶
func (s *DescribeDataSourceOutput) SetIndexId(v string) *DescribeDataSourceOutput
SetIndexId sets the IndexId field's value.
func (*DescribeDataSourceOutput) SetName ¶
func (s *DescribeDataSourceOutput) SetName(v string) *DescribeDataSourceOutput
SetName sets the Name field's value.
func (*DescribeDataSourceOutput) SetRoleArn ¶
func (s *DescribeDataSourceOutput) SetRoleArn(v string) *DescribeDataSourceOutput
SetRoleArn sets the RoleArn field's value.
func (*DescribeDataSourceOutput) SetSchedule ¶
func (s *DescribeDataSourceOutput) SetSchedule(v string) *DescribeDataSourceOutput
SetSchedule sets the Schedule field's value.
func (*DescribeDataSourceOutput) SetStatus ¶
func (s *DescribeDataSourceOutput) SetStatus(v string) *DescribeDataSourceOutput
SetStatus sets the Status field's value.
func (*DescribeDataSourceOutput) SetType ¶
func (s *DescribeDataSourceOutput) SetType(v string) *DescribeDataSourceOutput
SetType sets the Type field's value.
func (*DescribeDataSourceOutput) SetUpdatedAt ¶
func (s *DescribeDataSourceOutput) SetUpdatedAt(v time.Time) *DescribeDataSourceOutput
SetUpdatedAt sets the UpdatedAt field's value.
func (DescribeDataSourceOutput) String ¶
func (s DescribeDataSourceOutput) String() string
String returns the string representation
type DescribeFaqInput ¶
type DescribeFaqInput struct { // The unique identifier of the FAQ. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` // The identifier of the index that contains the FAQ. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeFaqInput) GoString ¶
func (s DescribeFaqInput) GoString() string
GoString returns the string representation
func (*DescribeFaqInput) SetId ¶
func (s *DescribeFaqInput) SetId(v string) *DescribeFaqInput
SetId sets the Id field's value.
func (*DescribeFaqInput) SetIndexId ¶
func (s *DescribeFaqInput) SetIndexId(v string) *DescribeFaqInput
SetIndexId sets the IndexId field's value.
func (DescribeFaqInput) String ¶
func (s DescribeFaqInput) String() string
String returns the string representation
func (*DescribeFaqInput) Validate ¶
func (s *DescribeFaqInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeFaqOutput ¶
type DescribeFaqOutput struct { // The date and time that the FAQ was created. CreatedAt *time.Time `type:"timestamp"` // The description of the FAQ that you provided when it was created. Description *string `min:"1" type:"string"` // If the Status field is FAILED, the ErrorMessage field contains the reason // why the FAQ failed. ErrorMessage *string `min:"1" type:"string"` // The identifier of the FAQ. Id *string `min:"1" type:"string"` // The identifier of the index that contains the FAQ. IndexId *string `min:"36" type:"string"` // The name that you gave the FAQ when it was created. Name *string `min:"1" type:"string"` // The Amazon Resource Name (ARN) of the role that provides access to the S3 // bucket containing the input files for the FAQ. RoleArn *string `min:"1" type:"string"` // Information required to find a specific file in an Amazon S3 bucket. S3Path *S3Path `type:"structure"` // The status of the FAQ. It is ready to use when the status is ACTIVE. Status *string `type:"string" enum:"FaqStatus"` // The date and time that the FAQ was last updated. UpdatedAt *time.Time `type:"timestamp"` // contains filtered or unexported fields }
func (DescribeFaqOutput) GoString ¶
func (s DescribeFaqOutput) GoString() string
GoString returns the string representation
func (*DescribeFaqOutput) SetCreatedAt ¶
func (s *DescribeFaqOutput) SetCreatedAt(v time.Time) *DescribeFaqOutput
SetCreatedAt sets the CreatedAt field's value.
func (*DescribeFaqOutput) SetDescription ¶
func (s *DescribeFaqOutput) SetDescription(v string) *DescribeFaqOutput
SetDescription sets the Description field's value.
func (*DescribeFaqOutput) SetErrorMessage ¶
func (s *DescribeFaqOutput) SetErrorMessage(v string) *DescribeFaqOutput
SetErrorMessage sets the ErrorMessage field's value.
func (*DescribeFaqOutput) SetId ¶
func (s *DescribeFaqOutput) SetId(v string) *DescribeFaqOutput
SetId sets the Id field's value.
func (*DescribeFaqOutput) SetIndexId ¶
func (s *DescribeFaqOutput) SetIndexId(v string) *DescribeFaqOutput
SetIndexId sets the IndexId field's value.
func (*DescribeFaqOutput) SetName ¶
func (s *DescribeFaqOutput) SetName(v string) *DescribeFaqOutput
SetName sets the Name field's value.
func (*DescribeFaqOutput) SetRoleArn ¶
func (s *DescribeFaqOutput) SetRoleArn(v string) *DescribeFaqOutput
SetRoleArn sets the RoleArn field's value.
func (*DescribeFaqOutput) SetS3Path ¶
func (s *DescribeFaqOutput) SetS3Path(v *S3Path) *DescribeFaqOutput
SetS3Path sets the S3Path field's value.
func (*DescribeFaqOutput) SetStatus ¶
func (s *DescribeFaqOutput) SetStatus(v string) *DescribeFaqOutput
SetStatus sets the Status field's value.
func (*DescribeFaqOutput) SetUpdatedAt ¶
func (s *DescribeFaqOutput) SetUpdatedAt(v time.Time) *DescribeFaqOutput
SetUpdatedAt sets the UpdatedAt field's value.
func (DescribeFaqOutput) String ¶
func (s DescribeFaqOutput) String() string
String returns the string representation
type DescribeIndexInput ¶
type DescribeIndexInput struct { // The name of the index to describe. // // Id is a required field Id *string `min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeIndexInput) GoString ¶
func (s DescribeIndexInput) GoString() string
GoString returns the string representation
func (*DescribeIndexInput) SetId ¶
func (s *DescribeIndexInput) SetId(v string) *DescribeIndexInput
SetId sets the Id field's value.
func (DescribeIndexInput) String ¶
func (s DescribeIndexInput) String() string
String returns the string representation
func (*DescribeIndexInput) Validate ¶
func (s *DescribeIndexInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeIndexOutput ¶
type DescribeIndexOutput struct { // The Unix datetime that the index was created. CreatedAt *time.Time `type:"timestamp"` // The description of the index. Description *string `min:"1" type:"string"` // Configuration settings for any metadata applied to the documents in the index. DocumentMetadataConfigurations []*DocumentMetadataConfiguration `type:"list"` // When th eStatus field value is FAILED, the ErrorMessage field contains a // message that explains why. ErrorMessage *string `min:"1" type:"string"` // the name of the index. Id *string `min:"36" type:"string"` // Provides information about the number of FAQ questions and answers and the // number of text documents indexed. IndexStatistics *IndexStatistics `type:"structure"` // The name of the index. Name *string `min:"1" type:"string"` // The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission // to write to your Amazon Cloudwatch logs. RoleArn *string `min:"1" type:"string"` // The identifier of the AWS KMS customer master key (CMK) used to encrypt your // data. Amazon Kendra doesn't support asymmetric CMKs. ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"` // The current status of the index. When the value is ACTIVE, the index is ready // for use. If the Status field value is FAILED, the ErrorMessage field contains // a message that explains why. Status *string `type:"string" enum:"IndexStatus"` // The Unix datetime that the index was last updated. UpdatedAt *time.Time `type:"timestamp"` // contains filtered or unexported fields }
func (DescribeIndexOutput) GoString ¶
func (s DescribeIndexOutput) GoString() string
GoString returns the string representation
func (*DescribeIndexOutput) SetCreatedAt ¶
func (s *DescribeIndexOutput) SetCreatedAt(v time.Time) *DescribeIndexOutput
SetCreatedAt sets the CreatedAt field's value.
func (*DescribeIndexOutput) SetDescription ¶
func (s *DescribeIndexOutput) SetDescription(v string) *DescribeIndexOutput
SetDescription sets the Description field's value.
func (*DescribeIndexOutput) SetDocumentMetadataConfigurations ¶
func (s *DescribeIndexOutput) SetDocumentMetadataConfigurations(v []*DocumentMetadataConfiguration) *DescribeIndexOutput
SetDocumentMetadataConfigurations sets the DocumentMetadataConfigurations field's value.
func (*DescribeIndexOutput) SetErrorMessage ¶
func (s *DescribeIndexOutput) SetErrorMessage(v string) *DescribeIndexOutput
SetErrorMessage sets the ErrorMessage field's value.
func (*DescribeIndexOutput) SetId ¶
func (s *DescribeIndexOutput) SetId(v string) *DescribeIndexOutput
SetId sets the Id field's value.
func (*DescribeIndexOutput) SetIndexStatistics ¶
func (s *DescribeIndexOutput) SetIndexStatistics(v *IndexStatistics) *DescribeIndexOutput
SetIndexStatistics sets the IndexStatistics field's value.
func (*DescribeIndexOutput) SetName ¶
func (s *DescribeIndexOutput) SetName(v string) *DescribeIndexOutput
SetName sets the Name field's value.
func (*DescribeIndexOutput) SetRoleArn ¶
func (s *DescribeIndexOutput) SetRoleArn(v string) *DescribeIndexOutput
SetRoleArn sets the RoleArn field's value.
func (*DescribeIndexOutput) SetServerSideEncryptionConfiguration ¶
func (s *DescribeIndexOutput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *DescribeIndexOutput
SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.
func (*DescribeIndexOutput) SetStatus ¶
func (s *DescribeIndexOutput) SetStatus(v string) *DescribeIndexOutput
SetStatus sets the Status field's value.
func (*DescribeIndexOutput) SetUpdatedAt ¶
func (s *DescribeIndexOutput) SetUpdatedAt(v time.Time) *DescribeIndexOutput
SetUpdatedAt sets the UpdatedAt field's value.
func (DescribeIndexOutput) String ¶
func (s DescribeIndexOutput) String() string
String returns the string representation
type Document ¶
type Document struct { // Information to use for user context filtering. AccessControlList []*Principal `min:"1" type:"list"` // Custom attributes to apply to the document. Use the custom attributes to // provide additional information for searching, to provide facets for refining // searches, and to provide additional information in the query response. Attributes []*DocumentAttribute `min:"1" type:"list"` // The contents of the document as a base-64 encoded string. // // Blob is automatically base64 encoded/decoded by the SDK. Blob []byte `min:"1" type:"blob"` // The file type of the document in the Blob field. ContentType *string `type:"string" enum:"ContentType"` // A unique identifier of the document in the index. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` // Information required to find a specific file in an Amazon S3 bucket. S3Path *S3Path `type:"structure"` // The title of the document. Title *string `min:"1" type:"string"` // contains filtered or unexported fields }
A document in an index.
func (*Document) SetAccessControlList ¶
SetAccessControlList sets the AccessControlList field's value.
func (*Document) SetAttributes ¶
func (s *Document) SetAttributes(v []*DocumentAttribute) *Document
SetAttributes sets the Attributes field's value.
func (*Document) SetContentType ¶
SetContentType sets the ContentType field's value.
type DocumentAttribute ¶
type DocumentAttribute struct { // The identifier for the attribute. // // Key is a required field Key *string `min:"1" type:"string" required:"true"` // The value of the attribute. // // Value is a required field Value *DocumentAttributeValue `type:"structure" required:"true"` // contains filtered or unexported fields }
A custom attribute value assigned to a document.
func (DocumentAttribute) GoString ¶
func (s DocumentAttribute) GoString() string
GoString returns the string representation
func (*DocumentAttribute) SetKey ¶
func (s *DocumentAttribute) SetKey(v string) *DocumentAttribute
SetKey sets the Key field's value.
func (*DocumentAttribute) SetValue ¶
func (s *DocumentAttribute) SetValue(v *DocumentAttributeValue) *DocumentAttribute
SetValue sets the Value field's value.
func (DocumentAttribute) String ¶
func (s DocumentAttribute) String() string
String returns the string representation
func (*DocumentAttribute) Validate ¶
func (s *DocumentAttribute) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DocumentAttributeValue ¶
type DocumentAttributeValue struct { // A date value expressed as seconds from the Unix epoch. DateValue *time.Time `type:"timestamp"` // A long integer value. LongValue *int64 `type:"long"` // A list of strings. StringListValue []*string `min:"1" type:"list"` // A string, such as "department". StringValue *string `min:"1" type:"string"` // contains filtered or unexported fields }
The value of a custom document attribute. You can only provide one value for a custom attribute.
func (DocumentAttributeValue) GoString ¶
func (s DocumentAttributeValue) GoString() string
GoString returns the string representation
func (*DocumentAttributeValue) SetDateValue ¶
func (s *DocumentAttributeValue) SetDateValue(v time.Time) *DocumentAttributeValue
SetDateValue sets the DateValue field's value.
func (*DocumentAttributeValue) SetLongValue ¶
func (s *DocumentAttributeValue) SetLongValue(v int64) *DocumentAttributeValue
SetLongValue sets the LongValue field's value.
func (*DocumentAttributeValue) SetStringListValue ¶
func (s *DocumentAttributeValue) SetStringListValue(v []*string) *DocumentAttributeValue
SetStringListValue sets the StringListValue field's value.
func (*DocumentAttributeValue) SetStringValue ¶
func (s *DocumentAttributeValue) SetStringValue(v string) *DocumentAttributeValue
SetStringValue sets the StringValue field's value.
func (DocumentAttributeValue) String ¶
func (s DocumentAttributeValue) String() string
String returns the string representation
func (*DocumentAttributeValue) Validate ¶
func (s *DocumentAttributeValue) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DocumentAttributeValueCountPair ¶
type DocumentAttributeValueCountPair struct { // The number of documents in the response that have the attribute value for // the key. Count *int64 `type:"integer"` // The value of the attribute. For example, "HR." DocumentAttributeValue *DocumentAttributeValue `type:"structure"` // contains filtered or unexported fields }
Provides the count of documents that match a particular attribute when doing a faceted search.
func (DocumentAttributeValueCountPair) GoString ¶
func (s DocumentAttributeValueCountPair) GoString() string
GoString returns the string representation
func (*DocumentAttributeValueCountPair) SetCount ¶
func (s *DocumentAttributeValueCountPair) SetCount(v int64) *DocumentAttributeValueCountPair
SetCount sets the Count field's value.
func (*DocumentAttributeValueCountPair) SetDocumentAttributeValue ¶
func (s *DocumentAttributeValueCountPair) SetDocumentAttributeValue(v *DocumentAttributeValue) *DocumentAttributeValueCountPair
SetDocumentAttributeValue sets the DocumentAttributeValue field's value.
func (DocumentAttributeValueCountPair) String ¶
func (s DocumentAttributeValueCountPair) String() string
String returns the string representation
type DocumentMetadataConfiguration ¶
type DocumentMetadataConfiguration struct { // The name of the index field. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // Provides manual tuning parameters to determine how the field affects the // search results. Relevance *Relevance `type:"structure"` // Provides information about how the field is used during a search. Search *Search `type:"structure"` // The data type of the index field. // // Type is a required field Type *string `type:"string" required:"true" enum:"DocumentAttributeValueType"` // contains filtered or unexported fields }
Specifies the properties of a custom index field.
func (DocumentMetadataConfiguration) GoString ¶
func (s DocumentMetadataConfiguration) GoString() string
GoString returns the string representation
func (*DocumentMetadataConfiguration) SetName ¶
func (s *DocumentMetadataConfiguration) SetName(v string) *DocumentMetadataConfiguration
SetName sets the Name field's value.
func (*DocumentMetadataConfiguration) SetRelevance ¶
func (s *DocumentMetadataConfiguration) SetRelevance(v *Relevance) *DocumentMetadataConfiguration
SetRelevance sets the Relevance field's value.
func (*DocumentMetadataConfiguration) SetSearch ¶
func (s *DocumentMetadataConfiguration) SetSearch(v *Search) *DocumentMetadataConfiguration
SetSearch sets the Search field's value.
func (*DocumentMetadataConfiguration) SetType ¶
func (s *DocumentMetadataConfiguration) SetType(v string) *DocumentMetadataConfiguration
SetType sets the Type field's value.
func (DocumentMetadataConfiguration) String ¶
func (s DocumentMetadataConfiguration) String() string
String returns the string representation
func (*DocumentMetadataConfiguration) Validate ¶
func (s *DocumentMetadataConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DocumentsMetadataConfiguration ¶
type DocumentsMetadataConfiguration struct { // A prefix used to filter metadata configuration files in the AWS S3 bucket. // The S3 bucket might contain multiple metadata files. Use S3Prefix to include // only the desired metadata files. S3Prefix *string `min:"1" type:"string"` // contains filtered or unexported fields }
Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.
func (DocumentsMetadataConfiguration) GoString ¶
func (s DocumentsMetadataConfiguration) GoString() string
GoString returns the string representation
func (*DocumentsMetadataConfiguration) SetS3Prefix ¶
func (s *DocumentsMetadataConfiguration) SetS3Prefix(v string) *DocumentsMetadataConfiguration
SetS3Prefix sets the S3Prefix field's value.
func (DocumentsMetadataConfiguration) String ¶
func (s DocumentsMetadataConfiguration) String() string
String returns the string representation
func (*DocumentsMetadataConfiguration) Validate ¶
func (s *DocumentsMetadataConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Facet ¶
type Facet struct { // The unique key for the document attribute. DocumentAttributeKey *string `min:"1" type:"string"` // contains filtered or unexported fields }
Information a document attribute
func (*Facet) SetDocumentAttributeKey ¶
SetDocumentAttributeKey sets the DocumentAttributeKey field's value.
type FacetResult ¶
type FacetResult struct { // The key for the facet values. This is the same as the DocumentAttributeKey // provided in the query. DocumentAttributeKey *string `min:"1" type:"string"` // An array of key/value pairs, where the key is the value of the attribute // and the count is the number of documents that share the key value. DocumentAttributeValueCountPairs []*DocumentAttributeValueCountPair `type:"list"` // contains filtered or unexported fields }
The facet values for the documents in the response.
func (FacetResult) GoString ¶
func (s FacetResult) GoString() string
GoString returns the string representation
func (*FacetResult) SetDocumentAttributeKey ¶
func (s *FacetResult) SetDocumentAttributeKey(v string) *FacetResult
SetDocumentAttributeKey sets the DocumentAttributeKey field's value.
func (*FacetResult) SetDocumentAttributeValueCountPairs ¶
func (s *FacetResult) SetDocumentAttributeValueCountPairs(v []*DocumentAttributeValueCountPair) *FacetResult
SetDocumentAttributeValueCountPairs sets the DocumentAttributeValueCountPairs field's value.
func (FacetResult) String ¶
func (s FacetResult) String() string
String returns the string representation
type FaqStatistics ¶
type FaqStatistics struct { // The total number of FAQ questions and answers contained in the index. // // IndexedQuestionAnswersCount is a required field IndexedQuestionAnswersCount *int64 `type:"integer" required:"true"` // contains filtered or unexported fields }
Provides statistical information about the FAQ questions and answers contained in an index.
func (FaqStatistics) GoString ¶
func (s FaqStatistics) GoString() string
GoString returns the string representation
func (*FaqStatistics) SetIndexedQuestionAnswersCount ¶
func (s *FaqStatistics) SetIndexedQuestionAnswersCount(v int64) *FaqStatistics
SetIndexedQuestionAnswersCount sets the IndexedQuestionAnswersCount field's value.
func (FaqStatistics) String ¶
func (s FaqStatistics) String() string
String returns the string representation
type FaqSummary ¶
type FaqSummary struct { // The UNIX datetime that the FAQ was added to the index. CreatedAt *time.Time `type:"timestamp"` // The unique identifier of the FAQ. Id *string `min:"1" type:"string"` // The name that you assigned the FAQ when you created or updated the FAQ. Name *string `min:"1" type:"string"` // The current status of the FAQ. When the status is ACTIVE the FAQ is ready // for use. Status *string `type:"string" enum:"FaqStatus"` // The UNIX datetime that the FAQ was last updated. UpdatedAt *time.Time `type:"timestamp"` // contains filtered or unexported fields }
Provides information about a frequently asked questions and answer contained in an index.
func (FaqSummary) GoString ¶
func (s FaqSummary) GoString() string
GoString returns the string representation
func (*FaqSummary) SetCreatedAt ¶
func (s *FaqSummary) SetCreatedAt(v time.Time) *FaqSummary
SetCreatedAt sets the CreatedAt field's value.
func (*FaqSummary) SetId ¶
func (s *FaqSummary) SetId(v string) *FaqSummary
SetId sets the Id field's value.
func (*FaqSummary) SetName ¶
func (s *FaqSummary) SetName(v string) *FaqSummary
SetName sets the Name field's value.
func (*FaqSummary) SetStatus ¶
func (s *FaqSummary) SetStatus(v string) *FaqSummary
SetStatus sets the Status field's value.
func (*FaqSummary) SetUpdatedAt ¶
func (s *FaqSummary) SetUpdatedAt(v time.Time) *FaqSummary
SetUpdatedAt sets the UpdatedAt field's value.
func (FaqSummary) String ¶
func (s FaqSummary) String() string
String returns the string representation
type Highlight ¶
type Highlight struct { // The zero-based location in the response string where the highlight starts. // // BeginOffset is a required field BeginOffset *int64 `type:"integer" required:"true"` // The zero-based location in the response string where the highlight ends. // // EndOffset is a required field EndOffset *int64 `type:"integer" required:"true"` // Indicates whether the response is the best response. True if this is the // best response; otherwise, false. TopAnswer *bool `type:"boolean"` // contains filtered or unexported fields }
Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.
func (*Highlight) SetBeginOffset ¶
SetBeginOffset sets the BeginOffset field's value.
func (*Highlight) SetEndOffset ¶
SetEndOffset sets the EndOffset field's value.
func (*Highlight) SetTopAnswer ¶
SetTopAnswer sets the TopAnswer field's value.
type IndexConfigurationSummary ¶
type IndexConfigurationSummary struct { // The Unix timestamp when the index was created. // // CreatedAt is a required field CreatedAt *time.Time `type:"timestamp" required:"true"` // A unique identifier for the index. Use this to identify the index when you // are using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex. Id *string `min:"36" type:"string"` // The name of the index. Name *string `min:"1" type:"string"` // The current status of the index. When the status is ACTIVE, the index is // ready to search. // // Status is a required field Status *string `type:"string" required:"true" enum:"IndexStatus"` // The Unix timestamp when the index was last updated by the UpdateIndex operation. // // UpdatedAt is a required field UpdatedAt *time.Time `type:"timestamp" required:"true"` // contains filtered or unexported fields }
A summary of information about an index.
func (IndexConfigurationSummary) GoString ¶
func (s IndexConfigurationSummary) GoString() string
GoString returns the string representation
func (*IndexConfigurationSummary) SetCreatedAt ¶
func (s *IndexConfigurationSummary) SetCreatedAt(v time.Time) *IndexConfigurationSummary
SetCreatedAt sets the CreatedAt field's value.
func (*IndexConfigurationSummary) SetId ¶
func (s *IndexConfigurationSummary) SetId(v string) *IndexConfigurationSummary
SetId sets the Id field's value.
func (*IndexConfigurationSummary) SetName ¶
func (s *IndexConfigurationSummary) SetName(v string) *IndexConfigurationSummary
SetName sets the Name field's value.
func (*IndexConfigurationSummary) SetStatus ¶
func (s *IndexConfigurationSummary) SetStatus(v string) *IndexConfigurationSummary
SetStatus sets the Status field's value.
func (*IndexConfigurationSummary) SetUpdatedAt ¶
func (s *IndexConfigurationSummary) SetUpdatedAt(v time.Time) *IndexConfigurationSummary
SetUpdatedAt sets the UpdatedAt field's value.
func (IndexConfigurationSummary) String ¶
func (s IndexConfigurationSummary) String() string
String returns the string representation
type IndexStatistics ¶
type IndexStatistics struct { // The number of question and answer topics in the index. // // FaqStatistics is a required field FaqStatistics *FaqStatistics `type:"structure" required:"true"` // The number of text documents indexed. // // TextDocumentStatistics is a required field TextDocumentStatistics *TextDocumentStatistics `type:"structure" required:"true"` // contains filtered or unexported fields }
Provides information about the number of documents and the number of questions and answers in an index.
func (IndexStatistics) GoString ¶
func (s IndexStatistics) GoString() string
GoString returns the string representation
func (*IndexStatistics) SetFaqStatistics ¶
func (s *IndexStatistics) SetFaqStatistics(v *FaqStatistics) *IndexStatistics
SetFaqStatistics sets the FaqStatistics field's value.
func (*IndexStatistics) SetTextDocumentStatistics ¶
func (s *IndexStatistics) SetTextDocumentStatistics(v *TextDocumentStatistics) *IndexStatistics
SetTextDocumentStatistics sets the TextDocumentStatistics field's value.
func (IndexStatistics) String ¶
func (s IndexStatistics) String() string
String returns the string representation
type InternalServerException ¶ added in v1.28.0
type InternalServerException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"string"` // contains filtered or unexported fields }
func (InternalServerException) Code ¶ added in v1.28.0
func (s InternalServerException) Code() string
Code returns the exception type name.
func (InternalServerException) Error ¶ added in v1.28.0
func (s InternalServerException) Error() string
func (InternalServerException) GoString ¶ added in v1.28.0
func (s InternalServerException) GoString() string
GoString returns the string representation
func (InternalServerException) Message ¶ added in v1.28.0
func (s InternalServerException) Message() string
Message returns the exception's message.
func (InternalServerException) OrigErr ¶ added in v1.28.0
func (s InternalServerException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (InternalServerException) RequestID ¶ added in v1.28.0
func (s InternalServerException) RequestID() string
RequestID returns the service's response RequestID for request.
func (InternalServerException) StatusCode ¶ added in v1.28.0
func (s InternalServerException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (InternalServerException) String ¶ added in v1.28.0
func (s InternalServerException) String() string
String returns the string representation
type Kendra ¶
Kendra provides the API operation methods for making requests to AWSKendraFrontendService. See this package's package overview docs for details on the service.
Kendra methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *Kendra
New creates a new instance of the Kendra client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession()) // Create a Kendra client from just a session. svc := kendra.New(mySession) // Create a Kendra client with additional configuration svc := kendra.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*Kendra) BatchDeleteDocument ¶
func (c *Kendra) BatchDeleteDocument(input *BatchDeleteDocumentInput) (*BatchDeleteDocumentOutput, error)
BatchDeleteDocument API operation for AWSKendraFrontendService.
Removes one or more documents from an index. The documents must have been added with the BatchPutDocument operation.
The documents are deleted asynchronously. You can see the progress of the deletion by using AWS CloudWatch. Any error messages releated to the processing of the batch are sent to you CloudWatch log.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation BatchDeleteDocument for usage and error information.
Returned Error Types:
ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteDocument
func (*Kendra) BatchDeleteDocumentRequest ¶
func (c *Kendra) BatchDeleteDocumentRequest(input *BatchDeleteDocumentInput) (req *request.Request, output *BatchDeleteDocumentOutput)
BatchDeleteDocumentRequest generates a "aws/request.Request" representing the client's request for the BatchDeleteDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See BatchDeleteDocument for more information on using the BatchDeleteDocument API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the BatchDeleteDocumentRequest method. req, resp := client.BatchDeleteDocumentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteDocument
func (*Kendra) BatchDeleteDocumentWithContext ¶
func (c *Kendra) BatchDeleteDocumentWithContext(ctx aws.Context, input *BatchDeleteDocumentInput, opts ...request.Option) (*BatchDeleteDocumentOutput, error)
BatchDeleteDocumentWithContext is the same as BatchDeleteDocument with the addition of the ability to pass a context and additional request options.
See BatchDeleteDocument for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) BatchPutDocument ¶
func (c *Kendra) BatchPutDocument(input *BatchPutDocumentInput) (*BatchPutDocumentOutput, error)
BatchPutDocument API operation for AWSKendraFrontendService.
Adds one or more documents to an index.
The BatchPutDocument operation enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this operation to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.
The documents are indexed asynchronously. You can see the progress of the batch using AWS CloudWatch. Any error messages related to processing the batch are sent to your AWS CloudWatch log.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation BatchPutDocument for usage and error information.
Returned Error Types:
ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
ServiceQuotaExceededException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchPutDocument
func (*Kendra) BatchPutDocumentRequest ¶
func (c *Kendra) BatchPutDocumentRequest(input *BatchPutDocumentInput) (req *request.Request, output *BatchPutDocumentOutput)
BatchPutDocumentRequest generates a "aws/request.Request" representing the client's request for the BatchPutDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See BatchPutDocument for more information on using the BatchPutDocument API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the BatchPutDocumentRequest method. req, resp := client.BatchPutDocumentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchPutDocument
func (*Kendra) BatchPutDocumentWithContext ¶
func (c *Kendra) BatchPutDocumentWithContext(ctx aws.Context, input *BatchPutDocumentInput, opts ...request.Option) (*BatchPutDocumentOutput, error)
BatchPutDocumentWithContext is the same as BatchPutDocument with the addition of the ability to pass a context and additional request options.
See BatchPutDocument for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) CreateDataSource ¶
func (c *Kendra) CreateDataSource(input *CreateDataSourceInput) (*CreateDataSourceOutput, error)
CreateDataSource API operation for AWSKendraFrontendService.
Creates a data source that you use to with an Amazon Kendra index.
You specify a name, connector type and description for your data source. You can choose between an S3 connector, a SharePoint Online connector, and a database connector.
You also specify configuration information such as document metadata (author, source URI, and so on) and user context information.
CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation CreateDataSource for usage and error information.
Returned Error Types:
ValidationException
ConflictException
ResourceNotFoundException
ResourceAlreadyExistException
ServiceQuotaExceededException
ThrottlingException
AccessDeniedException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSource
func (*Kendra) CreateDataSourceRequest ¶
func (c *Kendra) CreateDataSourceRequest(input *CreateDataSourceInput) (req *request.Request, output *CreateDataSourceOutput)
CreateDataSourceRequest generates a "aws/request.Request" representing the client's request for the CreateDataSource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateDataSource for more information on using the CreateDataSource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateDataSourceRequest method. req, resp := client.CreateDataSourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSource
func (*Kendra) CreateDataSourceWithContext ¶
func (c *Kendra) CreateDataSourceWithContext(ctx aws.Context, input *CreateDataSourceInput, opts ...request.Option) (*CreateDataSourceOutput, error)
CreateDataSourceWithContext is the same as CreateDataSource with the addition of the ability to pass a context and additional request options.
See CreateDataSource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) CreateFaq ¶
func (c *Kendra) CreateFaq(input *CreateFaqInput) (*CreateFaqOutput, error)
CreateFaq API operation for AWSKendraFrontendService.
Creates an new set of frequently asked question (FAQ) questions and answers.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation CreateFaq for usage and error information.
Returned Error Types:
ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
ServiceQuotaExceededException
AccessDeniedException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaq
func (*Kendra) CreateFaqRequest ¶
func (c *Kendra) CreateFaqRequest(input *CreateFaqInput) (req *request.Request, output *CreateFaqOutput)
CreateFaqRequest generates a "aws/request.Request" representing the client's request for the CreateFaq operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateFaq for more information on using the CreateFaq API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateFaqRequest method. req, resp := client.CreateFaqRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaq
func (*Kendra) CreateFaqWithContext ¶
func (c *Kendra) CreateFaqWithContext(ctx aws.Context, input *CreateFaqInput, opts ...request.Option) (*CreateFaqOutput, error)
CreateFaqWithContext is the same as CreateFaq with the addition of the ability to pass a context and additional request options.
See CreateFaq for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) CreateIndex ¶
func (c *Kendra) CreateIndex(input *CreateIndexInput) (*CreateIndexOutput, error)
CreateIndex API operation for AWSKendraFrontendService.
Creates a new Amazon Kendra index. Index creation is an asynchronous operation. To determine if index creation has completed, check the Status field returned from a call to . The Status field is set to ACTIVE when the index is ready to use.
Once the index is active you can index your documents using the operation or using one of the supported data sources.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation CreateIndex for usage and error information.
Returned Error Types:
ValidationException
ResourceAlreadyExistException
ServiceQuotaExceededException
ThrottlingException
AccessDeniedException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndex
func (*Kendra) CreateIndexRequest ¶
func (c *Kendra) CreateIndexRequest(input *CreateIndexInput) (req *request.Request, output *CreateIndexOutput)
CreateIndexRequest generates a "aws/request.Request" representing the client's request for the CreateIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateIndex for more information on using the CreateIndex API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateIndexRequest method. req, resp := client.CreateIndexRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndex
func (*Kendra) CreateIndexWithContext ¶
func (c *Kendra) CreateIndexWithContext(ctx aws.Context, input *CreateIndexInput, opts ...request.Option) (*CreateIndexOutput, error)
CreateIndexWithContext is the same as CreateIndex with the addition of the ability to pass a context and additional request options.
See CreateIndex for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) DeleteFaq ¶
func (c *Kendra) DeleteFaq(input *DeleteFaqInput) (*DeleteFaqOutput, error)
DeleteFaq API operation for AWSKendraFrontendService.
Removes an FAQ from an index.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteFaq for usage and error information.
Returned Error Types:
ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteFaq
func (*Kendra) DeleteFaqRequest ¶
func (c *Kendra) DeleteFaqRequest(input *DeleteFaqInput) (req *request.Request, output *DeleteFaqOutput)
DeleteFaqRequest generates a "aws/request.Request" representing the client's request for the DeleteFaq operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteFaq for more information on using the DeleteFaq API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteFaqRequest method. req, resp := client.DeleteFaqRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteFaq
func (*Kendra) DeleteFaqWithContext ¶
func (c *Kendra) DeleteFaqWithContext(ctx aws.Context, input *DeleteFaqInput, opts ...request.Option) (*DeleteFaqOutput, error)
DeleteFaqWithContext is the same as DeleteFaq with the addition of the ability to pass a context and additional request options.
See DeleteFaq for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) DeleteIndex ¶
func (c *Kendra) DeleteIndex(input *DeleteIndexInput) (*DeleteIndexOutput, error)
DeleteIndex API operation for AWSKendraFrontendService.
Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex operation is set to DELETING.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteIndex for usage and error information.
Returned Error Types:
ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteIndex
func (*Kendra) DeleteIndexRequest ¶
func (c *Kendra) DeleteIndexRequest(input *DeleteIndexInput) (req *request.Request, output *DeleteIndexOutput)
DeleteIndexRequest generates a "aws/request.Request" representing the client's request for the DeleteIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteIndex for more information on using the DeleteIndex API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteIndexRequest method. req, resp := client.DeleteIndexRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteIndex
func (*Kendra) DeleteIndexWithContext ¶
func (c *Kendra) DeleteIndexWithContext(ctx aws.Context, input *DeleteIndexInput, opts ...request.Option) (*DeleteIndexOutput, error)
DeleteIndexWithContext is the same as DeleteIndex with the addition of the ability to pass a context and additional request options.
See DeleteIndex for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) DescribeDataSource ¶
func (c *Kendra) DescribeDataSource(input *DescribeDataSourceInput) (*DescribeDataSourceOutput, error)
DescribeDataSource API operation for AWSKendraFrontendService.
Gets information about a Amazon Kendra data source.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeDataSource for usage and error information.
Returned Error Types:
ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSource
func (*Kendra) DescribeDataSourceRequest ¶
func (c *Kendra) DescribeDataSourceRequest(input *DescribeDataSourceInput) (req *request.Request, output *DescribeDataSourceOutput)
DescribeDataSourceRequest generates a "aws/request.Request" representing the client's request for the DescribeDataSource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeDataSource for more information on using the DescribeDataSource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeDataSourceRequest method. req, resp := client.DescribeDataSourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSource
func (*Kendra) DescribeDataSourceWithContext ¶
func (c *Kendra) DescribeDataSourceWithContext(ctx aws.Context, input *DescribeDataSourceInput, opts ...request.Option) (*DescribeDataSourceOutput, error)
DescribeDataSourceWithContext is the same as DescribeDataSource with the addition of the ability to pass a context and additional request options.
See DescribeDataSource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) DescribeFaq ¶
func (c *Kendra) DescribeFaq(input *DescribeFaqInput) (*DescribeFaqOutput, error)
DescribeFaq API operation for AWSKendraFrontendService.
Gets information about an FAQ list.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeFaq for usage and error information.
Returned Error Types:
ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaq
func (*Kendra) DescribeFaqRequest ¶
func (c *Kendra) DescribeFaqRequest(input *DescribeFaqInput) (req *request.Request, output *DescribeFaqOutput)
DescribeFaqRequest generates a "aws/request.Request" representing the client's request for the DescribeFaq operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeFaq for more information on using the DescribeFaq API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeFaqRequest method. req, resp := client.DescribeFaqRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaq
func (*Kendra) DescribeFaqWithContext ¶
func (c *Kendra) DescribeFaqWithContext(ctx aws.Context, input *DescribeFaqInput, opts ...request.Option) (*DescribeFaqOutput, error)
DescribeFaqWithContext is the same as DescribeFaq with the addition of the ability to pass a context and additional request options.
See DescribeFaq for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) DescribeIndex ¶
func (c *Kendra) DescribeIndex(input *DescribeIndexInput) (*DescribeIndexOutput, error)
DescribeIndex API operation for AWSKendraFrontendService.
Describes an existing Amazon Kendra index ¶
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeIndex for usage and error information.
Returned Error Types:
ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex
func (*Kendra) DescribeIndexRequest ¶
func (c *Kendra) DescribeIndexRequest(input *DescribeIndexInput) (req *request.Request, output *DescribeIndexOutput)
DescribeIndexRequest generates a "aws/request.Request" representing the client's request for the DescribeIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeIndex for more information on using the DescribeIndex API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeIndexRequest method. req, resp := client.DescribeIndexRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex
func (*Kendra) DescribeIndexWithContext ¶
func (c *Kendra) DescribeIndexWithContext(ctx aws.Context, input *DescribeIndexInput, opts ...request.Option) (*DescribeIndexOutput, error)
DescribeIndexWithContext is the same as DescribeIndex with the addition of the ability to pass a context and additional request options.
See DescribeIndex for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) ListDataSourceSyncJobs ¶
func (c *Kendra) ListDataSourceSyncJobs(input *ListDataSourceSyncJobsInput) (*ListDataSourceSyncJobsOutput, error)
ListDataSourceSyncJobs API operation for AWSKendraFrontendService.
Gets statistics about synchronizing Amazon Kendra with a data source.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation ListDataSourceSyncJobs for usage and error information.
Returned Error Types:
ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
ConflictException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobs
func (*Kendra) ListDataSourceSyncJobsPages ¶
func (c *Kendra) ListDataSourceSyncJobsPages(input *ListDataSourceSyncJobsInput, fn func(*ListDataSourceSyncJobsOutput, bool) bool) error
ListDataSourceSyncJobsPages iterates over the pages of a ListDataSourceSyncJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListDataSourceSyncJobs method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListDataSourceSyncJobs operation. pageNum := 0 err := client.ListDataSourceSyncJobsPages(params, func(page *kendra.ListDataSourceSyncJobsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*Kendra) ListDataSourceSyncJobsPagesWithContext ¶
func (c *Kendra) ListDataSourceSyncJobsPagesWithContext(ctx aws.Context, input *ListDataSourceSyncJobsInput, fn func(*ListDataSourceSyncJobsOutput, bool) bool, opts ...request.Option) error
ListDataSourceSyncJobsPagesWithContext same as ListDataSourceSyncJobsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) ListDataSourceSyncJobsRequest ¶
func (c *Kendra) ListDataSourceSyncJobsRequest(input *ListDataSourceSyncJobsInput) (req *request.Request, output *ListDataSourceSyncJobsOutput)
ListDataSourceSyncJobsRequest generates a "aws/request.Request" representing the client's request for the ListDataSourceSyncJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListDataSourceSyncJobs for more information on using the ListDataSourceSyncJobs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListDataSourceSyncJobsRequest method. req, resp := client.ListDataSourceSyncJobsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobs
func (*Kendra) ListDataSourceSyncJobsWithContext ¶
func (c *Kendra) ListDataSourceSyncJobsWithContext(ctx aws.Context, input *ListDataSourceSyncJobsInput, opts ...request.Option) (*ListDataSourceSyncJobsOutput, error)
ListDataSourceSyncJobsWithContext is the same as ListDataSourceSyncJobs with the addition of the ability to pass a context and additional request options.
See ListDataSourceSyncJobs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) ListDataSources ¶
func (c *Kendra) ListDataSources(input *ListDataSourcesInput) (*ListDataSourcesOutput, error)
ListDataSources API operation for AWSKendraFrontendService.
Lists the data sources that you have created.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation ListDataSources for usage and error information.
Returned Error Types:
ValidationException
ResourceNotFoundException
AccessDeniedException
ThrottlingException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSources
func (*Kendra) ListDataSourcesPages ¶
func (c *Kendra) ListDataSourcesPages(input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool) error
ListDataSourcesPages iterates over the pages of a ListDataSources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListDataSources method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListDataSources operation. pageNum := 0 err := client.ListDataSourcesPages(params, func(page *kendra.ListDataSourcesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*Kendra) ListDataSourcesPagesWithContext ¶
func (c *Kendra) ListDataSourcesPagesWithContext(ctx aws.Context, input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool, opts ...request.Option) error
ListDataSourcesPagesWithContext same as ListDataSourcesPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) ListDataSourcesRequest ¶
func (c *Kendra) ListDataSourcesRequest(input *ListDataSourcesInput) (req *request.Request, output *ListDataSourcesOutput)
ListDataSourcesRequest generates a "aws/request.Request" representing the client's request for the ListDataSources operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListDataSources for more information on using the ListDataSources API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListDataSourcesRequest method. req, resp := client.ListDataSourcesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSources
func (*Kendra) ListDataSourcesWithContext ¶
func (c *Kendra) ListDataSourcesWithContext(ctx aws.Context, input *ListDataSourcesInput, opts ...request.Option) (*ListDataSourcesOutput, error)
ListDataSourcesWithContext is the same as ListDataSources with the addition of the ability to pass a context and additional request options.
See ListDataSources for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) ListFaqs ¶
func (c *Kendra) ListFaqs(input *ListFaqsInput) (*ListFaqsOutput, error)
ListFaqs API operation for AWSKendraFrontendService.
Gets a list of FAQ lists associated with an index.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation ListFaqs for usage and error information.
Returned Error Types:
ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqs
func (*Kendra) ListFaqsRequest ¶
func (c *Kendra) ListFaqsRequest(input *ListFaqsInput) (req *request.Request, output *ListFaqsOutput)
ListFaqsRequest generates a "aws/request.Request" representing the client's request for the ListFaqs operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListFaqs for more information on using the ListFaqs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListFaqsRequest method. req, resp := client.ListFaqsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqs
func (*Kendra) ListFaqsWithContext ¶
func (c *Kendra) ListFaqsWithContext(ctx aws.Context, input *ListFaqsInput, opts ...request.Option) (*ListFaqsOutput, error)
ListFaqsWithContext is the same as ListFaqs with the addition of the ability to pass a context and additional request options.
See ListFaqs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) ListIndices ¶
func (c *Kendra) ListIndices(input *ListIndicesInput) (*ListIndicesOutput, error)
ListIndices API operation for AWSKendraFrontendService.
Lists the Amazon Kendra indexes that you have created.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation ListIndices for usage and error information.
Returned Error Types:
ValidationException
ThrottlingException
AccessDeniedException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndices
func (*Kendra) ListIndicesPages ¶
func (c *Kendra) ListIndicesPages(input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool) error
ListIndicesPages iterates over the pages of a ListIndices operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListIndices method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListIndices operation. pageNum := 0 err := client.ListIndicesPages(params, func(page *kendra.ListIndicesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*Kendra) ListIndicesPagesWithContext ¶
func (c *Kendra) ListIndicesPagesWithContext(ctx aws.Context, input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool, opts ...request.Option) error
ListIndicesPagesWithContext same as ListIndicesPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) ListIndicesRequest ¶
func (c *Kendra) ListIndicesRequest(input *ListIndicesInput) (req *request.Request, output *ListIndicesOutput)
ListIndicesRequest generates a "aws/request.Request" representing the client's request for the ListIndices operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListIndices for more information on using the ListIndices API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListIndicesRequest method. req, resp := client.ListIndicesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndices
func (*Kendra) ListIndicesWithContext ¶
func (c *Kendra) ListIndicesWithContext(ctx aws.Context, input *ListIndicesInput, opts ...request.Option) (*ListIndicesOutput, error)
ListIndicesWithContext is the same as ListIndices with the addition of the ability to pass a context and additional request options.
See ListIndices for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) Query ¶
func (c *Kendra) Query(input *QueryInput) (*QueryOutput, error)
Query API operation for AWSKendraFrontendService.
Searches an active index. Use this API to search your documents using query. The Query operation enables to do faceted search and to filter results based on document attributes.
It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.
Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.
Relevant passages
Matching FAQs
Relevant documents
You can specify that the query return only one type of result using the QueryResultTypeConfig parameter.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation Query for usage and error information.
Returned Error Types:
ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Query
func (*Kendra) QueryRequest ¶
func (c *Kendra) QueryRequest(input *QueryInput) (req *request.Request, output *QueryOutput)
QueryRequest generates a "aws/request.Request" representing the client's request for the Query operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See Query for more information on using the Query API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the QueryRequest method. req, resp := client.QueryRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Query
func (*Kendra) QueryWithContext ¶
func (c *Kendra) QueryWithContext(ctx aws.Context, input *QueryInput, opts ...request.Option) (*QueryOutput, error)
QueryWithContext is the same as Query with the addition of the ability to pass a context and additional request options.
See Query for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) StartDataSourceSyncJob ¶
func (c *Kendra) StartDataSourceSyncJob(input *StartDataSourceSyncJobInput) (*StartDataSourceSyncJobOutput, error)
StartDataSourceSyncJob API operation for AWSKendraFrontendService.
Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation StartDataSourceSyncJob for usage and error information.
Returned Error Types:
ValidationException
ResourceNotFoundException
ResourceInUseException
ThrottlingException
AccessDeniedException
ConflictException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StartDataSourceSyncJob
func (*Kendra) StartDataSourceSyncJobRequest ¶
func (c *Kendra) StartDataSourceSyncJobRequest(input *StartDataSourceSyncJobInput) (req *request.Request, output *StartDataSourceSyncJobOutput)
StartDataSourceSyncJobRequest generates a "aws/request.Request" representing the client's request for the StartDataSourceSyncJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StartDataSourceSyncJob for more information on using the StartDataSourceSyncJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StartDataSourceSyncJobRequest method. req, resp := client.StartDataSourceSyncJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StartDataSourceSyncJob
func (*Kendra) StartDataSourceSyncJobWithContext ¶
func (c *Kendra) StartDataSourceSyncJobWithContext(ctx aws.Context, input *StartDataSourceSyncJobInput, opts ...request.Option) (*StartDataSourceSyncJobOutput, error)
StartDataSourceSyncJobWithContext is the same as StartDataSourceSyncJob with the addition of the ability to pass a context and additional request options.
See StartDataSourceSyncJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) StopDataSourceSyncJob ¶
func (c *Kendra) StopDataSourceSyncJob(input *StopDataSourceSyncJobInput) (*StopDataSourceSyncJobOutput, error)
StopDataSourceSyncJob API operation for AWSKendraFrontendService.
Stops a running synchronization job. You can't stop a scheduled synchronization job.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation StopDataSourceSyncJob for usage and error information.
Returned Error Types:
ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StopDataSourceSyncJob
func (*Kendra) StopDataSourceSyncJobRequest ¶
func (c *Kendra) StopDataSourceSyncJobRequest(input *StopDataSourceSyncJobInput) (req *request.Request, output *StopDataSourceSyncJobOutput)
StopDataSourceSyncJobRequest generates a "aws/request.Request" representing the client's request for the StopDataSourceSyncJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StopDataSourceSyncJob for more information on using the StopDataSourceSyncJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StopDataSourceSyncJobRequest method. req, resp := client.StopDataSourceSyncJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StopDataSourceSyncJob
func (*Kendra) StopDataSourceSyncJobWithContext ¶
func (c *Kendra) StopDataSourceSyncJobWithContext(ctx aws.Context, input *StopDataSourceSyncJobInput, opts ...request.Option) (*StopDataSourceSyncJobOutput, error)
StopDataSourceSyncJobWithContext is the same as StopDataSourceSyncJob with the addition of the ability to pass a context and additional request options.
See StopDataSourceSyncJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) SubmitFeedback ¶
func (c *Kendra) SubmitFeedback(input *SubmitFeedbackInput) (*SubmitFeedbackOutput, error)
SubmitFeedback API operation for AWSKendraFrontendService.
Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation SubmitFeedback for usage and error information.
Returned Error Types:
ValidationException
ResourceUnavailableException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SubmitFeedback
func (*Kendra) SubmitFeedbackRequest ¶
func (c *Kendra) SubmitFeedbackRequest(input *SubmitFeedbackInput) (req *request.Request, output *SubmitFeedbackOutput)
SubmitFeedbackRequest generates a "aws/request.Request" representing the client's request for the SubmitFeedback operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See SubmitFeedback for more information on using the SubmitFeedback API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the SubmitFeedbackRequest method. req, resp := client.SubmitFeedbackRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SubmitFeedback
func (*Kendra) SubmitFeedbackWithContext ¶
func (c *Kendra) SubmitFeedbackWithContext(ctx aws.Context, input *SubmitFeedbackInput, opts ...request.Option) (*SubmitFeedbackOutput, error)
SubmitFeedbackWithContext is the same as SubmitFeedback with the addition of the ability to pass a context and additional request options.
See SubmitFeedback for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) UpdateDataSource ¶
func (c *Kendra) UpdateDataSource(input *UpdateDataSourceInput) (*UpdateDataSourceOutput, error)
UpdateDataSource API operation for AWSKendraFrontendService.
Updates an existing Amazon Kendra data source.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation UpdateDataSource for usage and error information.
Returned Error Types:
ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateDataSource
func (*Kendra) UpdateDataSourceRequest ¶
func (c *Kendra) UpdateDataSourceRequest(input *UpdateDataSourceInput) (req *request.Request, output *UpdateDataSourceOutput)
UpdateDataSourceRequest generates a "aws/request.Request" representing the client's request for the UpdateDataSource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateDataSource for more information on using the UpdateDataSource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateDataSourceRequest method. req, resp := client.UpdateDataSourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateDataSource
func (*Kendra) UpdateDataSourceWithContext ¶
func (c *Kendra) UpdateDataSourceWithContext(ctx aws.Context, input *UpdateDataSourceInput, opts ...request.Option) (*UpdateDataSourceOutput, error)
UpdateDataSourceWithContext is the same as UpdateDataSource with the addition of the ability to pass a context and additional request options.
See UpdateDataSource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Kendra) UpdateIndex ¶
func (c *Kendra) UpdateIndex(input *UpdateIndexInput) (*UpdateIndexOutput, error)
UpdateIndex API operation for AWSKendraFrontendService.
Updates an existing Amazon Kendra index.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWSKendraFrontendService's API operation UpdateIndex for usage and error information.
Returned Error Types:
ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex
func (*Kendra) UpdateIndexRequest ¶
func (c *Kendra) UpdateIndexRequest(input *UpdateIndexInput) (req *request.Request, output *UpdateIndexOutput)
UpdateIndexRequest generates a "aws/request.Request" representing the client's request for the UpdateIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateIndex for more information on using the UpdateIndex API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateIndexRequest method. req, resp := client.UpdateIndexRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex
func (*Kendra) UpdateIndexWithContext ¶
func (c *Kendra) UpdateIndexWithContext(ctx aws.Context, input *UpdateIndexInput, opts ...request.Option) (*UpdateIndexOutput, error)
UpdateIndexWithContext is the same as UpdateIndex with the addition of the ability to pass a context and additional request options.
See UpdateIndex for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type ListDataSourceSyncJobsInput ¶
type ListDataSourceSyncJobsInput struct { // The identifier of the data source. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` // The identifier of the index that contains the data source. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` // The maximum number of synchronization jobs to return in the response. If // there are fewer results in the list, this response contains only the actual // results. MaxResults *int64 `min:"1" type:"integer"` // If the result of the previous request to GetDataSourceSyncJobHistory was // truncated, include the NextToken to fetch the next set of jobs. NextToken *string `min:"1" type:"string"` // When specified, the synchronization jobs returned in the list are limited // to jobs between the specified dates. StartTimeFilter *TimeRange `type:"structure"` // When specified, only returns synchronization jobs with the Status field equal // to the specified status. StatusFilter *string `type:"string" enum:"DataSourceSyncJobStatus"` // contains filtered or unexported fields }
func (ListDataSourceSyncJobsInput) GoString ¶
func (s ListDataSourceSyncJobsInput) GoString() string
GoString returns the string representation
func (*ListDataSourceSyncJobsInput) SetId ¶
func (s *ListDataSourceSyncJobsInput) SetId(v string) *ListDataSourceSyncJobsInput
SetId sets the Id field's value.
func (*ListDataSourceSyncJobsInput) SetIndexId ¶
func (s *ListDataSourceSyncJobsInput) SetIndexId(v string) *ListDataSourceSyncJobsInput
SetIndexId sets the IndexId field's value.
func (*ListDataSourceSyncJobsInput) SetMaxResults ¶
func (s *ListDataSourceSyncJobsInput) SetMaxResults(v int64) *ListDataSourceSyncJobsInput
SetMaxResults sets the MaxResults field's value.
func (*ListDataSourceSyncJobsInput) SetNextToken ¶
func (s *ListDataSourceSyncJobsInput) SetNextToken(v string) *ListDataSourceSyncJobsInput
SetNextToken sets the NextToken field's value.
func (*ListDataSourceSyncJobsInput) SetStartTimeFilter ¶
func (s *ListDataSourceSyncJobsInput) SetStartTimeFilter(v *TimeRange) *ListDataSourceSyncJobsInput
SetStartTimeFilter sets the StartTimeFilter field's value.
func (*ListDataSourceSyncJobsInput) SetStatusFilter ¶
func (s *ListDataSourceSyncJobsInput) SetStatusFilter(v string) *ListDataSourceSyncJobsInput
SetStatusFilter sets the StatusFilter field's value.
func (ListDataSourceSyncJobsInput) String ¶
func (s ListDataSourceSyncJobsInput) String() string
String returns the string representation
func (*ListDataSourceSyncJobsInput) Validate ¶
func (s *ListDataSourceSyncJobsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListDataSourceSyncJobsOutput ¶
type ListDataSourceSyncJobsOutput struct { // A history of synchronization jobs for the data source. History []*DataSourceSyncJob `type:"list"` // The GetDataSourceSyncJobHistory operation returns a page of vocabularies // at a time. The maximum size of the page is set by the MaxResults parameter. // If there are more jobs in the list than the page size, Amazon Kendra returns // the NextPage token. Include the token in the next request to the GetDataSourceSyncJobHistory // operation to return in the next page of jobs. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (ListDataSourceSyncJobsOutput) GoString ¶
func (s ListDataSourceSyncJobsOutput) GoString() string
GoString returns the string representation
func (*ListDataSourceSyncJobsOutput) SetHistory ¶
func (s *ListDataSourceSyncJobsOutput) SetHistory(v []*DataSourceSyncJob) *ListDataSourceSyncJobsOutput
SetHistory sets the History field's value.
func (*ListDataSourceSyncJobsOutput) SetNextToken ¶
func (s *ListDataSourceSyncJobsOutput) SetNextToken(v string) *ListDataSourceSyncJobsOutput
SetNextToken sets the NextToken field's value.
func (ListDataSourceSyncJobsOutput) String ¶
func (s ListDataSourceSyncJobsOutput) String() string
String returns the string representation
type ListDataSourcesInput ¶
type ListDataSourcesInput struct { // The identifier of the index that contains the data source. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` // The maximum number of data sources to return. MaxResults *int64 `min:"1" type:"integer"` // If the previous response was incomplete (because there is more data to retrieve), // Amazon Kendra returns a pagination token in the response. You can use this // pagination token to retrieve the next set of data sources (DataSourceSummaryItems). NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (ListDataSourcesInput) GoString ¶
func (s ListDataSourcesInput) GoString() string
GoString returns the string representation
func (*ListDataSourcesInput) SetIndexId ¶
func (s *ListDataSourcesInput) SetIndexId(v string) *ListDataSourcesInput
SetIndexId sets the IndexId field's value.
func (*ListDataSourcesInput) SetMaxResults ¶
func (s *ListDataSourcesInput) SetMaxResults(v int64) *ListDataSourcesInput
SetMaxResults sets the MaxResults field's value.
func (*ListDataSourcesInput) SetNextToken ¶
func (s *ListDataSourcesInput) SetNextToken(v string) *ListDataSourcesInput
SetNextToken sets the NextToken field's value.
func (ListDataSourcesInput) String ¶
func (s ListDataSourcesInput) String() string
String returns the string representation
func (*ListDataSourcesInput) Validate ¶
func (s *ListDataSourcesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListDataSourcesOutput ¶
type ListDataSourcesOutput struct { // If the response is truncated, Amazon Kendra returns this token that you can // use in the subsequent request to retrieve the next set of data sources. NextToken *string `min:"1" type:"string"` // An array of summary information for one or more data sources. SummaryItems []*DataSourceSummary `type:"list"` // contains filtered or unexported fields }
func (ListDataSourcesOutput) GoString ¶
func (s ListDataSourcesOutput) GoString() string
GoString returns the string representation
func (*ListDataSourcesOutput) SetNextToken ¶
func (s *ListDataSourcesOutput) SetNextToken(v string) *ListDataSourcesOutput
SetNextToken sets the NextToken field's value.
func (*ListDataSourcesOutput) SetSummaryItems ¶
func (s *ListDataSourcesOutput) SetSummaryItems(v []*DataSourceSummary) *ListDataSourcesOutput
SetSummaryItems sets the SummaryItems field's value.
func (ListDataSourcesOutput) String ¶
func (s ListDataSourcesOutput) String() string
String returns the string representation
type ListFaqsInput ¶
type ListFaqsInput struct { // The index that contains the FAQ lists. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` // The maximum number of FAQs to return in the response. If there are fewer // results in the list, this response contains only the actual results. MaxResults *int64 `min:"1" type:"integer"` // If the result of the previous request to ListFaqs was truncated, include // the NextToken to fetch the next set of FAQs. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (ListFaqsInput) GoString ¶
func (s ListFaqsInput) GoString() string
GoString returns the string representation
func (*ListFaqsInput) SetIndexId ¶
func (s *ListFaqsInput) SetIndexId(v string) *ListFaqsInput
SetIndexId sets the IndexId field's value.
func (*ListFaqsInput) SetMaxResults ¶
func (s *ListFaqsInput) SetMaxResults(v int64) *ListFaqsInput
SetMaxResults sets the MaxResults field's value.
func (*ListFaqsInput) SetNextToken ¶
func (s *ListFaqsInput) SetNextToken(v string) *ListFaqsInput
SetNextToken sets the NextToken field's value.
func (ListFaqsInput) String ¶
func (s ListFaqsInput) String() string
String returns the string representation
func (*ListFaqsInput) Validate ¶
func (s *ListFaqsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListFaqsOutput ¶
type ListFaqsOutput struct { // information about the FAQs associated with the specified index. FaqSummaryItems []*FaqSummary `type:"list"` // The ListFaqs operation returns a page of FAQs at a time. The maximum size // of the page is set by the MaxResults parameter. If there are more jobs in // the list than the page size, Amazon Kendra returns the NextPage token. Include // the token in the next request to the ListFaqs operation to return the next // page of FAQs. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (ListFaqsOutput) GoString ¶
func (s ListFaqsOutput) GoString() string
GoString returns the string representation
func (*ListFaqsOutput) SetFaqSummaryItems ¶
func (s *ListFaqsOutput) SetFaqSummaryItems(v []*FaqSummary) *ListFaqsOutput
SetFaqSummaryItems sets the FaqSummaryItems field's value.
func (*ListFaqsOutput) SetNextToken ¶
func (s *ListFaqsOutput) SetNextToken(v string) *ListFaqsOutput
SetNextToken sets the NextToken field's value.
func (ListFaqsOutput) String ¶
func (s ListFaqsOutput) String() string
String returns the string representation
type ListIndicesInput ¶
type ListIndicesInput struct { // The maximum number of data sources to return. MaxResults *int64 `min:"1" type:"integer"` // If the previous response was incomplete (because there is more data to retrieve), // Amazon Kendra returns a pagination token in the response. You can use this // pagination token to retrieve the next set of indexes (DataSourceSummaryItems). NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (ListIndicesInput) GoString ¶
func (s ListIndicesInput) GoString() string
GoString returns the string representation
func (*ListIndicesInput) SetMaxResults ¶
func (s *ListIndicesInput) SetMaxResults(v int64) *ListIndicesInput
SetMaxResults sets the MaxResults field's value.
func (*ListIndicesInput) SetNextToken ¶
func (s *ListIndicesInput) SetNextToken(v string) *ListIndicesInput
SetNextToken sets the NextToken field's value.
func (ListIndicesInput) String ¶
func (s ListIndicesInput) String() string
String returns the string representation
func (*ListIndicesInput) Validate ¶
func (s *ListIndicesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListIndicesOutput ¶
type ListIndicesOutput struct { // An array of summary information for one or more indexes. IndexConfigurationSummaryItems []*IndexConfigurationSummary `type:"list"` // If the response is truncated, Amazon Kendra returns this token that you can // use in the subsequent request to retrieve the next set of indexes. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (ListIndicesOutput) GoString ¶
func (s ListIndicesOutput) GoString() string
GoString returns the string representation
func (*ListIndicesOutput) SetIndexConfigurationSummaryItems ¶
func (s *ListIndicesOutput) SetIndexConfigurationSummaryItems(v []*IndexConfigurationSummary) *ListIndicesOutput
SetIndexConfigurationSummaryItems sets the IndexConfigurationSummaryItems field's value.
func (*ListIndicesOutput) SetNextToken ¶
func (s *ListIndicesOutput) SetNextToken(v string) *ListIndicesOutput
SetNextToken sets the NextToken field's value.
func (ListIndicesOutput) String ¶
func (s ListIndicesOutput) String() string
String returns the string representation
type Principal ¶
type Principal struct { // Whether to allow or deny access to the principal. // // Access is a required field Access *string `type:"string" required:"true" enum:"ReadAccessType"` // The name of the user or group. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // The type of principal. // // Type is a required field Type *string `type:"string" required:"true" enum:"PrincipalType"` // contains filtered or unexported fields }
Provides user and group information for document access filtering.
type QueryInput ¶
type QueryInput struct { // Enables filtered searches based on document attributes. You can only provide // one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters // parameters contain a list of other filters. // // The AttributeFilter parameter enables you to create a set of filtering rules // that a document must satisfy to be included in the query results. AttributeFilter *AttributeFilter `type:"structure"` // An array of documents attributes. Amazon Kendra returns a count for each // attribute key specified. You can use this information to help narrow the // search for your user. Facets []*Facet `type:"list"` // The unique identifier of the index to search. The identifier is returned // in the response from the operation. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` // Query results are returned in pages the size of the PageSize parameter. By // default, Amazon Kendra returns the first page of results. Use this parameter // to get result pages after the first one. PageNumber *int64 `type:"integer"` // Sets the number of results that are returned in each page of results. The // default page size is 100. PageSize *int64 `type:"integer"` // Sets the type of query. Only results for the specified query type are returned. QueryResultTypeFilter *string `type:"string" enum:"QueryResultType"` // The text to search for. // // QueryText is a required field QueryText *string `min:"1" type:"string" required:"true"` // An array of document attributes to include in the response. No other document // attributes are included in the response. By default all document attributes // are included in the response. RequestedDocumentAttributes []*string `min:"1" type:"list"` // contains filtered or unexported fields }
func (QueryInput) GoString ¶
func (s QueryInput) GoString() string
GoString returns the string representation
func (*QueryInput) SetAttributeFilter ¶
func (s *QueryInput) SetAttributeFilter(v *AttributeFilter) *QueryInput
SetAttributeFilter sets the AttributeFilter field's value.
func (*QueryInput) SetFacets ¶
func (s *QueryInput) SetFacets(v []*Facet) *QueryInput
SetFacets sets the Facets field's value.
func (*QueryInput) SetIndexId ¶
func (s *QueryInput) SetIndexId(v string) *QueryInput
SetIndexId sets the IndexId field's value.
func (*QueryInput) SetPageNumber ¶
func (s *QueryInput) SetPageNumber(v int64) *QueryInput
SetPageNumber sets the PageNumber field's value.
func (*QueryInput) SetPageSize ¶
func (s *QueryInput) SetPageSize(v int64) *QueryInput
SetPageSize sets the PageSize field's value.
func (*QueryInput) SetQueryResultTypeFilter ¶
func (s *QueryInput) SetQueryResultTypeFilter(v string) *QueryInput
SetQueryResultTypeFilter sets the QueryResultTypeFilter field's value.
func (*QueryInput) SetQueryText ¶
func (s *QueryInput) SetQueryText(v string) *QueryInput
SetQueryText sets the QueryText field's value.
func (*QueryInput) SetRequestedDocumentAttributes ¶
func (s *QueryInput) SetRequestedDocumentAttributes(v []*string) *QueryInput
SetRequestedDocumentAttributes sets the RequestedDocumentAttributes field's value.
func (QueryInput) String ¶
func (s QueryInput) String() string
String returns the string representation
func (*QueryInput) Validate ¶
func (s *QueryInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type QueryOutput ¶
type QueryOutput struct { // Contains the facet results. A FacetResult contains the counts for each attribute // key that was specified in the Facets input parameter. FacetResults []*FacetResult `type:"list"` // The unique identifier for the search. You use QueryId to identify the search // when using the feedback API. QueryId *string `min:"1" type:"string"` // The results of the search. ResultItems []*QueryResultItem `type:"list"` // The number of items returned by the search. Use this to determine when you // have requested the last set of results. TotalNumberOfResults *int64 `type:"integer"` // contains filtered or unexported fields }
func (QueryOutput) GoString ¶
func (s QueryOutput) GoString() string
GoString returns the string representation
func (*QueryOutput) SetFacetResults ¶
func (s *QueryOutput) SetFacetResults(v []*FacetResult) *QueryOutput
SetFacetResults sets the FacetResults field's value.
func (*QueryOutput) SetQueryId ¶
func (s *QueryOutput) SetQueryId(v string) *QueryOutput
SetQueryId sets the QueryId field's value.
func (*QueryOutput) SetResultItems ¶
func (s *QueryOutput) SetResultItems(v []*QueryResultItem) *QueryOutput
SetResultItems sets the ResultItems field's value.
func (*QueryOutput) SetTotalNumberOfResults ¶
func (s *QueryOutput) SetTotalNumberOfResults(v int64) *QueryOutput
SetTotalNumberOfResults sets the TotalNumberOfResults field's value.
func (QueryOutput) String ¶
func (s QueryOutput) String() string
String returns the string representation
type QueryResultItem ¶
type QueryResultItem struct { AdditionalAttributes []*AdditionalResultAttribute `type:"list"` // An array of document attributes for the document that the query result maps // to. For example, the document author (Author) or the source URI (SourceUri) // of the document. DocumentAttributes []*DocumentAttribute `min:"1" type:"list"` // An extract of the text in the document. Contains information about highlighting // the relevant terms in the excerpt. DocumentExcerpt *TextWithHighlights `type:"structure"` // The unique identifier for the document. DocumentId *string `min:"1" type:"string"` // The title of the document. Contains the text of the title and information // for highlighting the relevant terms in the title. DocumentTitle *TextWithHighlights `type:"structure"` // The URI of the original location of the document. DocumentURI *string `min:"1" type:"string"` // The unique identifier for the query result. Id *string `min:"1" type:"string"` // The type of document. Type *string `type:"string" enum:"QueryResultType"` // contains filtered or unexported fields }
A single query result.
A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.
func (QueryResultItem) GoString ¶
func (s QueryResultItem) GoString() string
GoString returns the string representation
func (*QueryResultItem) SetAdditionalAttributes ¶
func (s *QueryResultItem) SetAdditionalAttributes(v []*AdditionalResultAttribute) *QueryResultItem
SetAdditionalAttributes sets the AdditionalAttributes field's value.
func (*QueryResultItem) SetDocumentAttributes ¶
func (s *QueryResultItem) SetDocumentAttributes(v []*DocumentAttribute) *QueryResultItem
SetDocumentAttributes sets the DocumentAttributes field's value.
func (*QueryResultItem) SetDocumentExcerpt ¶
func (s *QueryResultItem) SetDocumentExcerpt(v *TextWithHighlights) *QueryResultItem
SetDocumentExcerpt sets the DocumentExcerpt field's value.
func (*QueryResultItem) SetDocumentId ¶
func (s *QueryResultItem) SetDocumentId(v string) *QueryResultItem
SetDocumentId sets the DocumentId field's value.
func (*QueryResultItem) SetDocumentTitle ¶
func (s *QueryResultItem) SetDocumentTitle(v *TextWithHighlights) *QueryResultItem
SetDocumentTitle sets the DocumentTitle field's value.
func (*QueryResultItem) SetDocumentURI ¶
func (s *QueryResultItem) SetDocumentURI(v string) *QueryResultItem
SetDocumentURI sets the DocumentURI field's value.
func (*QueryResultItem) SetId ¶
func (s *QueryResultItem) SetId(v string) *QueryResultItem
SetId sets the Id field's value.
func (*QueryResultItem) SetType ¶
func (s *QueryResultItem) SetType(v string) *QueryResultItem
SetType sets the Type field's value.
func (QueryResultItem) String ¶
func (s QueryResultItem) String() string
String returns the string representation
type Relevance ¶
type Relevance struct { // Specifies the time period that the boost applies to. For example, to make // the boost apply to documents with the field value within the last month, // you would use "2628000s". Once the field value is beyond the specified range, // the effect of the boost drops off. The higher the importance, the faster // the effect drops off. If you don't specify a value, the default is 3 months. // The value of the field is a numeric string followed by the character "s", // for example "86400s" for one day, or "604800s" for one week. // // Only applies to DATE fields. Duration *string `min:"1" type:"string"` // Indicates that this field determines how "fresh" a document is. For example, // if document 1 was created on November 5, and document 2 was created on October // 31, document 1 is "fresher" than document 2. You can only set the Freshness // field on one DATE type field. Only applies to DATE fields. Freshness *bool `type:"boolean"` // The relative importance of the field in the search. Larger numbers provide // more of a boost than smaller numbers. Importance *int64 `min:"1" type:"integer"` // Determines how values should be interpreted. // // When the RankOrder field is ASCENDING, higher numbers are better. For example, // a document with a rating score of 10 is higher ranking than a document with // a rating score of 1. // // When the RankOrder field is DESCENDING, lower numbers are better. For example, // in a task tracking application, a priority 1 task is more important than // a priority 5 task. // // Only applies to LONG and DOUBLE fields. RankOrder *string `type:"string" enum:"Order"` // A list of values that should be given a different boost when they appear // in the result list. For example, if you are boosting a field called "department," // query terms that match the department field are boosted in the result. However, // you can add entries from the department field to boost documents with those // values higher. // // For example, you can add entries to the map with names of departments. If // you add "HR",5 and "Legal",3 those departments are given special attention // when they appear in the metadata of a document. When those terms appear they // are given the specified importance instead of the regular importance for // the boost. ValueImportanceMap map[string]*int64 `type:"map"` // contains filtered or unexported fields }
Provides information for manually tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.
func (*Relevance) SetDuration ¶
SetDuration sets the Duration field's value.
func (*Relevance) SetFreshness ¶
SetFreshness sets the Freshness field's value.
func (*Relevance) SetImportance ¶
SetImportance sets the Importance field's value.
func (*Relevance) SetRankOrder ¶
SetRankOrder sets the RankOrder field's value.
func (*Relevance) SetValueImportanceMap ¶
SetValueImportanceMap sets the ValueImportanceMap field's value.
type RelevanceFeedback ¶
type RelevanceFeedback struct { // Whether to document was relevant or not relevant to the search. // // RelevanceValue is a required field RelevanceValue *string `type:"string" required:"true" enum:"RelevanceType"` // The unique identifier of the search result that the user provided relevance // feedback for. // // ResultId is a required field ResultId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Provides feedback on how relevant a document is to a search. Your application uses the SubmitFeedback operation to provide relevance information.
func (RelevanceFeedback) GoString ¶
func (s RelevanceFeedback) GoString() string
GoString returns the string representation
func (*RelevanceFeedback) SetRelevanceValue ¶
func (s *RelevanceFeedback) SetRelevanceValue(v string) *RelevanceFeedback
SetRelevanceValue sets the RelevanceValue field's value.
func (*RelevanceFeedback) SetResultId ¶
func (s *RelevanceFeedback) SetResultId(v string) *RelevanceFeedback
SetResultId sets the ResultId field's value.
func (RelevanceFeedback) String ¶
func (s RelevanceFeedback) String() string
String returns the string representation
func (*RelevanceFeedback) Validate ¶
func (s *RelevanceFeedback) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ResourceAlreadyExistException ¶ added in v1.28.0
type ResourceAlreadyExistException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"string"` // contains filtered or unexported fields }
func (ResourceAlreadyExistException) Code ¶ added in v1.28.0
func (s ResourceAlreadyExistException) Code() string
Code returns the exception type name.
func (ResourceAlreadyExistException) Error ¶ added in v1.28.0
func (s ResourceAlreadyExistException) Error() string
func (ResourceAlreadyExistException) GoString ¶ added in v1.28.0
func (s ResourceAlreadyExistException) GoString() string
GoString returns the string representation
func (ResourceAlreadyExistException) Message ¶ added in v1.28.0
func (s ResourceAlreadyExistException) Message() string
Message returns the exception's message.
func (ResourceAlreadyExistException) OrigErr ¶ added in v1.28.0
func (s ResourceAlreadyExistException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (ResourceAlreadyExistException) RequestID ¶ added in v1.28.0
func (s ResourceAlreadyExistException) RequestID() string
RequestID returns the service's response RequestID for request.
func (ResourceAlreadyExistException) StatusCode ¶ added in v1.28.0
func (s ResourceAlreadyExistException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ResourceAlreadyExistException) String ¶ added in v1.28.0
func (s ResourceAlreadyExistException) String() string
String returns the string representation
type ResourceInUseException ¶ added in v1.28.0
type ResourceInUseException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"string"` // contains filtered or unexported fields }
func (ResourceInUseException) Code ¶ added in v1.28.0
func (s ResourceInUseException) Code() string
Code returns the exception type name.
func (ResourceInUseException) Error ¶ added in v1.28.0
func (s ResourceInUseException) Error() string
func (ResourceInUseException) GoString ¶ added in v1.28.0
func (s ResourceInUseException) GoString() string
GoString returns the string representation
func (ResourceInUseException) Message ¶ added in v1.28.0
func (s ResourceInUseException) Message() string
Message returns the exception's message.
func (ResourceInUseException) OrigErr ¶ added in v1.28.0
func (s ResourceInUseException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (ResourceInUseException) RequestID ¶ added in v1.28.0
func (s ResourceInUseException) RequestID() string
RequestID returns the service's response RequestID for request.
func (ResourceInUseException) StatusCode ¶ added in v1.28.0
func (s ResourceInUseException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ResourceInUseException) String ¶ added in v1.28.0
func (s ResourceInUseException) String() string
String returns the string representation
type ResourceNotFoundException ¶ added in v1.28.0
type ResourceNotFoundException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"string"` // contains filtered or unexported fields }
func (ResourceNotFoundException) Code ¶ added in v1.28.0
func (s ResourceNotFoundException) Code() string
Code returns the exception type name.
func (ResourceNotFoundException) Error ¶ added in v1.28.0
func (s ResourceNotFoundException) Error() string
func (ResourceNotFoundException) GoString ¶ added in v1.28.0
func (s ResourceNotFoundException) GoString() string
GoString returns the string representation
func (ResourceNotFoundException) Message ¶ added in v1.28.0
func (s ResourceNotFoundException) Message() string
Message returns the exception's message.
func (ResourceNotFoundException) OrigErr ¶ added in v1.28.0
func (s ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (ResourceNotFoundException) RequestID ¶ added in v1.28.0
func (s ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (ResourceNotFoundException) StatusCode ¶ added in v1.28.0
func (s ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ResourceNotFoundException) String ¶ added in v1.28.0
func (s ResourceNotFoundException) String() string
String returns the string representation
type ResourceUnavailableException ¶ added in v1.28.0
type ResourceUnavailableException struct { // contains filtered or unexported fields }
func (ResourceUnavailableException) Code ¶ added in v1.28.0
func (s ResourceUnavailableException) Code() string
Code returns the exception type name.
func (ResourceUnavailableException) Error ¶ added in v1.28.0
func (s ResourceUnavailableException) Error() string
func (ResourceUnavailableException) GoString ¶ added in v1.28.0
func (s ResourceUnavailableException) GoString() string
GoString returns the string representation
func (ResourceUnavailableException) Message ¶ added in v1.28.0
func (s ResourceUnavailableException) Message() string
Message returns the exception's message.
func (ResourceUnavailableException) OrigErr ¶ added in v1.28.0
func (s ResourceUnavailableException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (ResourceUnavailableException) RequestID ¶ added in v1.28.0
func (s ResourceUnavailableException) RequestID() string
RequestID returns the service's response RequestID for request.
func (ResourceUnavailableException) StatusCode ¶ added in v1.28.0
func (s ResourceUnavailableException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ResourceUnavailableException) String ¶ added in v1.28.0
func (s ResourceUnavailableException) String() string
String returns the string representation
type S3DataSourceConfiguration ¶
type S3DataSourceConfiguration struct { // Provides the path to the S3 bucket that contains the user context filtering // files for the data source. AccessControlListConfiguration *AccessControlListConfiguration `type:"structure"` // The name of the bucket that contains the documents. // // BucketName is a required field BucketName *string `min:"3" type:"string" required:"true"` // Document metadata files that contain information such as the document access // control information, source URI, document author, and custom attributes. // Each metadata file contains metadata about a single document. DocumentsMetadataConfiguration *DocumentsMetadataConfiguration `type:"structure"` // A list of glob patterns for documents that should not be indexed. If a document // that matches an inclusion prefix also matches an exclusion pattern, the document // is not indexed. // // For more information about glob patterns, see glob (programming) (http://wikipedia.org/wiki/Glob_%28programming%29) // in Wikipedia. ExclusionPatterns []*string `type:"list"` // A list of S3 prefixes for the documents that should be included in the index. InclusionPrefixes []*string `type:"list"` // contains filtered or unexported fields }
Provides configuration information for a data source to index documents in an Amazon S3 bucket.
func (S3DataSourceConfiguration) GoString ¶
func (s S3DataSourceConfiguration) GoString() string
GoString returns the string representation
func (*S3DataSourceConfiguration) SetAccessControlListConfiguration ¶
func (s *S3DataSourceConfiguration) SetAccessControlListConfiguration(v *AccessControlListConfiguration) *S3DataSourceConfiguration
SetAccessControlListConfiguration sets the AccessControlListConfiguration field's value.
func (*S3DataSourceConfiguration) SetBucketName ¶
func (s *S3DataSourceConfiguration) SetBucketName(v string) *S3DataSourceConfiguration
SetBucketName sets the BucketName field's value.
func (*S3DataSourceConfiguration) SetDocumentsMetadataConfiguration ¶
func (s *S3DataSourceConfiguration) SetDocumentsMetadataConfiguration(v *DocumentsMetadataConfiguration) *S3DataSourceConfiguration
SetDocumentsMetadataConfiguration sets the DocumentsMetadataConfiguration field's value.
func (*S3DataSourceConfiguration) SetExclusionPatterns ¶
func (s *S3DataSourceConfiguration) SetExclusionPatterns(v []*string) *S3DataSourceConfiguration
SetExclusionPatterns sets the ExclusionPatterns field's value.
func (*S3DataSourceConfiguration) SetInclusionPrefixes ¶
func (s *S3DataSourceConfiguration) SetInclusionPrefixes(v []*string) *S3DataSourceConfiguration
SetInclusionPrefixes sets the InclusionPrefixes field's value.
func (S3DataSourceConfiguration) String ¶
func (s S3DataSourceConfiguration) String() string
String returns the string representation
func (*S3DataSourceConfiguration) Validate ¶
func (s *S3DataSourceConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type S3Path ¶
type S3Path struct { // The name of the S3 bucket that contains the file. // // Bucket is a required field Bucket *string `min:"3" type:"string" required:"true"` // The name of the file. // // Key is a required field Key *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Information required to find a specific file in an Amazon S3 bucket.
type Search ¶
type Search struct { // Determines whether the field is returned in the query response. The default // is true. Displayable *bool `type:"boolean"` // Indicates that the field can be used to create search facets, a count of // results for each value in the field. The default is false . Facetable *bool `type:"boolean"` // Determines whether the field is used in the search. If the Searchable field // is true, you can use relevance tuning to manually tune how Amazon Kendra // weights the field in the search. The default is true for string fields and // false for number and date fields. Searchable *bool `type:"boolean"` // contains filtered or unexported fields }
Provides information about how a custom index field is used during a search.
func (*Search) SetDisplayable ¶
SetDisplayable sets the Displayable field's value.
func (*Search) SetFacetable ¶
SetFacetable sets the Facetable field's value.
func (*Search) SetSearchable ¶
SetSearchable sets the Searchable field's value.
type ServerSideEncryptionConfiguration ¶
type ServerSideEncryptionConfiguration struct { // The identifier of the AWS KMS customer master key (CMK). Amazon Kendra doesn't // support asymmetric CMKs. KmsKeyId *string `min:"1" type:"string" sensitive:"true"` // contains filtered or unexported fields }
Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.
func (ServerSideEncryptionConfiguration) GoString ¶
func (s ServerSideEncryptionConfiguration) GoString() string
GoString returns the string representation
func (*ServerSideEncryptionConfiguration) SetKmsKeyId ¶
func (s *ServerSideEncryptionConfiguration) SetKmsKeyId(v string) *ServerSideEncryptionConfiguration
SetKmsKeyId sets the KmsKeyId field's value.
func (ServerSideEncryptionConfiguration) String ¶
func (s ServerSideEncryptionConfiguration) String() string
String returns the string representation
func (*ServerSideEncryptionConfiguration) Validate ¶
func (s *ServerSideEncryptionConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ServiceQuotaExceededException ¶ added in v1.28.0
type ServiceQuotaExceededException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"string"` // contains filtered or unexported fields }
func (ServiceQuotaExceededException) Code ¶ added in v1.28.0
func (s ServiceQuotaExceededException) Code() string
Code returns the exception type name.
func (ServiceQuotaExceededException) Error ¶ added in v1.28.0
func (s ServiceQuotaExceededException) Error() string
func (ServiceQuotaExceededException) GoString ¶ added in v1.28.0
func (s ServiceQuotaExceededException) GoString() string
GoString returns the string representation
func (ServiceQuotaExceededException) Message ¶ added in v1.28.0
func (s ServiceQuotaExceededException) Message() string
Message returns the exception's message.
func (ServiceQuotaExceededException) OrigErr ¶ added in v1.28.0
func (s ServiceQuotaExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (ServiceQuotaExceededException) RequestID ¶ added in v1.28.0
func (s ServiceQuotaExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (ServiceQuotaExceededException) StatusCode ¶ added in v1.28.0
func (s ServiceQuotaExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ServiceQuotaExceededException) String ¶ added in v1.28.0
func (s ServiceQuotaExceededException) String() string
String returns the string representation
type SharePointConfiguration ¶
type SharePointConfiguration struct { // site in the index; otherwise, FALSE. CrawlAttachments *bool `type:"boolean"` DocumentTitleFieldName *string `min:"1" type:"string"` // attributes to custom fields in the Amazon Kendra index. You must first create // the index fields using the operation before you map SharePoint attributes. // For more information, see Mapping Data Source Fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"` // The credentials should be a user/password pair. For more information, see // Using a Microsoft SharePoint Data Source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html). // For more information about AWS Secrets Manager, see What Is AWS Secrets Manager // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) // in the AWS Secrets Manager user guide. // // SecretArn is a required field SecretArn *string `min:"1" type:"string" required:"true"` // // SharePointVersion is a required field SharePointVersion *string `type:"string" required:"true" enum:"SharePointVersion"` // should be indexed. // // Urls is a required field Urls []*string `min:"1" type:"list" required:"true"` VpcConfiguration *DataSourceVpcConfiguration `type:"structure"` // contains filtered or unexported fields }
Provides configuration information for connecting to a Microsoft SharePoint data source.
func (SharePointConfiguration) GoString ¶
func (s SharePointConfiguration) GoString() string
GoString returns the string representation
func (*SharePointConfiguration) SetCrawlAttachments ¶
func (s *SharePointConfiguration) SetCrawlAttachments(v bool) *SharePointConfiguration
SetCrawlAttachments sets the CrawlAttachments field's value.
func (*SharePointConfiguration) SetDocumentTitleFieldName ¶ added in v1.25.50
func (s *SharePointConfiguration) SetDocumentTitleFieldName(v string) *SharePointConfiguration
SetDocumentTitleFieldName sets the DocumentTitleFieldName field's value.
func (*SharePointConfiguration) SetFieldMappings ¶
func (s *SharePointConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *SharePointConfiguration
SetFieldMappings sets the FieldMappings field's value.
func (*SharePointConfiguration) SetSecretArn ¶
func (s *SharePointConfiguration) SetSecretArn(v string) *SharePointConfiguration
SetSecretArn sets the SecretArn field's value.
func (*SharePointConfiguration) SetSharePointVersion ¶
func (s *SharePointConfiguration) SetSharePointVersion(v string) *SharePointConfiguration
SetSharePointVersion sets the SharePointVersion field's value.
func (*SharePointConfiguration) SetUrls ¶
func (s *SharePointConfiguration) SetUrls(v []*string) *SharePointConfiguration
SetUrls sets the Urls field's value.
func (*SharePointConfiguration) SetVpcConfiguration ¶
func (s *SharePointConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *SharePointConfiguration
SetVpcConfiguration sets the VpcConfiguration field's value.
func (SharePointConfiguration) String ¶
func (s SharePointConfiguration) String() string
String returns the string representation
func (*SharePointConfiguration) Validate ¶
func (s *SharePointConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartDataSourceSyncJobInput ¶
type StartDataSourceSyncJobInput struct { // The identifier of the data source to synchronize. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` // The identifier of the index that contains the data source. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (StartDataSourceSyncJobInput) GoString ¶
func (s StartDataSourceSyncJobInput) GoString() string
GoString returns the string representation
func (*StartDataSourceSyncJobInput) SetId ¶
func (s *StartDataSourceSyncJobInput) SetId(v string) *StartDataSourceSyncJobInput
SetId sets the Id field's value.
func (*StartDataSourceSyncJobInput) SetIndexId ¶
func (s *StartDataSourceSyncJobInput) SetIndexId(v string) *StartDataSourceSyncJobInput
SetIndexId sets the IndexId field's value.
func (StartDataSourceSyncJobInput) String ¶
func (s StartDataSourceSyncJobInput) String() string
String returns the string representation
func (*StartDataSourceSyncJobInput) Validate ¶
func (s *StartDataSourceSyncJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartDataSourceSyncJobOutput ¶
type StartDataSourceSyncJobOutput struct { // Identifies a particular synchronization job. ExecutionId *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (StartDataSourceSyncJobOutput) GoString ¶
func (s StartDataSourceSyncJobOutput) GoString() string
GoString returns the string representation
func (*StartDataSourceSyncJobOutput) SetExecutionId ¶
func (s *StartDataSourceSyncJobOutput) SetExecutionId(v string) *StartDataSourceSyncJobOutput
SetExecutionId sets the ExecutionId field's value.
func (StartDataSourceSyncJobOutput) String ¶
func (s StartDataSourceSyncJobOutput) String() string
String returns the string representation
type StopDataSourceSyncJobInput ¶
type StopDataSourceSyncJobInput struct { // The identifier of the data source for which to stop the synchronization jobs. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` // The identifier of the index that contains the data source. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (StopDataSourceSyncJobInput) GoString ¶
func (s StopDataSourceSyncJobInput) GoString() string
GoString returns the string representation
func (*StopDataSourceSyncJobInput) SetId ¶
func (s *StopDataSourceSyncJobInput) SetId(v string) *StopDataSourceSyncJobInput
SetId sets the Id field's value.
func (*StopDataSourceSyncJobInput) SetIndexId ¶
func (s *StopDataSourceSyncJobInput) SetIndexId(v string) *StopDataSourceSyncJobInput
SetIndexId sets the IndexId field's value.
func (StopDataSourceSyncJobInput) String ¶
func (s StopDataSourceSyncJobInput) String() string
String returns the string representation
func (*StopDataSourceSyncJobInput) Validate ¶
func (s *StopDataSourceSyncJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StopDataSourceSyncJobOutput ¶
type StopDataSourceSyncJobOutput struct {
// contains filtered or unexported fields
}
func (StopDataSourceSyncJobOutput) GoString ¶
func (s StopDataSourceSyncJobOutput) GoString() string
GoString returns the string representation
func (StopDataSourceSyncJobOutput) String ¶
func (s StopDataSourceSyncJobOutput) String() string
String returns the string representation
type SubmitFeedbackInput ¶
type SubmitFeedbackInput struct { // Tells Amazon Kendra that a particular search result link was chosen by the // user. ClickFeedbackItems []*ClickFeedback `type:"list"` // The identifier of the index that was queried. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` // The identifier of the specific query for which you are submitting feedback. // The query ID is returned in the response to the operation. // // QueryId is a required field QueryId *string `min:"1" type:"string" required:"true"` // Provides Amazon Kendra with relevant or not relevant feedback for whether // a particular item was relevant to the search. RelevanceFeedbackItems []*RelevanceFeedback `type:"list"` // contains filtered or unexported fields }
func (SubmitFeedbackInput) GoString ¶
func (s SubmitFeedbackInput) GoString() string
GoString returns the string representation
func (*SubmitFeedbackInput) SetClickFeedbackItems ¶
func (s *SubmitFeedbackInput) SetClickFeedbackItems(v []*ClickFeedback) *SubmitFeedbackInput
SetClickFeedbackItems sets the ClickFeedbackItems field's value.
func (*SubmitFeedbackInput) SetIndexId ¶
func (s *SubmitFeedbackInput) SetIndexId(v string) *SubmitFeedbackInput
SetIndexId sets the IndexId field's value.
func (*SubmitFeedbackInput) SetQueryId ¶
func (s *SubmitFeedbackInput) SetQueryId(v string) *SubmitFeedbackInput
SetQueryId sets the QueryId field's value.
func (*SubmitFeedbackInput) SetRelevanceFeedbackItems ¶
func (s *SubmitFeedbackInput) SetRelevanceFeedbackItems(v []*RelevanceFeedback) *SubmitFeedbackInput
SetRelevanceFeedbackItems sets the RelevanceFeedbackItems field's value.
func (SubmitFeedbackInput) String ¶
func (s SubmitFeedbackInput) String() string
String returns the string representation
func (*SubmitFeedbackInput) Validate ¶
func (s *SubmitFeedbackInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SubmitFeedbackOutput ¶
type SubmitFeedbackOutput struct {
// contains filtered or unexported fields
}
func (SubmitFeedbackOutput) GoString ¶
func (s SubmitFeedbackOutput) GoString() string
GoString returns the string representation
func (SubmitFeedbackOutput) String ¶
func (s SubmitFeedbackOutput) String() string
String returns the string representation
type TextDocumentStatistics ¶
type TextDocumentStatistics struct { // The number of text documents indexed. // // IndexedTextDocumentsCount is a required field IndexedTextDocumentsCount *int64 `type:"integer" required:"true"` // contains filtered or unexported fields }
Provides information about text documents indexed in an index.
func (TextDocumentStatistics) GoString ¶
func (s TextDocumentStatistics) GoString() string
GoString returns the string representation
func (*TextDocumentStatistics) SetIndexedTextDocumentsCount ¶
func (s *TextDocumentStatistics) SetIndexedTextDocumentsCount(v int64) *TextDocumentStatistics
SetIndexedTextDocumentsCount sets the IndexedTextDocumentsCount field's value.
func (TextDocumentStatistics) String ¶
func (s TextDocumentStatistics) String() string
String returns the string representation
type TextWithHighlights ¶
type TextWithHighlights struct { // The beginning and end of the text that should be highlighted. Highlights []*Highlight `type:"list"` // The text to display to the user. Text *string `min:"1" type:"string"` // contains filtered or unexported fields }
Provides text and information about where to highlight the text.
func (TextWithHighlights) GoString ¶
func (s TextWithHighlights) GoString() string
GoString returns the string representation
func (*TextWithHighlights) SetHighlights ¶
func (s *TextWithHighlights) SetHighlights(v []*Highlight) *TextWithHighlights
SetHighlights sets the Highlights field's value.
func (*TextWithHighlights) SetText ¶
func (s *TextWithHighlights) SetText(v string) *TextWithHighlights
SetText sets the Text field's value.
func (TextWithHighlights) String ¶
func (s TextWithHighlights) String() string
String returns the string representation
type ThrottlingException ¶ added in v1.28.0
type ThrottlingException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"string"` // contains filtered or unexported fields }
func (ThrottlingException) Code ¶ added in v1.28.0
func (s ThrottlingException) Code() string
Code returns the exception type name.
func (ThrottlingException) Error ¶ added in v1.28.0
func (s ThrottlingException) Error() string
func (ThrottlingException) GoString ¶ added in v1.28.0
func (s ThrottlingException) GoString() string
GoString returns the string representation
func (ThrottlingException) Message ¶ added in v1.28.0
func (s ThrottlingException) Message() string
Message returns the exception's message.
func (ThrottlingException) OrigErr ¶ added in v1.28.0
func (s ThrottlingException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (ThrottlingException) RequestID ¶ added in v1.28.0
func (s ThrottlingException) RequestID() string
RequestID returns the service's response RequestID for request.
func (ThrottlingException) StatusCode ¶ added in v1.28.0
func (s ThrottlingException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ThrottlingException) String ¶ added in v1.28.0
func (s ThrottlingException) String() string
String returns the string representation
type TimeRange ¶
type TimeRange struct { // The UNIX datetime of the end of the time range. EndTime *time.Time `type:"timestamp"` // The UNIX datetime of the beginning of the time range. StartTime *time.Time `type:"timestamp"` // contains filtered or unexported fields }
Provides a range of time.
func (*TimeRange) SetEndTime ¶
SetEndTime sets the EndTime field's value.
func (*TimeRange) SetStartTime ¶
SetStartTime sets the StartTime field's value.
type UpdateDataSourceInput ¶
type UpdateDataSourceInput struct { // Configuration information for a Amazon Kendra data source. Configuration *DataSourceConfiguration `type:"structure"` // The new description for the data source. Description *string `min:"1" type:"string"` // The unique identifier of the data source to update. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` // The identifier of the index that contains the data source to update. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` // The name of the data source to update. The name of the data source can't // be updated. To rename a data source you must delete the data source and re-create // it. Name *string `min:"1" type:"string"` // The Amazon Resource Name (ARN) of the new role to use when the data source // is accessing resources on your behalf. RoleArn *string `min:"1" type:"string"` // The new update schedule for the data source. Schedule *string `type:"string"` // contains filtered or unexported fields }
func (UpdateDataSourceInput) GoString ¶
func (s UpdateDataSourceInput) GoString() string
GoString returns the string representation
func (*UpdateDataSourceInput) SetConfiguration ¶
func (s *UpdateDataSourceInput) SetConfiguration(v *DataSourceConfiguration) *UpdateDataSourceInput
SetConfiguration sets the Configuration field's value.
func (*UpdateDataSourceInput) SetDescription ¶
func (s *UpdateDataSourceInput) SetDescription(v string) *UpdateDataSourceInput
SetDescription sets the Description field's value.
func (*UpdateDataSourceInput) SetId ¶
func (s *UpdateDataSourceInput) SetId(v string) *UpdateDataSourceInput
SetId sets the Id field's value.
func (*UpdateDataSourceInput) SetIndexId ¶
func (s *UpdateDataSourceInput) SetIndexId(v string) *UpdateDataSourceInput
SetIndexId sets the IndexId field's value.
func (*UpdateDataSourceInput) SetName ¶
func (s *UpdateDataSourceInput) SetName(v string) *UpdateDataSourceInput
SetName sets the Name field's value.
func (*UpdateDataSourceInput) SetRoleArn ¶
func (s *UpdateDataSourceInput) SetRoleArn(v string) *UpdateDataSourceInput
SetRoleArn sets the RoleArn field's value.
func (*UpdateDataSourceInput) SetSchedule ¶
func (s *UpdateDataSourceInput) SetSchedule(v string) *UpdateDataSourceInput
SetSchedule sets the Schedule field's value.
func (UpdateDataSourceInput) String ¶
func (s UpdateDataSourceInput) String() string
String returns the string representation
func (*UpdateDataSourceInput) Validate ¶
func (s *UpdateDataSourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateDataSourceOutput ¶
type UpdateDataSourceOutput struct {
// contains filtered or unexported fields
}
func (UpdateDataSourceOutput) GoString ¶
func (s UpdateDataSourceOutput) GoString() string
GoString returns the string representation
func (UpdateDataSourceOutput) String ¶
func (s UpdateDataSourceOutput) String() string
String returns the string representation
type UpdateIndexInput ¶
type UpdateIndexInput struct { // A new description for the index. Description *string `min:"1" type:"string"` // The document metadata to update. DocumentMetadataConfigurationUpdates []*DocumentMetadataConfiguration `type:"list"` // The identifier of the index to update. // // Id is a required field Id *string `min:"36" type:"string" required:"true"` // The name of the index to update. Name *string `min:"1" type:"string"` // A new IAM role that gives Amazon Kendra permission to access your Amazon // CloudWatch logs. RoleArn *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (UpdateIndexInput) GoString ¶
func (s UpdateIndexInput) GoString() string
GoString returns the string representation
func (*UpdateIndexInput) SetDescription ¶
func (s *UpdateIndexInput) SetDescription(v string) *UpdateIndexInput
SetDescription sets the Description field's value.
func (*UpdateIndexInput) SetDocumentMetadataConfigurationUpdates ¶
func (s *UpdateIndexInput) SetDocumentMetadataConfigurationUpdates(v []*DocumentMetadataConfiguration) *UpdateIndexInput
SetDocumentMetadataConfigurationUpdates sets the DocumentMetadataConfigurationUpdates field's value.
func (*UpdateIndexInput) SetId ¶
func (s *UpdateIndexInput) SetId(v string) *UpdateIndexInput
SetId sets the Id field's value.
func (*UpdateIndexInput) SetName ¶
func (s *UpdateIndexInput) SetName(v string) *UpdateIndexInput
SetName sets the Name field's value.
func (*UpdateIndexInput) SetRoleArn ¶
func (s *UpdateIndexInput) SetRoleArn(v string) *UpdateIndexInput
SetRoleArn sets the RoleArn field's value.
func (UpdateIndexInput) String ¶
func (s UpdateIndexInput) String() string
String returns the string representation
func (*UpdateIndexInput) Validate ¶
func (s *UpdateIndexInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateIndexOutput ¶
type UpdateIndexOutput struct {
// contains filtered or unexported fields
}
func (UpdateIndexOutput) GoString ¶
func (s UpdateIndexOutput) GoString() string
GoString returns the string representation
func (UpdateIndexOutput) String ¶
func (s UpdateIndexOutput) String() string
String returns the string representation
type ValidationException ¶ added in v1.28.0
type ValidationException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"string"` // contains filtered or unexported fields }
func (ValidationException) Code ¶ added in v1.28.0
func (s ValidationException) Code() string
Code returns the exception type name.
func (ValidationException) Error ¶ added in v1.28.0
func (s ValidationException) Error() string
func (ValidationException) GoString ¶ added in v1.28.0
func (s ValidationException) GoString() string
GoString returns the string representation
func (ValidationException) Message ¶ added in v1.28.0
func (s ValidationException) Message() string
Message returns the exception's message.
func (ValidationException) OrigErr ¶ added in v1.28.0
func (s ValidationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (ValidationException) RequestID ¶ added in v1.28.0
func (s ValidationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (ValidationException) StatusCode ¶ added in v1.28.0
func (s ValidationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ValidationException) String ¶ added in v1.28.0
func (s ValidationException) String() string
String returns the string representation
Directories ¶
Path | Synopsis |
---|---|
Package kendraiface provides an interface to enable mocking the AWSKendraFrontendService service client for testing your code.
|
Package kendraiface provides an interface to enable mocking the AWSKendraFrontendService service client for testing your code. |