kendra

package
v0.20.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 17, 2020 License: Apache-2.0 Imports: 9 Imported by: 15

Documentation

Overview

Package kendra provides the client and types for making API requests to kendra.

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 use kendra 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 kendra client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/kendra/#New

Index

Constants

View Source 
const (
	ServiceName = "kendra" // Service's name
	ServiceID   = "Kendra" // Service's identifier
	EndpointsID = "kendra" // Service's Endpoint identifier
)
View Source 
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"

	// ErrCodeResourceUnavailableException for service response error code
	// "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"
)

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) 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 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) 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 AdditionalResultAttributeValueType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

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) String 

func (s AdditionalResultAttributeValue) String() string

String returns the string representation

type AdditionalResultAttributeValueType 

type AdditionalResultAttributeValueType string
const (
	AdditionalResultAttributeValueTypeTextWithHighlightsValue AdditionalResultAttributeValueType = "TEXT_WITH_HIGHLIGHTS_VALUE"
)

Enum values for AdditionalResultAttributeValueType

func (AdditionalResultAttributeValueType) MarshalValue 

func (enum AdditionalResultAttributeValueType) MarshalValue() (string, error)

func (AdditionalResultAttributeValueType) MarshalValueBuf 

func (enum AdditionalResultAttributeValueType) MarshalValueBuf(b []byte) ([]byte, error)

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) 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) 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) String 

func (s BatchDeleteDocumentOutput) String() string

String returns the string representation

type BatchDeleteDocumentRequest 

type BatchDeleteDocumentRequest struct {
	*aws.Request
	Input *BatchDeleteDocumentInput
	Copy  func(*BatchDeleteDocumentInput) BatchDeleteDocumentRequest
}

BatchDeleteDocumentRequest is the request type for the BatchDeleteDocument API operation.

func (BatchDeleteDocumentRequest) Send 

func (r BatchDeleteDocumentRequest) Send(ctx context.Context) (*BatchDeleteDocumentResponse, error)

Send marshals and sends the BatchDeleteDocument API request.

type BatchDeleteDocumentResponse 

type BatchDeleteDocumentResponse struct {
	*BatchDeleteDocumentOutput
	// contains filtered or unexported fields
}

BatchDeleteDocumentResponse is the response type for the BatchDeleteDocument API operation.

func (*BatchDeleteDocumentResponse) SDKResponseMetdata 

func (r *BatchDeleteDocumentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the BatchDeleteDocument request.

type BatchDeleteDocumentResponseFailedDocument 

type BatchDeleteDocumentResponseFailedDocument struct {

	// The error code for why the document couldn't be removed from the index.
	ErrorCode ErrorCode `type:"string" enum:"true"`

	// 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) 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) 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) String 

func (s BatchPutDocumentOutput) String() string

String returns the string representation

type BatchPutDocumentRequest 

type BatchPutDocumentRequest struct {
	*aws.Request
	Input *BatchPutDocumentInput
	Copy  func(*BatchPutDocumentInput) BatchPutDocumentRequest
}

BatchPutDocumentRequest is the request type for the BatchPutDocument API operation.

func (BatchPutDocumentRequest) Send 

func (r BatchPutDocumentRequest) Send(ctx context.Context) (*BatchPutDocumentResponse, error)

Send marshals and sends the BatchPutDocument API request.

type BatchPutDocumentResponse 

type BatchPutDocumentResponse struct {
	*BatchPutDocumentOutput
	// contains filtered or unexported fields
}

BatchPutDocumentResponse is the response type for the BatchPutDocument API operation.

func (*BatchPutDocumentResponse) SDKResponseMetdata 

func (r *BatchPutDocumentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the BatchPutDocument request.

type BatchPutDocumentResponseFailedDocument 

type BatchPutDocumentResponseFailedDocument struct {

	// The type of error that caused the document to fail to be indexed.
	ErrorCode ErrorCode `type:"string" enum:"true"`

	// 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) 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) 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 Client 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to kendra. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := kendra.New(myConfig)

func (*Client) BatchDeleteDocumentRequest 

func (c *Client) BatchDeleteDocumentRequest(input *BatchDeleteDocumentInput) BatchDeleteDocumentRequest

BatchDeleteDocumentRequest returns a request value for making 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. 

// Example sending a request using BatchDeleteDocumentRequest.
req := client.BatchDeleteDocumentRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteDocument

func (*Client) BatchPutDocumentRequest 

func (c *Client) BatchPutDocumentRequest(input *BatchPutDocumentInput) BatchPutDocumentRequest

BatchPutDocumentRequest returns a request value for making 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. 

// Example sending a request using BatchPutDocumentRequest.
req := client.BatchPutDocumentRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchPutDocument

func (*Client) CreateDataSourceRequest 

func (c *Client) CreateDataSourceRequest(input *CreateDataSourceInput) CreateDataSourceRequest

CreateDataSourceRequest returns a request value for making 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. 

// Example sending a request using CreateDataSourceRequest.
req := client.CreateDataSourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSource

func (*Client) CreateFaqRequest 

func (c *Client) CreateFaqRequest(input *CreateFaqInput) CreateFaqRequest

CreateFaqRequest returns a request value for making API operation for AWSKendraFrontendService.

Creates an new set of frequently asked question (FAQ) questions and answers. 

// Example sending a request using CreateFaqRequest.
req := client.CreateFaqRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaq

func (*Client) CreateIndexRequest 

func (c *Client) CreateIndexRequest(input *CreateIndexInput) CreateIndexRequest

CreateIndexRequest returns a request value for making 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. 

// Example sending a request using CreateIndexRequest.
req := client.CreateIndexRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndex

func (*Client) DeleteFaqRequest 

func (c *Client) DeleteFaqRequest(input *DeleteFaqInput) DeleteFaqRequest

DeleteFaqRequest returns a request value for making API operation for AWSKendraFrontendService.

Removes an FAQ from an index. 

// Example sending a request using DeleteFaqRequest.
req := client.DeleteFaqRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteFaq

func (*Client) DeleteIndexRequest 

func (c *Client) DeleteIndexRequest(input *DeleteIndexInput) DeleteIndexRequest

DeleteIndexRequest returns a request value for making 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. 

// Example sending a request using DeleteIndexRequest.
req := client.DeleteIndexRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteIndex

func (*Client) DescribeDataSourceRequest 

func (c *Client) DescribeDataSourceRequest(input *DescribeDataSourceInput) DescribeDataSourceRequest

DescribeDataSourceRequest returns a request value for making API operation for AWSKendraFrontendService.

Gets information about a Amazon Kendra data source. 

// Example sending a request using DescribeDataSourceRequest.
req := client.DescribeDataSourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSource

func (*Client) DescribeFaqRequest 

func (c *Client) DescribeFaqRequest(input *DescribeFaqInput) DescribeFaqRequest

DescribeFaqRequest returns a request value for making API operation for AWSKendraFrontendService.

Gets information about an FAQ list. 

// Example sending a request using DescribeFaqRequest.
req := client.DescribeFaqRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaq

func (*Client) DescribeIndexRequest 

func (c *Client) DescribeIndexRequest(input *DescribeIndexInput) DescribeIndexRequest

DescribeIndexRequest returns a request value for making API operation for AWSKendraFrontendService.

Describes an existing Amazon Kendra index 

// Example sending a request using DescribeIndexRequest.
req := client.DescribeIndexRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex

func (*Client) ListDataSourceSyncJobsRequest 

func (c *Client) ListDataSourceSyncJobsRequest(input *ListDataSourceSyncJobsInput) ListDataSourceSyncJobsRequest

ListDataSourceSyncJobsRequest returns a request value for making API operation for AWSKendraFrontendService.

Gets statistics about synchronizing Amazon Kendra with a data source. 

// Example sending a request using ListDataSourceSyncJobsRequest.
req := client.ListDataSourceSyncJobsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobs

func (*Client) ListDataSourcesRequest 

func (c *Client) ListDataSourcesRequest(input *ListDataSourcesInput) ListDataSourcesRequest

ListDataSourcesRequest returns a request value for making API operation for AWSKendraFrontendService.

Lists the data sources that you have created. 

// Example sending a request using ListDataSourcesRequest.
req := client.ListDataSourcesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSources

func (*Client) ListFaqsRequest 

func (c *Client) ListFaqsRequest(input *ListFaqsInput) ListFaqsRequest

ListFaqsRequest returns a request value for making API operation for AWSKendraFrontendService.

Gets a list of FAQ lists associated with an index. 

// Example sending a request using ListFaqsRequest.
req := client.ListFaqsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqs

func (*Client) ListIndicesRequest 

func (c *Client) ListIndicesRequest(input *ListIndicesInput) ListIndicesRequest

ListIndicesRequest returns a request value for making API operation for AWSKendraFrontendService.

Lists the Amazon Kendra indexes that you have created. 

// Example sending a request using ListIndicesRequest.
req := client.ListIndicesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndices

func (*Client) QueryRequest 

func (c *Client) QueryRequest(input *QueryInput) QueryRequest

QueryRequest returns a request value for making 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. 

// Example sending a request using QueryRequest.
req := client.QueryRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Query

func (*Client) StartDataSourceSyncJobRequest 

func (c *Client) StartDataSourceSyncJobRequest(input *StartDataSourceSyncJobInput) StartDataSourceSyncJobRequest

StartDataSourceSyncJobRequest returns a request value for making 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. 

// Example sending a request using StartDataSourceSyncJobRequest.
req := client.StartDataSourceSyncJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StartDataSourceSyncJob

func (*Client) StopDataSourceSyncJobRequest 

func (c *Client) StopDataSourceSyncJobRequest(input *StopDataSourceSyncJobInput) StopDataSourceSyncJobRequest

StopDataSourceSyncJobRequest returns a request value for making API operation for AWSKendraFrontendService.

Stops a running synchronization job. You can't stop a scheduled synchronization job. 

// Example sending a request using StopDataSourceSyncJobRequest.
req := client.StopDataSourceSyncJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StopDataSourceSyncJob

func (*Client) SubmitFeedbackRequest 

func (c *Client) SubmitFeedbackRequest(input *SubmitFeedbackInput) SubmitFeedbackRequest

SubmitFeedbackRequest returns a request value for making API operation for AWSKendraFrontendService.

Enables you to provide feedback to Amazon Kendra to improve the performance of the service. 

// Example sending a request using SubmitFeedbackRequest.
req := client.SubmitFeedbackRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SubmitFeedback

func (*Client) UpdateDataSourceRequest 

func (c *Client) UpdateDataSourceRequest(input *UpdateDataSourceInput) UpdateDataSourceRequest

UpdateDataSourceRequest returns a request value for making API operation for AWSKendraFrontendService.

Updates an existing Amazon Kendra data source. 

// Example sending a request using UpdateDataSourceRequest.
req := client.UpdateDataSourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateDataSource

func (*Client) UpdateIndexRequest 

func (c *Client) UpdateIndexRequest(input *UpdateIndexInput) UpdateIndexRequest

UpdateIndexRequest returns a request value for making API operation for AWSKendraFrontendService.

Updates an existing Amazon Kendra index. 

// Example sending a request using UpdateIndexRequest.
req := client.UpdateIndexRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex

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) 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 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) 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 ContentType 

type ContentType string
const (
	ContentTypePdf       ContentType = "PDF"
	ContentTypeHtml      ContentType = "HTML"
	ContentTypeMsWord    ContentType = "MS_WORD"
	ContentTypePlainText ContentType = "PLAIN_TEXT"
	ContentTypePpt       ContentType = "PPT"
)

Enum values for ContentType

func (ContentType) MarshalValue 

func (enum ContentType) MarshalValue() (string, error)

func (ContentType) MarshalValueBuf 

func (enum ContentType) MarshalValueBuf(b []byte) ([]byte, error)

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 DataSourceType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

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) String 

func (s CreateDataSourceOutput) String() string

String returns the string representation

type CreateDataSourceRequest 

type CreateDataSourceRequest struct {
	*aws.Request
	Input *CreateDataSourceInput
	Copy  func(*CreateDataSourceInput) CreateDataSourceRequest
}

CreateDataSourceRequest is the request type for the CreateDataSource API operation.

func (CreateDataSourceRequest) Send 

func (r CreateDataSourceRequest) Send(ctx context.Context) (*CreateDataSourceResponse, error)

Send marshals and sends the CreateDataSource API request.

type CreateDataSourceResponse 

type CreateDataSourceResponse struct {
	*CreateDataSourceOutput
	// contains filtered or unexported fields
}

CreateDataSourceResponse is the response type for the CreateDataSource API operation.

func (*CreateDataSourceResponse) SDKResponseMetdata 

func (r *CreateDataSourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateDataSource request.

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) 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) String 

func (s CreateFaqOutput) String() string

String returns the string representation

type CreateFaqRequest 

type CreateFaqRequest struct {
	*aws.Request
	Input *CreateFaqInput
	Copy  func(*CreateFaqInput) CreateFaqRequest
}

CreateFaqRequest is the request type for the CreateFaq API operation.

func (CreateFaqRequest) Send 

func (r CreateFaqRequest) Send(ctx context.Context) (*CreateFaqResponse, error)

Send marshals and sends the CreateFaq API request.

type CreateFaqResponse 

type CreateFaqResponse struct {
	*CreateFaqOutput
	// contains filtered or unexported fields
}

CreateFaqResponse is the response type for the CreateFaq API operation.

func (*CreateFaqResponse) SDKResponseMetdata 

func (r *CreateFaqResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateFaq request.

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) 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) String 

func (s CreateIndexOutput) String() string

String returns the string representation

type CreateIndexRequest 

type CreateIndexRequest struct {
	*aws.Request
	Input *CreateIndexInput
	Copy  func(*CreateIndexInput) CreateIndexRequest
}

CreateIndexRequest is the request type for the CreateIndex API operation.

func (CreateIndexRequest) Send 

func (r CreateIndexRequest) Send(ctx context.Context) (*CreateIndexResponse, error)

Send marshals and sends the CreateIndex API request.

type CreateIndexResponse 

type CreateIndexResponse struct {
	*CreateIndexOutput
	// contains filtered or unexported fields
}

CreateIndexResponse is the response type for the CreateIndex API operation.

func (*CreateIndexResponse) SDKResponseMetdata 

func (r *CreateIndexResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateIndex request.

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"`

	// Provides information necessary to create a connector for a Microsoft SharePoint
	// site.
	SharePointConfiguration *SharePointConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Configuration information for a Amazon Kendra data source.

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 DataSourceStatus 

type DataSourceStatus string
const (
	DataSourceStatusCreating DataSourceStatus = "CREATING"
	DataSourceStatusDeleting DataSourceStatus = "DELETING"
	DataSourceStatusFailed   DataSourceStatus = "FAILED"
	DataSourceStatusUpdating DataSourceStatus = "UPDATING"
	DataSourceStatusActive   DataSourceStatus = "ACTIVE"
)

Enum values for DataSourceStatus

func (DataSourceStatus) MarshalValue 

func (enum DataSourceStatus) MarshalValue() (string, error)

func (DataSourceStatus) MarshalValueBuf 

func (enum DataSourceStatus) MarshalValueBuf(b []byte) ([]byte, error)

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 DataSourceStatus `type:"string" enum:"true"`

	// The type of the data source.
	Type DataSourceType `type:"string" enum:"true"`

	// 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) 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 ErrorCode `type:"string" enum:"true"`

	// 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 DataSourceSyncJobStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Provides information about a synchronization job.

func (DataSourceSyncJob) String 

func (s DataSourceSyncJob) String() string

String returns the string representation

type DataSourceSyncJobStatus 

type DataSourceSyncJobStatus string
const (
	DataSourceSyncJobStatusFailed     DataSourceSyncJobStatus = "FAILED"
	DataSourceSyncJobStatusSucceeded  DataSourceSyncJobStatus = "SUCCEEDED"
	DataSourceSyncJobStatusSyncing    DataSourceSyncJobStatus = "SYNCING"
	DataSourceSyncJobStatusIncomplete DataSourceSyncJobStatus = "INCOMPLETE"
	DataSourceSyncJobStatusStopping   DataSourceSyncJobStatus = "STOPPING"
	DataSourceSyncJobStatusAborted    DataSourceSyncJobStatus = "ABORTED"
)

Enum values for DataSourceSyncJobStatus

func (DataSourceSyncJobStatus) MarshalValue 

func (enum DataSourceSyncJobStatus) MarshalValue() (string, error)

func (DataSourceSyncJobStatus) MarshalValueBuf 

func (enum DataSourceSyncJobStatus) MarshalValueBuf(b []byte) ([]byte, error)

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) 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 DataSourceType 

type DataSourceType string
const (
	DataSourceTypeS3         DataSourceType = "S3"
	DataSourceTypeSharepoint DataSourceType = "SHAREPOINT"
	DataSourceTypeDatabase   DataSourceType = "DATABASE"
)

Enum values for DataSourceType

func (DataSourceType) MarshalValue 

func (enum DataSourceType) MarshalValue() (string, error)

func (DataSourceType) MarshalValueBuf 

func (enum DataSourceType) MarshalValueBuf(b []byte) ([]byte, error)

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) 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 DatabaseEngineType `type:"string" required:"true" enum:"true"`

	// 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) 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 DatabaseEngineType 

type DatabaseEngineType string
const (
	DatabaseEngineTypeRdsAuroraMysql      DatabaseEngineType = "RDS_AURORA_MYSQL"
	DatabaseEngineTypeRdsAuroraPostgresql DatabaseEngineType = "RDS_AURORA_POSTGRESQL"
	DatabaseEngineTypeRdsMysql            DatabaseEngineType = "RDS_MYSQL"
	DatabaseEngineTypeRdsPostgresql       DatabaseEngineType = "RDS_POSTGRESQL"
)

Enum values for DatabaseEngineType

func (DatabaseEngineType) MarshalValue 

func (enum DatabaseEngineType) MarshalValue() (string, error)

func (DatabaseEngineType) MarshalValueBuf 

func (enum DatabaseEngineType) MarshalValueBuf(b []byte) ([]byte, error)

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) 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) String 

func (s DeleteFaqOutput) String() string

String returns the string representation

type DeleteFaqRequest 

type DeleteFaqRequest struct {
	*aws.Request
	Input *DeleteFaqInput
	Copy  func(*DeleteFaqInput) DeleteFaqRequest
}

DeleteFaqRequest is the request type for the DeleteFaq API operation.

func (DeleteFaqRequest) Send 

func (r DeleteFaqRequest) Send(ctx context.Context) (*DeleteFaqResponse, error)

Send marshals and sends the DeleteFaq API request.

type DeleteFaqResponse 

type DeleteFaqResponse struct {
	*DeleteFaqOutput
	// contains filtered or unexported fields
}

DeleteFaqResponse is the response type for the DeleteFaq API operation.

func (*DeleteFaqResponse) SDKResponseMetdata 

func (r *DeleteFaqResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteFaq request.

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) 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) String 

func (s DeleteIndexOutput) String() string

String returns the string representation

type DeleteIndexRequest 

type DeleteIndexRequest struct {
	*aws.Request
	Input *DeleteIndexInput
	Copy  func(*DeleteIndexInput) DeleteIndexRequest
}

DeleteIndexRequest is the request type for the DeleteIndex API operation.

func (DeleteIndexRequest) Send 

func (r DeleteIndexRequest) Send(ctx context.Context) (*DeleteIndexResponse, error)

Send marshals and sends the DeleteIndex API request.

type DeleteIndexResponse 

type DeleteIndexResponse struct {
	*DeleteIndexOutput
	// contains filtered or unexported fields
}

DeleteIndexResponse is the response type for the DeleteIndex API operation.

func (*DeleteIndexResponse) SDKResponseMetdata 

func (r *DeleteIndexResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteIndex request.

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) 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 DataSourceStatus `type:"string" enum:"true"`

	// The type of the data source.
	Type DataSourceType `type:"string" enum:"true"`

	// The Unix timestamp of when the data source was last updated.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (DescribeDataSourceOutput) String 

func (s DescribeDataSourceOutput) String() string

String returns the string representation

type DescribeDataSourceRequest 

type DescribeDataSourceRequest struct {
	*aws.Request
	Input *DescribeDataSourceInput
	Copy  func(*DescribeDataSourceInput) DescribeDataSourceRequest
}

DescribeDataSourceRequest is the request type for the DescribeDataSource API operation.

func (DescribeDataSourceRequest) Send 

func (r DescribeDataSourceRequest) Send(ctx context.Context) (*DescribeDataSourceResponse, error)

Send marshals and sends the DescribeDataSource API request.

type DescribeDataSourceResponse 

type DescribeDataSourceResponse struct {
	*DescribeDataSourceOutput
	// contains filtered or unexported fields
}

DescribeDataSourceResponse is the response type for the DescribeDataSource API operation.

func (*DescribeDataSourceResponse) SDKResponseMetdata 

func (r *DescribeDataSourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDataSource request.

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) 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 FaqStatus `type:"string" enum:"true"`

	// The date and time that the FAQ was last updated.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (DescribeFaqOutput) String 

func (s DescribeFaqOutput) String() string

String returns the string representation

type DescribeFaqRequest 

type DescribeFaqRequest struct {
	*aws.Request
	Input *DescribeFaqInput
	Copy  func(*DescribeFaqInput) DescribeFaqRequest
}

DescribeFaqRequest is the request type for the DescribeFaq API operation.

func (DescribeFaqRequest) Send 

func (r DescribeFaqRequest) Send(ctx context.Context) (*DescribeFaqResponse, error)

Send marshals and sends the DescribeFaq API request.

type DescribeFaqResponse 

type DescribeFaqResponse struct {
	*DescribeFaqOutput
	// contains filtered or unexported fields
}

DescribeFaqResponse is the response type for the DescribeFaq API operation.

func (*DescribeFaqResponse) SDKResponseMetdata 

func (r *DescribeFaqResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeFaq request.

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) 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 IndexStatus `type:"string" enum:"true"`

	// The Unix datetime that the index was last updated.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (DescribeIndexOutput) String 

func (s DescribeIndexOutput) String() string

String returns the string representation

type DescribeIndexRequest 

type DescribeIndexRequest struct {
	*aws.Request
	Input *DescribeIndexInput
	Copy  func(*DescribeIndexInput) DescribeIndexRequest
}

DescribeIndexRequest is the request type for the DescribeIndex API operation.

func (DescribeIndexRequest) Send 

func (r DescribeIndexRequest) Send(ctx context.Context) (*DescribeIndexResponse, error)

Send marshals and sends the DescribeIndex API request.

type DescribeIndexResponse 

type DescribeIndexResponse struct {
	*DescribeIndexOutput
	// contains filtered or unexported fields
}

DescribeIndexResponse is the response type for the DescribeIndex API operation.

func (*DescribeIndexResponse) SDKResponseMetdata 

func (r *DescribeIndexResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeIndex request.

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 ContentType `type:"string" enum:"true"`

	// 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) String 

func (s Document) String() string

String returns the string representation

func (*Document) Validate 

func (s *Document) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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) 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) 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) String 

func (s DocumentAttributeValueCountPair) String() string

String returns the string representation

type DocumentAttributeValueType 

type DocumentAttributeValueType string
const (
	DocumentAttributeValueTypeStringValue     DocumentAttributeValueType = "STRING_VALUE"
	DocumentAttributeValueTypeStringListValue DocumentAttributeValueType = "STRING_LIST_VALUE"
	DocumentAttributeValueTypeLongValue       DocumentAttributeValueType = "LONG_VALUE"
	DocumentAttributeValueTypeDateValue       DocumentAttributeValueType = "DATE_VALUE"
)

Enum values for DocumentAttributeValueType

func (DocumentAttributeValueType) MarshalValue 

func (enum DocumentAttributeValueType) MarshalValue() (string, error)

func (DocumentAttributeValueType) MarshalValueBuf 

func (enum DocumentAttributeValueType) MarshalValueBuf(b []byte) ([]byte, error)

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 DocumentAttributeValueType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Specifies the properties of a custom index field.

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) 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 ErrorCode 

type ErrorCode string
const (
	ErrorCodeInternalError  ErrorCode = "InternalError"
	ErrorCodeInvalidRequest ErrorCode = "InvalidRequest"
)

Enum values for ErrorCode

func (ErrorCode) MarshalValue 

func (enum ErrorCode) MarshalValue() (string, error)

func (ErrorCode) MarshalValueBuf 

func (enum ErrorCode) MarshalValueBuf(b []byte) ([]byte, error)

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) String 

func (s Facet) String() string

String returns the string representation

func (*Facet) Validate 

func (s *Facet) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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) 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) String 

func (s FaqStatistics) String() string

String returns the string representation

type FaqStatus 

type FaqStatus string
const (
	FaqStatusCreating FaqStatus = "CREATING"
	FaqStatusUpdating FaqStatus = "UPDATING"
	FaqStatusActive   FaqStatus = "ACTIVE"
	FaqStatusDeleting FaqStatus = "DELETING"
	FaqStatusFailed   FaqStatus = "FAILED"
)

Enum values for FaqStatus

func (FaqStatus) MarshalValue 

func (enum FaqStatus) MarshalValue() (string, error)

func (FaqStatus) MarshalValueBuf 

func (enum FaqStatus) MarshalValueBuf(b []byte) ([]byte, error)

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 FaqStatus `type:"string" enum:"true"`

	// 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) 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) String 

func (s Highlight) String() string

String returns the string representation

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 IndexStatus `type:"string" required:"true" enum:"true"`

	// 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) 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) String 

func (s IndexStatistics) String() string

String returns the string representation

type IndexStatus 

type IndexStatus string
const (
	IndexStatusCreating       IndexStatus = "CREATING"
	IndexStatusActive         IndexStatus = "ACTIVE"
	IndexStatusDeleting       IndexStatus = "DELETING"
	IndexStatusFailed         IndexStatus = "FAILED"
	IndexStatusSystemUpdating IndexStatus = "SYSTEM_UPDATING"
)

Enum values for IndexStatus

func (IndexStatus) MarshalValue 

func (enum IndexStatus) MarshalValue() (string, error)

func (IndexStatus) MarshalValueBuf 

func (enum IndexStatus) MarshalValueBuf(b []byte) ([]byte, error)

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 DataSourceSyncJobStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

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) String 

func (s ListDataSourceSyncJobsOutput) String() string

String returns the string representation

type ListDataSourceSyncJobsPaginator 

type ListDataSourceSyncJobsPaginator struct {
	aws.Pager
}

ListDataSourceSyncJobsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListDataSourceSyncJobsPaginator 

func NewListDataSourceSyncJobsPaginator(req ListDataSourceSyncJobsRequest) ListDataSourceSyncJobsPaginator

NewListDataSourceSyncJobsRequestPaginator returns a paginator for ListDataSourceSyncJobs. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListDataSourceSyncJobsRequest(input)
p := kendra.NewListDataSourceSyncJobsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListDataSourceSyncJobsPaginator) CurrentPage 

func (p *ListDataSourceSyncJobsPaginator) CurrentPage() *ListDataSourceSyncJobsOutput

type ListDataSourceSyncJobsRequest 

type ListDataSourceSyncJobsRequest struct {
	*aws.Request
	Input *ListDataSourceSyncJobsInput
	Copy  func(*ListDataSourceSyncJobsInput) ListDataSourceSyncJobsRequest
}

ListDataSourceSyncJobsRequest is the request type for the ListDataSourceSyncJobs API operation.

func (ListDataSourceSyncJobsRequest) Send 

func (r ListDataSourceSyncJobsRequest) Send(ctx context.Context) (*ListDataSourceSyncJobsResponse, error)

Send marshals and sends the ListDataSourceSyncJobs API request.

type ListDataSourceSyncJobsResponse 

type ListDataSourceSyncJobsResponse struct {
	*ListDataSourceSyncJobsOutput
	// contains filtered or unexported fields
}

ListDataSourceSyncJobsResponse is the response type for the ListDataSourceSyncJobs API operation.

func (*ListDataSourceSyncJobsResponse) SDKResponseMetdata 

func (r *ListDataSourceSyncJobsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListDataSourceSyncJobs request.

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) 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) String 

func (s ListDataSourcesOutput) String() string

String returns the string representation

type ListDataSourcesPaginator 

type ListDataSourcesPaginator struct {
	aws.Pager
}

ListDataSourcesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListDataSourcesPaginator 

func NewListDataSourcesPaginator(req ListDataSourcesRequest) ListDataSourcesPaginator

NewListDataSourcesRequestPaginator returns a paginator for ListDataSources. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListDataSourcesRequest(input)
p := kendra.NewListDataSourcesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListDataSourcesPaginator) CurrentPage 

func (p *ListDataSourcesPaginator) CurrentPage() *ListDataSourcesOutput

type ListDataSourcesRequest 

type ListDataSourcesRequest struct {
	*aws.Request
	Input *ListDataSourcesInput
	Copy  func(*ListDataSourcesInput) ListDataSourcesRequest
}

ListDataSourcesRequest is the request type for the ListDataSources API operation.

func (ListDataSourcesRequest) Send 

func (r ListDataSourcesRequest) Send(ctx context.Context) (*ListDataSourcesResponse, error)

Send marshals and sends the ListDataSources API request.

type ListDataSourcesResponse 

type ListDataSourcesResponse struct {
	*ListDataSourcesOutput
	// contains filtered or unexported fields
}

ListDataSourcesResponse is the response type for the ListDataSources API operation.

func (*ListDataSourcesResponse) SDKResponseMetdata 

func (r *ListDataSourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListDataSources request.

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) 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) String 

func (s ListFaqsOutput) String() string

String returns the string representation

type ListFaqsRequest 

type ListFaqsRequest struct {
	*aws.Request
	Input *ListFaqsInput
	Copy  func(*ListFaqsInput) ListFaqsRequest
}

ListFaqsRequest is the request type for the ListFaqs API operation.

func (ListFaqsRequest) Send 

func (r ListFaqsRequest) Send(ctx context.Context) (*ListFaqsResponse, error)

Send marshals and sends the ListFaqs API request.

type ListFaqsResponse 

type ListFaqsResponse struct {
	*ListFaqsOutput
	// contains filtered or unexported fields
}

ListFaqsResponse is the response type for the ListFaqs API operation.

func (*ListFaqsResponse) SDKResponseMetdata 

func (r *ListFaqsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListFaqs request.

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) 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) String 

func (s ListIndicesOutput) String() string

String returns the string representation

type ListIndicesPaginator 

type ListIndicesPaginator struct {
	aws.Pager
}

ListIndicesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListIndicesPaginator 

func NewListIndicesPaginator(req ListIndicesRequest) ListIndicesPaginator

NewListIndicesRequestPaginator returns a paginator for ListIndices. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListIndicesRequest(input)
p := kendra.NewListIndicesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListIndicesPaginator) CurrentPage 

func (p *ListIndicesPaginator) CurrentPage() *ListIndicesOutput

type ListIndicesRequest 

type ListIndicesRequest struct {
	*aws.Request
	Input *ListIndicesInput
	Copy  func(*ListIndicesInput) ListIndicesRequest
}

ListIndicesRequest is the request type for the ListIndices API operation.

func (ListIndicesRequest) Send 

func (r ListIndicesRequest) Send(ctx context.Context) (*ListIndicesResponse, error)

Send marshals and sends the ListIndices API request.

type ListIndicesResponse 

type ListIndicesResponse struct {
	*ListIndicesOutput
	// contains filtered or unexported fields
}

ListIndicesResponse is the response type for the ListIndices API operation.

func (*ListIndicesResponse) SDKResponseMetdata 

func (r *ListIndicesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListIndices request.

type Order 

type Order string
const (
	OrderAscending  Order = "ASCENDING"
	OrderDescending Order = "DESCENDING"
)

Enum values for Order

func (Order) MarshalValue 

func (enum Order) MarshalValue() (string, error)

func (Order) MarshalValueBuf 

func (enum Order) MarshalValueBuf(b []byte) ([]byte, error)

type Principal 

type Principal struct {

	// Whether to allow or deny access to the principal.
	//
	// Access is a required field
	Access ReadAccessType `type:"string" required:"true" enum:"true"`

	// 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 PrincipalType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Provides user and group information for document access filtering.

func (Principal) String 

func (s Principal) String() string

String returns the string representation

func (*Principal) Validate 

func (s *Principal) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PrincipalType 

type PrincipalType string
const (
	PrincipalTypeUser  PrincipalType = "USER"
	PrincipalTypeGroup PrincipalType = "GROUP"
)

Enum values for PrincipalType

func (PrincipalType) MarshalValue 

func (enum PrincipalType) MarshalValue() (string, error)

func (PrincipalType) MarshalValueBuf 

func (enum PrincipalType) MarshalValueBuf(b []byte) ([]byte, error)

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 QueryResultType `type:"string" enum:"true"`

	// 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) 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) String 

func (s QueryOutput) String() string

String returns the string representation

type QueryRequest 

type QueryRequest struct {
	*aws.Request
	Input *QueryInput
	Copy  func(*QueryInput) QueryRequest
}

QueryRequest is the request type for the Query API operation.

func (QueryRequest) Send 

func (r QueryRequest) Send(ctx context.Context) (*QueryResponse, error)

Send marshals and sends the Query API request.

type QueryResponse 

type QueryResponse struct {
	*QueryOutput
	// contains filtered or unexported fields
}

QueryResponse is the response type for the Query API operation.

func (*QueryResponse) SDKResponseMetdata 

func (r *QueryResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the Query request.

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 QueryResultType `type:"string" enum:"true"`
	// 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) String 

func (s QueryResultItem) String() string

String returns the string representation

type QueryResultType 

type QueryResultType string
const (
	QueryResultTypeDocument       QueryResultType = "DOCUMENT"
	QueryResultTypeQuestionAnswer QueryResultType = "QUESTION_ANSWER"
	QueryResultTypeAnswer         QueryResultType = "ANSWER"
)

Enum values for QueryResultType

func (QueryResultType) MarshalValue 

func (enum QueryResultType) MarshalValue() (string, error)

func (QueryResultType) MarshalValueBuf 

func (enum QueryResultType) MarshalValueBuf(b []byte) ([]byte, error)

type ReadAccessType 

type ReadAccessType string
const (
	ReadAccessTypeAllow ReadAccessType = "ALLOW"
	ReadAccessTypeDeny  ReadAccessType = "DENY"
)

Enum values for ReadAccessType

func (ReadAccessType) MarshalValue 

func (enum ReadAccessType) MarshalValue() (string, error)

func (ReadAccessType) MarshalValueBuf 

func (enum ReadAccessType) MarshalValueBuf(b []byte) ([]byte, error)

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 Order `type:"string" enum:"true"`

	// 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) String 

func (s Relevance) String() string

String returns the string representation

func (*Relevance) Validate 

func (s *Relevance) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RelevanceFeedback 

type RelevanceFeedback struct {

	// Whether to document was relevant or not relevant to the search.
	//
	// RelevanceValue is a required field
	RelevanceValue RelevanceType `type:"string" required:"true" enum:"true"`

	// 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) 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 RelevanceType 

type RelevanceType string
const (
	RelevanceTypeRelevant    RelevanceType = "RELEVANT"
	RelevanceTypeNotRelevant RelevanceType = "NOT_RELEVANT"
)

Enum values for RelevanceType

func (RelevanceType) MarshalValue 

func (enum RelevanceType) MarshalValue() (string, error)

func (RelevanceType) MarshalValueBuf 

func (enum RelevanceType) MarshalValueBuf(b []byte) ([]byte, error)

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) 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.

func (S3Path) String 

func (s S3Path) String() string

String returns the string representation

func (*S3Path) Validate 

func (s *S3Path) Validate() error

Validate inspects the fields of the type to determine if they are valid. 

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) String 

func (s Search) String() string

String returns the string representation

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) 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 SharePointConfiguration 

type SharePointConfiguration struct {

	// TRUE to include attachments to documents stored in your Microsoft SharePoint
	// site in the index; otherwise, FALSE.
	CrawlAttachments *bool `type:"boolean"`

	// The Microsoft SharePoint attribute field that contains the title of the document.
	DocumentTitleFieldName *string `min:"1" type:"string"`

	// A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint
	// 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 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 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"`

	// The version of Microsoft SharePoint that you are using as a data source.
	//
	// SharePointVersion is a required field
	SharePointVersion SharePointVersion `type:"string" required:"true" enum:"true"`

	// The URLs of the Microsoft SharePoint site that contains the documents that
	// should be indexed.
	//
	// Urls is a required field
	Urls []string `min:"1" type:"list" required:"true"`

	// Provides information for connecting to an Amazon VPC.
	VpcConfiguration *DataSourceVpcConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Provides configuration information for connecting to a Microsoft SharePoint data source.

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 SharePointVersion 

type SharePointVersion string
const (
	SharePointVersionSharepointOnline SharePointVersion = "SHAREPOINT_ONLINE"
)

Enum values for SharePointVersion

func (SharePointVersion) MarshalValue 

func (enum SharePointVersion) MarshalValue() (string, error)

func (SharePointVersion) MarshalValueBuf 

func (enum SharePointVersion) MarshalValueBuf(b []byte) ([]byte, error)

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) 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) String 

func (s StartDataSourceSyncJobOutput) String() string

String returns the string representation

type StartDataSourceSyncJobRequest 

type StartDataSourceSyncJobRequest struct {
	*aws.Request
	Input *StartDataSourceSyncJobInput
	Copy  func(*StartDataSourceSyncJobInput) StartDataSourceSyncJobRequest
}

StartDataSourceSyncJobRequest is the request type for the StartDataSourceSyncJob API operation.

func (StartDataSourceSyncJobRequest) Send 

func (r StartDataSourceSyncJobRequest) Send(ctx context.Context) (*StartDataSourceSyncJobResponse, error)

Send marshals and sends the StartDataSourceSyncJob API request.

type StartDataSourceSyncJobResponse 

type StartDataSourceSyncJobResponse struct {
	*StartDataSourceSyncJobOutput
	// contains filtered or unexported fields
}

StartDataSourceSyncJobResponse is the response type for the StartDataSourceSyncJob API operation.

func (*StartDataSourceSyncJobResponse) SDKResponseMetdata 

func (r *StartDataSourceSyncJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartDataSourceSyncJob request.

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) 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) String 

func (s StopDataSourceSyncJobOutput) String() string

String returns the string representation

type StopDataSourceSyncJobRequest 

type StopDataSourceSyncJobRequest struct {
	*aws.Request
	Input *StopDataSourceSyncJobInput
	Copy  func(*StopDataSourceSyncJobInput) StopDataSourceSyncJobRequest
}

StopDataSourceSyncJobRequest is the request type for the StopDataSourceSyncJob API operation.

func (StopDataSourceSyncJobRequest) Send 

func (r StopDataSourceSyncJobRequest) Send(ctx context.Context) (*StopDataSourceSyncJobResponse, error)

Send marshals and sends the StopDataSourceSyncJob API request.

type StopDataSourceSyncJobResponse 

type StopDataSourceSyncJobResponse struct {
	*StopDataSourceSyncJobOutput
	// contains filtered or unexported fields
}

StopDataSourceSyncJobResponse is the response type for the StopDataSourceSyncJob API operation.

func (*StopDataSourceSyncJobResponse) SDKResponseMetdata 

func (r *StopDataSourceSyncJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StopDataSourceSyncJob request.

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) 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) String 

func (s SubmitFeedbackOutput) String() string

String returns the string representation

type SubmitFeedbackRequest 

type SubmitFeedbackRequest struct {
	*aws.Request
	Input *SubmitFeedbackInput
	Copy  func(*SubmitFeedbackInput) SubmitFeedbackRequest
}

SubmitFeedbackRequest is the request type for the SubmitFeedback API operation.

func (SubmitFeedbackRequest) Send 

func (r SubmitFeedbackRequest) Send(ctx context.Context) (*SubmitFeedbackResponse, error)

Send marshals and sends the SubmitFeedback API request.

type SubmitFeedbackResponse 

type SubmitFeedbackResponse struct {
	*SubmitFeedbackOutput
	// contains filtered or unexported fields
}

SubmitFeedbackResponse is the response type for the SubmitFeedback API operation.

func (*SubmitFeedbackResponse) SDKResponseMetdata 

func (r *SubmitFeedbackResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SubmitFeedback request.

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) 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) String 

func (s TextWithHighlights) 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) String 

func (s TimeRange) String() string

String returns the string representation

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) 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) String 

func (s UpdateDataSourceOutput) String() string

String returns the string representation

type UpdateDataSourceRequest 

type UpdateDataSourceRequest struct {
	*aws.Request
	Input *UpdateDataSourceInput
	Copy  func(*UpdateDataSourceInput) UpdateDataSourceRequest
}

UpdateDataSourceRequest is the request type for the UpdateDataSource API operation.

func (UpdateDataSourceRequest) Send 

func (r UpdateDataSourceRequest) Send(ctx context.Context) (*UpdateDataSourceResponse, error)

Send marshals and sends the UpdateDataSource API request.

type UpdateDataSourceResponse 

type UpdateDataSourceResponse struct {
	*UpdateDataSourceOutput
	// contains filtered or unexported fields
}

UpdateDataSourceResponse is the response type for the UpdateDataSource API operation.

func (*UpdateDataSourceResponse) SDKResponseMetdata 

func (r *UpdateDataSourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateDataSource request.

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) 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) String 

func (s UpdateIndexOutput) String() string

String returns the string representation

type UpdateIndexRequest 

type UpdateIndexRequest struct {
	*aws.Request
	Input *UpdateIndexInput
	Copy  func(*UpdateIndexInput) UpdateIndexRequest
}

UpdateIndexRequest is the request type for the UpdateIndex API operation.

func (UpdateIndexRequest) Send 

func (r UpdateIndexRequest) Send(ctx context.Context) (*UpdateIndexResponse, error)

Send marshals and sends the UpdateIndex API request.

type UpdateIndexResponse 

type UpdateIndexResponse struct {
	*UpdateIndexOutput
	// contains filtered or unexported fields
}

UpdateIndexResponse is the response type for the UpdateIndex API operation.

func (*UpdateIndexResponse) SDKResponseMetdata 

func (r *UpdateIndexResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateIndex request.

Source Files

View all Source files

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.