Add CLI examples for Amazon Macie2 core commands #9786
Conversation
- Add enable-macie example showing basic and custom configuration - Add get-findings example showing finding retrieval and filtering - Add create-classification-job example for one-time and scheduled jobs - Improves documentation coverage for Amazon Macie2 security service
elysahall
added
documentation
|
Hi, Could someone please review the PR? |
There was a problem hiding this comment.
Hi @sushilk123, I only have a few requested changes. After you update your examples, commit and push to this PR. Then we should be good for maintainer review.
| @@ -0,0 +1,52 @@ | |||
| **To create a classification job** | |||
There was a problem hiding this comment.
| **To create a classification job** | |
| **Example 1: To create a classification job** |
| --job-type ONE_TIME \ | ||
| --name "ExampleClassificationJob" \ | ||
| --description "Analyze sensitive data in demo bucket" \ | ||
| --s3-job-definition '{ |
There was a problem hiding this comment.
This parameter value either needs to be collapsed onto the same line, or each line also needs a line continuation mark.
| "jobId": "42a1c188d7f838f9f0c1234567890" | ||
| } | ||
|
|
||
| **To create a scheduled classification job** |
There was a problem hiding this comment.
| **To create a scheduled classification job** | |
| **Example 2: To create a scheduled classification job** |
| --job-type SCHEDULED \ | ||
| --name "WeeklyClassificationJob" \ | ||
| --description "Weekly scan for sensitive data" \ | ||
| --schedule-frequency '{ |
There was a problem hiding this comment.
Same here. This parameter value either needs to be collapsed onto the same line, or each line also needs a line continuation mark.
| "dayOfWeek": "SUNDAY" | ||
| } | ||
| }' \ | ||
| --s3-job-definition '{ |
There was a problem hiding this comment.
Same here. This parameter value either needs to be collapsed onto the same line, or each line also needs a line continuation mark.
| "type": "SensitiveData:S3Object/Personal" | ||
| } | ||
| ] | ||
| } |
There was a problem hiding this comment.
Please provide a "For more information" link for every example in this request. See format in the contribution guide: aws.github.io/aws-cli/docs_styleguide.html#for-more-information-link
| @@ -0,0 +1,25 @@ | |||
| **To enable Amazon Macie** | |||
There was a problem hiding this comment.
| **To enable Amazon Macie** | |
| **Example 1: To enable Amazon Macie** |
| "status": "ENABLED" | ||
| } | ||
|
|
||
| **To enable Amazon Macie with custom configuration** |
There was a problem hiding this comment.
| **To enable Amazon Macie with custom configuration** | |
| **Example 2: To enable Amazon Macie with custom configuration** |
| @@ -0,0 +1,88 @@ | |||
| **To retrieve Amazon Macie findings** | |||
There was a problem hiding this comment.
| **To retrieve Amazon Macie findings** | |
| **Example 1: To retrieve Amazon Macie findings** |
| ] | ||
| } | ||
|
|
||
| **To retrieve findings with specific criteria** |
There was a problem hiding this comment.
| **To retrieve findings with specific criteria** | |
| **Example 2: To retrieve findings with specific criteria** |
2 participants
Add CLI examples for Amazon Macie2 core commands
Description
Adds missing CLI examples for Amazon Macie2 security service commands to improve documentation coverage.
Changes
Testing
Examples follow existing AWS CLI documentation format and provide realistic use cases for essential Macie2 security workflows including service setup, finding analysis, and data classification.