Skip to content

Commit 2d5c869

Browse files
authored
Fix HTTP demo S3 download description (#1892)
1 parent f7529db commit 2d5c869

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

demos/http/http_demo_s3_download/http_demo_s3_download.c

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1524,20 +1524,19 @@ static bool getS3ObjectFileSize( size_t * pFileSize,
15241524
/**
15251525
* @brief Entry point of demo.
15261526
*
1527-
* This example, using a pre-signed URL, resolves a S3 domain, establishes a
1528-
* TCP connection, validates the server's certificate using the root CA
1529-
* certificate defined in the config header, then finally performs a TLS
1530-
* handshake with the HTTP server so that all communication is encrypted. After
1531-
* which, the HTTP Client library API is used to download the S3 file (by
1532-
* sending multiple GET requests, filling up the response buffer each time until
1533-
* all parts are downloaded). If any request fails, an error code is returned.
1527+
* This example connects to AWS IoT Core Credential Provider, obtains temporary
1528+
* AWS credentials, resolves an S3 domain, establishes a TCP connection, validates
1529+
* the server's certificate using the root CA certificate defined in the config
1530+
* header, then finally performs a TLS handshake with the HTTP server so that all
1531+
* communication is encrypted. After which, the HTTP Client library API is used
1532+
* to download the S3 file (by sending multiple GET requests, filling up the
1533+
* response buffer each time until all parts are downloaded). If any request
1534+
* fails, an error code is returned.
15341535
*
15351536
* @note This example is single-threaded and uses statically allocated memory.
15361537
*
1537-
* @note This demo requires user-generated pre-signed URLs to be pasted into
1538-
* demo_config.h. Please use the provided script "presigned_urls_gen.py"
1539-
* (located in located in demos/http/common/src) to generate these URLs. For
1540-
* detailed instructions, see the accompanied README.md.
1538+
* @note This demo requires the credential provider endpoint and role to be pasted
1539+
* into demo_config.h, along with the S3 bucket name, region and object key.
15411540
*
15421541
* @note If your file requires more than 99 range requests to S3 (depending on
15431542
* the size of the file and the length specified in RANGE_REQUEST_LENGTH), your

0 commit comments

Comments
 (0)