Skip to content

Commit adcbbd3

Browse files
committed
updating README
1 parent 1259e83 commit adcbbd3

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
## Introduction
1+
# Guidance for Enterprise Search and Audit for Amazon S3
22

3-
## Support
3+
## Overview
44

5-
If you notice a defect, or need support with deployment or demonstrating the kit, create an Issue here: [link to issue board]
5+
This solution was built to allow for meta-data search of S3 objects in multiple S3 buckets and AWS accounts. Additionally, this solution allows the users to collect GET request data information from S3 Access Logs to collate access information on an individual object basis. Meta-data stored about each object includes all S3 tags, created date, encryption status, storage layer, and more. All this information is searchable through the provided ReactJS interface but customers can access the information directly in the OpenSearch cluster included with this solution.
66

77
## Prerequisities
88

9-
The only prerequisite for this solution is the proper access to run the CloudFormation template to set up S3 Auditor Lambda, SQS, SNS, IAM Permissions, OpenSearch Cluster, API Gateway and S3 permissions
9+
The only prerequisite for this solution is the proper access to run the CloudFormation template to set up S3 Auditor Lambda, SQS, SNS, IAM Permissions, OpenSearch Cluster, API Gateway and S3 permissions.
1010

1111
## Architecture
1212

@@ -203,3 +203,8 @@ If you have an existing bucket you would like to add to the S3 Auditor, you can
203203
- `log_filename` - log filename for logging the activity from the import process
204204
- This will run until all the objects from the inventory file are added to the queue to be processed by S3 Auditor
205205

206+
207+
## Notices (optional)
208+
209+
Customers are responsible for making their own independent assessment of the information in this Guidance. This Guidance: (a) is for informational purposes only, (b) represents AWS current product offerings and practices, which are subject to change without notice, and (c) does not create any commitments or assurances from AWS and its affiliates, suppliers or licensors. AWS products or services are provided “as is” without warranties, representations, or conditions of any kind, whether express or implied. AWS responsibilities and liabilities to its customers are controlled by AWS agreements, and this Guidance is not part of, nor does it modify, any agreement between AWS and its customers.
210+

0 commit comments

Comments
 (0)