Add or Edit an Amazon S3 Source
Add or Edit an Amazon S3 Source
Amazon simple storage service (S3) is a cloud-based data storage designed to store, manage, and distribute large quantities of data worldwide. Members with the required privileges can add the content of Amazon S3 buckets to a Coveo organization. Coveo indexes Amazon S3 files to make them searchable.
|
Leading practice
The number of items that a source processes per hour (crawling speed) depends on various factors, such as network bandwidth and source configuration. See About crawling speed for information on what can impact crawling speed, as well as possible solutions. |
Source Key Characteristics
Features | Supported | Additional information | |
---|---|---|---|
Amazon S3 version |
Latest cloud version |
Following available Amazon S3 releases |
|
Indexable content[1] |
Buckets[2] and objects (folders and files) |
||
Content security options |
|||
Add or Edit an Amazon S3 Source
|
Leading practice
It’s best to create or edit your source in your sandbox organization first. Once you’ve confirmed that it indexes the desired content, you can copy your source configuration to your production organization, either with a snapshot or manually. See About non-production organizations for more information and best practices regarding sandbox organizations. |
"Configuration" Tab
In the Add/Edit an Amazon S3 Source panel, the Configuration tab is selected by default. It contains your source’s general and authentication information, as well as other parameters.
General Information
Source Name
Enter a name for your source.
|
Leading practice
A source name can’t be modified once it’s saved, therefore be sure to use a short and descriptive name, using letters, numbers, hyphens ( |
Amazon S3 bucket URL
Enter the address of one or more Amazon S3 buckets using one of the following formats:
-
Virtual-host style
-
http://<BUCKET>.s3.amazonaws.com/
-
http://<BUCKET>.s3.<AWS_REGION>.amazonaws.com/
where you replace <BUCKET>
with the name of your actual bucket, and <AWS_REGION>
with your region-specific endpoint.
-
Path style
-
http://s3.amazonaws.com/<BUCKET>
-
http://s3.<AWS_REGION>.amazonaws.com/<BUCKET>
where you replace <BUCKET>
with the name of your actual bucket, and <AWS_REGION>
with your region-specific endpoint.
|
Notes
|
Optical Character Recognition (OCR)
If you want Coveo to extract text from image files or PDF files containing images, enable the appropriate option.
The extracted text is processed as item data, meaning that it’s fully searchable and will appear in the item Quick View. See Enable optical character recognition for details on this feature.
"Authentication" Section
Fill the appropriate boxes depending on whether your S3 bucket content is secured or public.
-
If your S3 bucket content is secured, meaning not accessible by anonymous users, enter the AWS Access Key ID and AWS Secret Access Key values linked to an AWS Identity and Access Management (IAM) account. The IAM account must have at least the read permission on the bucket content to index. See the Console Access section in the Understanding and Getting Your Security Credentials article for more details.
-
If your S3 bucket content is public, meaning anonymous users can access the content, you may leave the AWS Access Key ID and AWS Secret Access Key boxes empty.
|
Notes
|
"Content Security" Tab
Select who will be able to access the source items through a Coveo-powered search interface. For details on this parameter, see Content security.
"Access" Tab
In the Access tab, set whether each group (and API key, if applicable) in your Coveo organization can view or edit the current source.
For example, when creating a new source, you could decide that members of Group A can edit its configuration while Group B can only view it.
See Custom access level for more information.
Completion
-
Finish adding or editing your source:
-
When you want to save your source configuration changes without starting a build/rebuild, such as when you know you want to do other changes soon, click Add source/Save.
NoteOn the Sources (platform-ca | platform-eu | platform-au) page, you must click Launch build or Start required rebuild in the source Status column to add the source content or to make your changes effective, respectively.
-
When you’re done editing the source and want to make changes effective, click Add and build source/Save and rebuild source.
Back on the Sources (platform-ca | platform-eu | platform-au) page, you can follow the progress of your source addition or modification.
Once the source is built or rebuilt, you can review its content in the Content Browser.
-
-
Optionally, consider editing or adding mappings once your source is done building or rebuilding.
Refine the Content to Index
You may want to avoid indexing certain subfolders, or to index only a few of them. To do so:
-
If not already done, create and save your source with a broad bucket URL.
-
In your source JSON configuration, enter an address filter to refine the targeted content.
Your bucket URL must match one of your inclusion
addressPatterns
and not match any of your exclusionaddressPatterns
. -
Build or rebuild your source.
Required privileges
You can assign privileges to allow access to specific tools in the Coveo Administration Console. The following table indicates the privileges required to view or edit elements of the Sources (platform-ca | platform-eu | platform-au) page and associated panels. See Manage privileges and Privilege reference for more information.
|
Note
The Edit all privilege isn’t required to create sources. When granting privileges for the Sources domain, you can grant a group or API key the View all or Custom access level, instead of Edit all, and then select the Can Create checkbox to allow users to create sources. See Can Create ability dependence for more information. |
Actions | Service | Domain | Required access level |
---|---|---|---|
View sources, view source update schedules, and subscribe to source notifications |
Content |
Fields |
View |
Sources |
|||
Organization |
Organization |
||
Edit sources, edit source update schedules, and view the View Metadata page |
Content |
Fields |
Edit |
Sources |
|||
Content |
Source metadata |
View |
|
Organization |
Organization |