GetObject Flow Documentation (#402)

Co-authored-by: Michael Graeb <[email protected]>

Author: waahm7

README.md

@@ -1,6 +1,19 @@
 ## AWS C S3
 
-C99 library implementation for communicating with the S3 service, designed for maximizing throughput on high bandwidth EC2 instances.
+The AWS-C-S3 library is an asynchronous AWS S3 client focused on maximizing throughput and network utilization.
+
+### Key features:
+- **Automatic Request Splitting**: Improves throughput by automatically splitting the request into part-sized chunks and performing parallel uploads/downloads of these chunks over multiple connections. There's a cap on the throughput of single S3 connection, the only way to go faster is multiple parallel connections.
+- **Automatic Retries**: Increases resilience by retrying individual failed chunks of a file transfer, eliminating the need to restart transfers from scratch after an intermittent error.
+- **DNS Load Balancing**: DNS resolver continuously harvests Amazon S3 IP addresses. When load is spread across the S3 fleet, overall throughput is better than if all connections were hammering the same IP simultaneously.
+- **Advanced Network Management**: The client incorporates automatic request parallelization, effective timeouts and retries, and efficient connection reuse. This approach helps to maximize throughput and network utilization, and to avoid network overloads.
+- **Thread Pools and Async I/O**: Avoids bottlenecks associated with single-thread processing.
+- **Parallel Reads**: When uploading a large file from disk, reads from multiple parts of the file in parallel. This is faster than reading the file sequentially from beginning to end.
+
+### Documentation
+
+- [GetObject](docs/GetObject.md): A visual representation of the GetObject request flow.
+- [Memory Aware Requests Execution](docs/memory_aware_request_execution.md): An in-depth guide on optimizing memory usage during request executions.
 
 ## License
 

docs/GetObject.md

@@ -0,0 +1,9 @@
+# GetObject
+
+## Overview
+The `GetObject` is used to download objects from Amazon S3. Optimized for throughput, the CRT S3 client enhances performance and reliability by parallelizing multiple part-sized `GetObject` with range requests.
+
+## Flow Diagram
+Below is the typical flow of a GetObject request made by the user.
+
+![GetObject Flow Diagram](images/GetObjectFlow.svg)

docs/images/GetObjectFlow.svg

@@ -5,7 +5,7 @@ receiving for each request and scaling requests in flight has direct impact on
 memory used. In practice, setting high target throughput or larger part size can
 lead to high observed memory usage.
 
-To mitigate high memory usages, memory reuse improvements were recently added to
+To mitigate high memory usages, memory reuse improvements were added to
 the client along with options to limit max memory used. The following sections
 will go into more detail on aspects of those changes and how the affect the
 client.