Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions awscli/examples/macie2/create-classification-job.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
**To create a classification job**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**To create a classification job**
**Example 1: To create a classification job**


The following ``create-classification-job`` example creates a classification job that analyzes objects in the specified S3 bucket for sensitive data. ::

aws macie2 create-classification-job \
--job-type ONE_TIME \
--name "ExampleClassificationJob" \
--description "Analyze sensitive data in demo bucket" \
--s3-job-definition '{
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This parameter value either needs to be collapsed onto the same line, or each line also needs a line continuation mark.

"bucketDefinitions": [
{
"accountId": "123456789012",
"buckets": ["amzn-s3-demo-bucket"]
}
]
}'

Output::

{
"jobArn": "arn:aws:macie2:us-east-1:123456789012:classification-job/42a1c188d7f838f9f0c1234567890",
"jobId": "42a1c188d7f838f9f0c1234567890"
}

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

**To create a scheduled classification job**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**To create a scheduled classification job**
**Example 2: To create a scheduled classification job**


The following ``create-classification-job`` example creates a classification job that runs weekly to analyze new objects. ::

aws macie2 create-classification-job \
--job-type SCHEDULED \
--name "WeeklyClassificationJob" \
--description "Weekly scan for sensitive data" \
--schedule-frequency '{
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here. This parameter value either needs to be collapsed onto the same line, or each line also needs a line continuation mark.

"weeklySchedule": {
"dayOfWeek": "SUNDAY"
}
}' \
--s3-job-definition '{
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here. This parameter value either needs to be collapsed onto the same line, or each line also needs a line continuation mark.

"bucketDefinitions": [
{
"accountId": "123456789012",
"buckets": ["amzn-s3-demo-bucket"]
}
]
}'

Output::

{
"jobArn": "arn:aws:macie2:us-east-1:123456789012:classification-job/52b2c299e8g949g0g1d2345678901",
"jobId": "52b2c299e8g949g0g1d2345678901"
}
25 changes: 25 additions & 0 deletions awscli/examples/macie2/enable-macie.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
**To enable Amazon Macie**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**To enable Amazon Macie**
**Example 1: To enable Amazon Macie**


The following ``enable-macie`` example enables Amazon Macie for the current AWS account and Region. ::

aws macie2 enable-macie

Output::

{
"status": "ENABLED"
}

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

**To enable Amazon Macie with custom configuration**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**To enable Amazon Macie with custom configuration**
**Example 2: To enable Amazon Macie with custom configuration**


The following ``enable-macie`` example enables Amazon Macie with a custom finding publishing frequency and status. ::

aws macie2 enable-macie \
--finding-publishing-frequency FIFTEEN_MINUTES \
--status PAUSED

Output::

{
"status": "PAUSED"
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

88 changes: 88 additions & 0 deletions awscli/examples/macie2/get-findings.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
**To retrieve Amazon Macie findings**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**To retrieve Amazon Macie findings**
**Example 1: To retrieve Amazon Macie findings**


The following ``get-findings`` example retrieves the details of up to 3 findings. ::

aws macie2 get-findings \
--finding-ids "64ed80b084b5b7b985b12345" "64ed80b084b5b7b985b67890" \
--sort-criteria attributeName=severity.score,orderBy=DESC

Output::

{
"findings": [
{
"accountId": "123456789012",
"archived": false,
"category": "POLICY",
"classificationDetails": {
"detailedResultsLocation": "s3://amzn-s3-demo-bucket/sensitive-data/results.json",
"jobArn": "arn:aws:macie2:us-east-1:123456789012:classification-job/42a1c188d7f838f9f0c1234567890",
"result": {
"status": {
"code": "COMPLETE"
}
}
},
"count": 2,
"createdAt": "2023-05-07T20:21:01.656000+00:00",
"description": "The S3 bucket is publicly readable.",
"id": "64ed80b084b5b7b985b12345",
"partition": "aws",
"region": "us-east-1",
"resourcesAffected": {
"s3Bucket": {
"arn": "arn:aws:s3:::amzn-s3-demo-bucket",
"name": "amzn-s3-demo-bucket",
"owner": {
"displayName": "example-user",
"id": "111122223333"
},
"publicAccess": {
"effectivePermission": "PUBLIC",
"permissionConfiguration": {
"bucketLevelPermissions": {
"accessControlList": {
"allowsPublicReadAccess": true,
"allowsPublicWriteAccess": false
}
}
}
}
}
},
"severity": {
"description": "High",
"score": 7.4
},
"title": "Bucket policy allows public read access",
"type": "Policy:IAMUser/S3BucketPublicReadAccess",
"updatedAt": "2023-05-07T20:21:01.656000+00:00"
}
]
}

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

**To retrieve findings with specific criteria**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**To retrieve findings with specific criteria**
**Example 2: To retrieve findings with specific criteria**


The following ``get-findings`` example retrieves findings that match specific criteria, such as findings with high severity. ::

aws macie2 get-findings \
--finding-ids "64ed80b084b5b7b985b12345" \
--sort-criteria attributeName=createdAt,orderBy=ASC

Output::

{
"findings": [
{
"accountId": "123456789012",
"archived": false,
"category": "CLASSIFICATION",
"severity": {
"description": "High",
"score": 8.1
},
"title": "Sensitive data was detected in an S3 object",
"type": "SensitiveData:S3Object/Personal"
}
]
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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