Skip to content

Commit ff696a3

Browse files
author
AWS
committed
Amazon Macie 2 Update: The Amazon Macie API now has a lastRunErrorStatus property to indicate if account- or bucket-level errors occurred during the run of a one-time classification job or the latest run of a recurring job.
1 parent b137044 commit ff696a3

File tree

2 files changed

+44
-9
lines changed

2 files changed

+44
-9
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Macie 2",
4+
"contributor": "",
5+
"description": "The Amazon Macie API now has a lastRunErrorStatus property to indicate if account- or bucket-level errors occurred during the run of a one-time classification job or the latest run of a recurring job."
6+
}

services/macie2/src/main/resources/codegen-resources/service-2.json

Lines changed: 38 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2937,7 +2937,7 @@
29372937
"additionalOccurrences": {
29382938
"shape": "__boolean",
29392939
"locationName": "additionalOccurrences",
2940-
"documentation": "<p>Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.</p> <p>This value can help you to determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (ClassificationDetails.detailedResultsLocation).</p>"
2940+
"documentation": "<p>Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.</p> <p>This value can help you determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (ClassificationDetails.detailedResultsLocation).</p>"
29412941
},
29422942
"customDataIdentifiers": {
29432943
"shape": "CustomDataIdentifiers",
@@ -2973,7 +2973,7 @@
29732973
"code": {
29742974
"shape": "__string",
29752975
"locationName": "code",
2976-
"documentation": " <p>The status of the finding. Possible values are:</p> <ul><li><p>COMPLETE - Amazon Macie successfully completed its analysis of the object that the finding applies to.</p></li> <li><p>PARTIAL - Macie was able to analyze only a subset of the data in the object that the finding applies to. For example, the object is a compressed or archive file that contains files in an unsupported format.</p></li> <li><p>SKIPPED - Macie wasn't able to analyze the object that the finding applies to. For example, the object is a malformed file or a file that uses an unsupported format.</p></li></ul>"
2976+
"documentation": " <p>The status of the finding. Possible values are:</p> <ul><li><p>COMPLETE - Amazon Macie successfully completed its analysis of the object that the finding applies to.</p></li> <li><p>PARTIAL - Macie analyzed only a subset of the data in the object that the finding applies to. For example, the object is an archive file that contains files in an unsupported format.</p></li> <li><p>SKIPPED - Macie wasn't able to analyze the object that the finding applies to. For example, the object is a malformed file or a file that uses an unsupported format.</p></li></ul>"
29772977
},
29782978
"reason": {
29792979
"shape": "__string",
@@ -3288,7 +3288,7 @@
32883288
"eqExactMatch": {
32893289
"shape": "__listOf__string",
32903290
"locationName": "eqExactMatch",
3291-
"documentation": "<p>A condition that requires an array field of a finding to exactly match the specified property values. You can use this operator with the following properties: customDataIdentifiers.detections.arn, customDataIdentifiers.detections.name, resourcesAffected.s3Bucket.tags.key, resourcesAffected.s3Bucket.tags.value, resourcesAffected.s3Object.tags.key, resourcesAffected.s3Object.tags.value, sensitiveData.category, and sensitiveData.detections.type.</p>"
3291+
"documentation": "<p>A condition that requires an array field on a finding to exactly match the specified property values. You can use this operator with the following properties: customDataIdentifiers.detections.arn, customDataIdentifiers.detections.name, resourcesAffected.s3Bucket.tags.key, resourcesAffected.s3Bucket.tags.value, resourcesAffected.s3Object.tags.key, resourcesAffected.s3Object.tags.value, sensitiveData.category, and sensitiveData.detections.type.</p>"
32923292
},
32933293
"gt": {
32943294
"shape": "__long",
@@ -3653,6 +3653,11 @@
36533653
"locationName": "jobType",
36543654
"documentation": "<p>The schedule for running the job. Possible values are:</p> <ul><li><p>ONE_TIME - The job runs only once.</p></li> <li><p>SCHEDULED - The job runs on a daily, weekly, or monthly basis. The scheduleFrequency property indicates the recurrence pattern for the job.</p></li></ul>"
36553655
},
3656+
"lastRunErrorStatus": {
3657+
"shape": "LastRunErrorStatus",
3658+
"locationName": "lastRunErrorStatus",
3659+
"documentation": "<p>Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.</p>"
3660+
},
36563661
"lastRunTime": {
36573662
"shape": "__timestampIso8601",
36583663
"locationName": "lastRunTime",
@@ -3913,7 +3918,7 @@
39133918
"count": {
39143919
"shape": "__long",
39153920
"locationName": "count",
3916-
"documentation": "<p>The total number of occurrences of the finding.</p>"
3921+
"documentation": "<p>The total number of occurrences of the finding. For sensitive data findings, this value is always 1. All sensitive data findings are considered new (unique) because they derive from individual classification jobs.</p>"
39173922
},
39183923
"createdAt": {
39193924
"shape": "__timestampIso8601",
@@ -4890,6 +4895,11 @@
48904895
"locationName": "jobType",
48914896
"documentation": "<p>The schedule for running the job. Possible values are:</p> <ul><li><p>ONE_TIME - The job runs only once.</p></li> <li><p>SCHEDULED - The job runs on a daily, weekly, or monthly basis.</p></li></ul>"
48924897
},
4898+
"lastRunErrorStatus": {
4899+
"shape": "LastRunErrorStatus",
4900+
"locationName": "lastRunErrorStatus",
4901+
"documentation": "<p>Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.</p>"
4902+
},
48934903
"name": {
48944904
"shape": "__string",
48954905
"locationName": "name",
@@ -4922,7 +4932,7 @@
49224932
"value": {
49234933
"shape": "__string",
49244934
"locationName": "value",
4925-
"documentation": "<p>One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be empty or null.</p>"
4935+
"documentation": "<p>One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be an empty string.</p>"
49264936
}
49274937
},
49284938
"documentation": "<p>Provides information about the tags that are associated with an S3 bucket or object. Each tag consists of a required tag key and an associated tag value.</p>"
@@ -4934,6 +4944,25 @@
49344944
"shape": "KeyValuePair"
49354945
}
49364946
},
4947+
"LastRunErrorStatus": {
4948+
"type": "structure",
4949+
"members": {
4950+
"code": {
4951+
"shape": "LastRunErrorStatusCode",
4952+
"locationName": "code",
4953+
"documentation": "<p>Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run. Possible values are:</p> <ul><li><p>ERROR - One or more errors occurred. Amazon Macie didn't process all the data specified for the job.</p></li> <li><p>NONE - No errors occurred. Macie processed all the data specified for the job.</p></li></ul>"
4954+
}
4955+
},
4956+
"documentation": "<p>Specifies whether any account- or bucket-level access errors occurred when a classification job ran. For example, the job is configured to analyze data for a member account that was suspended, or the job is configured to analyze an S3 bucket that Amazon Macie isn't allowed to access.</p>"
4957+
},
4958+
"LastRunErrorStatusCode": {
4959+
"type": "string",
4960+
"documentation": "<p>Specifies whether any account- or bucket-level access errors occurred during the run of a one-time classification job ran or the most recent run of a recurring classification job. Possible values are:</p>",
4961+
"enum": [
4962+
"NONE",
4963+
"ERROR"
4964+
]
4965+
},
49374966
"ListClassificationJobsRequest": {
49384967
"type": "structure",
49394968
"members": {
@@ -5408,7 +5437,7 @@
54085437
"offsetRanges": {
54095438
"shape": "Ranges",
54105439
"locationName": "offsetRanges",
5411-
"documentation": "<p>An array of objects, one for each occurrence of sensitive data in a binary text file. Each object specifies the position of the data relative to the beginning of the file.</p> <p>This value is typically null. For binary text files, Macie adds location data to a lineRanges.Range or Page object, depending on the file type.</p>"
5440+
"documentation": "<p>An array of objects, one for each occurrence of sensitive data in a binary text file. Each object specifies the position of the data relative to the beginning of the file.</p> <p>This value is typically null. For binary text files, Amazon Macie adds location data to a lineRanges.Range or Page object, depending on the file type.</p>"
54125441
},
54135442
"pages": {
54145443
"shape": "Pages",
@@ -5418,7 +5447,7 @@
54185447
"records": {
54195448
"shape": "Records",
54205449
"locationName": "records",
5421-
"documentation": "<p>An array of objects, one for each occurrence of sensitive data in an Apache Avro object container or Apache Parquet file. Each object specifies the field or record that contains the data. This value is null for all other types of files.</p>"
5450+
"documentation": "<p>An array of objects, one for each occurrence of sensitive data in an Apache Avro object container or Apache Parquet file. Each object specifies the record index and the path to the field in the record that contains the data. This value is null for all other types of files.</p>"
54225451
}
54235452
},
54245453
"documentation": "<p>Provides the location of 1-15 occurrences of sensitive data that was detected by managed data identifiers or a custom data identifier and produced a sensitive data finding.</p>"
@@ -5531,7 +5560,7 @@
55315560
"jsonPath": {
55325561
"shape": "__string",
55335562
"locationName": "jsonPath",
5534-
"documentation": "<p>The path, as a JSONPath expression, to the field (in an Apache Avro object container) or record (in an Apache Parquet file) that contains the data.</p> <p>If the name of an element exceeds 20 characters, Amazon Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.</p>"
5563+
"documentation": "<p>The path, as a JSONPath expression, to the field in the record that contains the data.</p> <p>If the name of an element exceeds 20 characters, Amazon Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.</p>"
55355564
},
55365565
"recordIndex": {
55375566
"shape": "__long",
@@ -5836,7 +5865,7 @@
58365865
"category": {
58375866
"shape": "SensitiveDataItemCategory",
58385867
"locationName": "category",
5839-
"documentation": "<p>The category of sensitive data that was detected. For example: FINANCIAL_INFORMATION, for financial information such as credit card numbers; PERSONAL_INFORMATION, for personally identifiable information, such as full names and mailing addresses, or personal health information; or, CUSTOM_IDENTIFIER, for data that was detected by a custom data identifier.</p>"
5868+
"documentation": "<p>The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or AWS secret keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as driver's license identification numbers.</p>"
58405869
},
58415870
"detections": {
58425871
"shape": "DefaultDetections",

0 commit comments

Comments
 (0)