Overview

This manual is divided into several sections, each focusing on a specific aspect of the AWS S3-Kognitos integration.

Introduction

The integration of AWS S3 with Kognitos offers a powerful and intuitive way to interact with AWS S3 storage. This integration enables users to perform a wide range of operations on AWS S3 objects, including uploading, retrieving, deleting, and listing files, all through the use of Kognitos’ natural language processing capabilities. This section provides an overview of the AWS S3-Kognitos integration and outlines the prerequisites for using AWS S3 on Kognitos.

Prerequisites for Using Kognitos with AWS S3

Before you can start using Kognitos to interact with AWS S3, there are several prerequisites that need to be met:

AWS Account: You need to have an active AWS account. If you do not have one, you can sign up for an AWS account to get started.
AWS S3 Bucket: Ensure that you have an S3 bucket created in your AWS account. You can create a new bucket through the AWS Management Console.
AWS Access Credentials: Obtain your AWS access key ID and secret access key. These credentials are required for Kognitos to communicate with AWS S3 securely. You can generate these credentials in the AWS Management Console under "IAM" > "Users" > "Security credentials".
Basic Understanding of AWS S3: While Kognitos simplifies interactions, having a basic understanding of AWS S3 concepts (e.g., buckets, objects, paths) will help you automate more effectively with Kognitos.

Once these prerequisites are met, you are ready to start leveraging the power of Kognitos to enhance your AWS S3 experience, making it more accessible, efficient, and customizable.

Setting Up AWS S3 Connection

Connecting to AWS S3

To interact with AWS S3 using Kognitos, establishing a secure connection to your AWS S3 instance is the first critical step. This section outlines the credentials required for this connection and provides a detailed, step-by-step guide to connect successfully.

Required Credentials

To connect to AWS S3, you will need the following credentials:

AWS Access Key ID: The access key ID associated with your AWS account.
AWS Secret Access Key: The secret access key associated with your AWS account.
AWS S3 Bucket Name: The name of the S3 bucket you wish to interact with.

Step-by-Step Connection Process

Gather Credentials: Ensure you have all the required credentials: AWS Access key ID and Secret Access Key.
Navigate to the Departments tab of Kognitos and search for Microsoft Outlook
Click on + New Book button on the right of the Departments page
Search for AWS S3 and then click on the book which is shown

Add in the credentials when you are prompted

Connection Established: Once the connection is successfully established, you are ready to perform various operations on AWS S3. You can now upload files, retrieve files, delete files, and list files in your S3 bucket.

Working with AWS S3 Objects

Interacting with AWS S3 objects is a core functionality when integrating AWS S3 with Kognitos. This section covers how to upload files, retrieve files, delete files, and list files in your S3 bucket.

Uploading Files to AWS S3

To Dump the File to AWS S3

Procedure Description: Uploads a specified file to an AWS S3 bucket.

Example:

the file
dump the file to aws s3 with
    the s3 path is "s3://mybucket/reports/2023/report.pdf"

Deleting Files from AWS S3

To Purge the File from AWS S3

Procedure Description: Deletes a specified file from AWS S3.

Example:

purge the file from aws s3
    the file path is "s3://mybucket/myfile.txt"

Uploading CSV to AWS S3

To Dump the CSV to AWS S3

Procedure Description: Dumps a CSV (string) to a specified AWS S3 path.

Example:

the csv
dump the csv to aws s3 with
    the bucket is "mybucket"
    the csv path is "data/csvs/myfile.csv"

Deleting CSV from AWS S3

To Purge the CSV from AWS S3

Procedure Description: Purges a CSV file from an AWS S3 bucket.

Example:

purge the csv from aws s3 with
    the bucket is "mybucket"
    the csv path is "sales-data/Q1-sales.csv"

Retrieving Files from AWS S3

To Get a File from AWS S3

Procedure Description: Retrieves a file from AWS S3.

Example:

get the file from aws s3 with
    the bucket is "mybucket"
    the file path is "folder/subfolder/filename.ext"

Listing Files in AWS S3

To List Files from AWS S3

Procedure Description: Lists file paths from an S3 bucket.

Examples:

list files from aws s3
    the bucket is "bucket-name"

list files from aws s3
    the bucket is "bucket-name"
    the file prefix is "folder1"

Uploading Strings to AWS S3

To Dump a String to AWS S3

Procedure Description: Uploads a string to an S3 bucket.

Example:

the string is "Hello, World!"
dump the string to aws s3
    the s3 path is "s3://mock-s3-bucket/kognitos-data.txt"

By following these guidelines, you can effectively manage AWS S3 objects in Kognitos, from uploading and retrieving files to deleting and listing them as needed.

Glossary of Terms

AWS (Amazon Web Services): A comprehensive and widely adopted cloud platform, offering over 200 fully featured services from data centers globally.
AWS S3 (Simple Storage Service): An object storage service that offers industry-leading scalability, data availability, security, and performance.
S3 Bucket: A container for storing objects (files) in AWS S3. Each bucket has a unique name and can store an unlimited number of objects.
S3 Object: A file stored in an S3 bucket. Each object consists of data, metadata, and a unique identifier (key).
AWS Access Key ID: A unique identifier associated with your AWS account, used for programmatic access to AWS services.
AWS Secret Access Key: A secret key associated with your AWS account, used in conjunction with the access key ID to sign programmatic requests to AWS services.