Skip to content

Commit bb31004

Browse files
author
AWS
committed
Amazon Macie 2 Update: This release of the Amazon Macie API includes miscellaneous updates and improvements to the documentation.
1 parent 24a5a7b commit bb31004

File tree

2 files changed

+31
-25
lines changed

2 files changed

+31
-25
lines changed

‎.changes/next-release/feature-AmazonMacie2-4995c66.json

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": "This release of the Amazon Macie API includes miscellaneous updates and improvements to the documentation."
6+
}

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

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -927,7 +927,7 @@
927927
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
928928
}
929929
],
930-
"documentation": "<p>(Deprecated) Disassociates a member account from its Amazon Macie administrator account.</p>"
930+
"documentation": "<p>(Deprecated) Disassociates a member account from its Amazon Macie administrator account. This operation has been replaced by the <link linkend=\"DisassociateFromAdministratorAccount\">DisassociateFromAdministratorAccount</link> operation.</p>"
931931
},
932932
"DisassociateMember": {
933933
"name": "DisassociateMember",
@@ -1524,7 +1524,7 @@
15241524
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
15251525
}
15261526
],
1527-
"documentation": "<p>(Deprecated) Retrieves information about the Amazon Macie administrator account for an account.</p>"
1527+
"documentation": "<p>(Deprecated) Retrieves information about the Amazon Macie administrator account for an account. This operation has been replaced by the <link linkend=\"GetAdministratorAccount\">GetAdministratorAccount</link> operation.</p>"
15281528
},
15291529
"GetMember": {
15301530
"name": "GetMember",
@@ -2821,7 +2821,7 @@
28212821
"classifiableSizeInBytes": {
28222822
"shape": "__long",
28232823
"locationName": "classifiableSizeInBytes",
2824-
"documentation": "<p>The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p>"
2824+
"documentation": "<p>The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p> <p>If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.</p>"
28252825
},
28262826
"jobDetails": {
28272827
"shape": "JobDetails",
@@ -2831,7 +2831,7 @@
28312831
"lastUpdated": {
28322832
"shape": "__timestampIso8601",
28332833
"locationName": "lastUpdated",
2834-
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved data about the bucket from Amazon S3.</p>"
2834+
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved both bucket and object metadata from Amazon S3 for the bucket.</p>"
28352835
},
28362836
"objectCount": {
28372837
"shape": "__long",
@@ -2871,12 +2871,12 @@
28712871
"sizeInBytes": {
28722872
"shape": "__long",
28732873
"locationName": "sizeInBytes",
2874-
"documentation": "<p>The total storage size, in bytes, of the bucket.</p>"
2874+
"documentation": "<p>The total storage size, in bytes, of the bucket.</p> <p>If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.</p>"
28752875
},
28762876
"sizeInBytesCompressed": {
28772877
"shape": "__long",
28782878
"locationName": "sizeInBytesCompressed",
2879-
"documentation": "<p>The total compressed storage size, in bytes, of the bucket.</p>"
2879+
"documentation": "<p>The total compressed storage size, in bytes, of the bucket.</p> <p>If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.</p>"
28802880
},
28812881
"tags": {
28822882
"shape": "__listOfKeyValuePair",
@@ -2971,12 +2971,12 @@
29712971
"attributeName": {
29722972
"shape": "__string",
29732973
"locationName": "attributeName",
2974-
"documentation": "<p>The name of the property to sort the results by. This value can be the name of any property that Amazon Macie defines as bucket metadata, such as bucketName or accountId.</p>"
2974+
"documentation": "<p>The name of the bucket property to sort the results by. This value can be one of the following properties that Amazon Macie defines as bucket metadata: accountId, bucketName, classifiableObjectCount, classifiableSizeInBytes, objectCount, or sizeInBytes.</p>"
29752975
},
29762976
"orderBy": {
29772977
"shape": "OrderBy",
29782978
"locationName": "orderBy",
2979-
"documentation": "<p>The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.</p>"
2979+
"documentation": "<p>The sort order to apply to the results, based on the value specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.</p>"
29802980
}
29812981
},
29822982
"documentation": "<p>Specifies criteria for sorting the results of a query for information about S3 buckets.</p>"
@@ -4322,12 +4322,12 @@
43224322
"classifiableSizeInBytes": {
43234323
"shape": "__long",
43244324
"locationName": "classifiableSizeInBytes",
4325-
"documentation": "<p>The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p>"
4325+
"documentation": "<p>The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p> <p>If versioning is enabled for any of the buckets, Macie calculates this value based on the size of the latest version of each applicable object in those buckets. This value doesn't reflect the storage size of all versions of all applicable objects in the buckets.</p>"
43264326
},
43274327
"lastUpdated": {
43284328
"shape": "__timestampIso8601",
43294329
"locationName": "lastUpdated",
4330-
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved data about the buckets from Amazon S3.</p>"
4330+
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved both bucket and object metadata from Amazon S3 for the buckets.</p>"
43314331
},
43324332
"objectCount": {
43334333
"shape": "__long",
@@ -4337,12 +4337,12 @@
43374337
"sizeInBytes": {
43384338
"shape": "__long",
43394339
"locationName": "sizeInBytes",
4340-
"documentation": "<p>The total storage size, in bytes, of the buckets.</p>"
4340+
"documentation": "<p>The total storage size, in bytes, of the buckets.</p> <p>If versioning is enabled for any of the buckets, Macie calculates this value based on the size of the latest version of each object in those buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.</p>"
43414341
},
43424342
"sizeInBytesCompressed": {
43434343
"shape": "__long",
43444344
"locationName": "sizeInBytesCompressed",
4345-
"documentation": "<p>The total compressed storage size, in bytes, of the buckets.</p>"
4345+
"documentation": "<p>The total compressed storage size, in bytes, of the buckets.</p> <p>If versioning is enabled for any of the buckets, Macie calculates this value based on the size of the latest version of each object in those buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.</p>"
43464346
},
43474347
"unclassifiableObjectCount": {
43484348
"shape": "ObjectLevelStatistics",
@@ -4352,7 +4352,7 @@
43524352
"unclassifiableObjectSizeInBytes": {
43534353
"shape": "ObjectLevelStatistics",
43544354
"locationName": "unclassifiableObjectSizeInBytes",
4355-
"documentation": "<p>The total storage size, in bytes, of all the objects that Amazon Macie can't analyze in the buckets. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.</p>"
4355+
"documentation": "<p>The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the buckets. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.</p>"
43564356
}
43574357
}
43584358
},
@@ -4752,7 +4752,7 @@
47524752
"shape": "__string",
47534753
"location": "querystring",
47544754
"locationName": "timeRange",
4755-
"documentation": "<p>The time period to retrieve the data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don\u2019t specify a value for this parameter, Amazon Macie provides aggregated usage data for the preceding 30 days.</p>"
4755+
"documentation": "<p>The inclusive time period to retrieve the data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value for this parameter, Amazon Macie provides aggregated usage data for the preceding 30 days.</p>"
47564756
}
47574757
}
47584758
},
@@ -5441,7 +5441,7 @@
54415441
"shape": "__string",
54425442
"location": "querystring",
54435443
"locationName": "onlyAssociated",
5444-
"documentation": "<p>Specifies which accounts to include in the response, based on the status of an account's relationship with the administrator account. By default, the response includes only current member accounts. To include all accounts, set the value for this parameter to false.</p>"
5444+
"documentation": "<p>Specifies which accounts to include in the response, based on the status of an account's relationship with the administrator account. By default, the response includes only current member accounts. To include all accounts, set this value to false.</p>"
54455445
}
54465446
}
54475447
},
@@ -5586,7 +5586,7 @@
55865586
"dayOfMonth": {
55875587
"shape": "__integer",
55885588
"locationName": "dayOfMonth",
5589-
"documentation": "<p>The numeric day of the month when Amazon Macie runs the job. This value can be an integer from 1 through 31.</p> <p>If this value exceeds the number of days in a certain month, Macie runs the job on the last day of that month. For example, if this value is 31 and a month has only 30 days, Macie runs the job on day 30 of that month.</p>"
5589+
"documentation": "<p>The numeric day of the month when Amazon Macie runs the job. This value can be an integer from 1 through 31.</p> <p>If this value exceeds the number of days in a certain month, Macie doesn't run the job that month. Macie runs the job only during months that have the specified day. For example, if this value is 31 and a month has only 30 days, Macie doesn't run the job that month. To run the job every month, specify a value that's less than 29.</p>"
55905590
}
55915591
},
55925592
"documentation": "<p>Specifies a monthly recurrence pattern for running a classification job.</p>"
@@ -5636,7 +5636,7 @@
56365636
"documentation": "<p>The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class or don't have a file name extension for a supported file or storage format.</p>"
56375637
}
56385638
},
5639-
"documentation": "<p>Provides information about the total storage size (in bytes) or number of objects that Amazon Macie can't analyze in one or more S3 buckets. In a BucketMetadata object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results.</p>"
5639+
"documentation": "<p>Provides information about the total storage size (in bytes) or number of objects that Amazon Macie can't analyze in one or more S3 buckets. In a BucketMetadata object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results. If versioning is enabled for a bucket, total storage size values are based on the size of the latest version of each applicable object in the bucket.</p>"
56405640
},
56415641
"Occurrences": {
56425642
"type": "structure",
@@ -6021,7 +6021,7 @@
60216021
"serverSideEncryption": {
60226022
"shape": "ServerSideEncryption",
60236023
"locationName": "serverSideEncryption",
6024-
"documentation": "<p>The type of server-side encryption that's used for the object.</p>"
6024+
"documentation": "<p>The type of server-side encryption that's used to encrypt the object.</p>"
60256025
},
60266026
"size": {
60276027
"shape": "__long",
@@ -6118,12 +6118,12 @@
61186118
"encryptionType": {
61196119
"shape": "EncryptionType",
61206120
"locationName": "encryptionType",
6121-
"documentation": "<p>The server-side encryption algorithm that's used when storing data in the bucket or object. If encryption is disabled for the bucket or object, this value is NONE.</p>"
6121+
"documentation": "<p>The server-side encryption algorithm that's used when storing data in the bucket or object. If default encryption is disabled for the bucket or the object isn't encrypted using server-side encryption, this value is NONE.</p>"
61226122
},
61236123
"kmsMasterKeyId": {
61246124
"shape": "__string",
61256125
"locationName": "kmsMasterKeyId",
6126-
"documentation": "<p>The unique identifier for the AWS Key Management Service (AWS KMS) master key that's used to encrypt the bucket or object. This value is null if AWS KMS isn't used to encrypt the bucket or object.</p>"
6126+
"documentation": "<p>The Amazon Resource Name (ARN) or unique identifier (key ID) for the AWS Key Management Service (AWS KMS) customer master key (CMK) that's used to encrypt data in the bucket or the object. If an AWS KMS CMK isn't used, this value is null.</p>"
61276127
}
61286128
},
61296129
"documentation": "<p>Provides information about the server-side encryption settings for an S3 bucket or S3 object.</p>"
@@ -6626,7 +6626,7 @@
66266626
"status": {
66276627
"shape": "MacieStatus",
66286628
"locationName": "status",
6629-
"documentation": "<p>Specifies whether to change the status of the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.</p>"
6629+
"documentation": "<p>Specifies a new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.</p>"
66306630
}
66316631
}
66326632
},
@@ -6664,7 +6664,7 @@
66646664
"autoEnable": {
66656665
"shape": "__boolean",
66666666
"locationName": "autoEnable",
6667-
"documentation": "<p>Specifies whether Amazon Macie is enabled automatically for each account, when the account is added to the AWS organization.</p>"
6667+
"documentation": "<p>Specifies whether to enable Amazon Macie automatically for each account, when the account is added to the AWS organization.</p>"
66686668
}
66696669
},
66706670
"required": [
@@ -6738,10 +6738,10 @@
67386738
"values": {
67396739
"shape": "__listOf__string",
67406740
"locationName": "values",
6741-
"documentation": "<p>An array that lists values to use in the condition, based on the value for the field specified by the key property. If the value for the key property is accountId, this array can specify multiple values. Otherwise, this array can specify only one value.</p> <p>Valid values for each supported field are:</p> <ul><li><p>accountId - The unique identifier for an AWS account.</p></li></ul> <ul><li><p>freeTrialStartDate - The date and time, in UTC and extended ISO 8601 format, when the free trial started for an account.</p></li></ul> <ul><li><p>serviceLimit - A Boolean (true or false) value that indicates whether an account has reached its monthly quota.</p></li></ul> <ul><li><p>total - A string that represents the current, estimated month-to-date cost for an account.</p></li></ul>"
6741+
"documentation": "<p>An array that lists values to use in the condition, based on the value for the field specified by the key property. If the value for the key property is accountId, this array can specify multiple values. Otherwise, this array can specify only one value.</p> <p>Valid values for each supported field are:</p> <ul><li><p>accountId - The unique identifier for an AWS account.</p></li></ul> <ul><li><p>freeTrialStartDate - The date and time, in UTC and extended ISO 8601 format, when the free trial started for an account.</p></li></ul> <ul><li><p>serviceLimit - A Boolean (true or false) value that indicates whether an account has reached its monthly quota.</p></li></ul> <ul><li><p>total - A string that represents the current estimated cost for an account.</p></li></ul>"
67426742
}
67436743
},
6744-
"documentation": "<p>Specifies a condition for filtering the results of a query for the quotas and usage data that applies to one or more Amazon Macie accounts.</p>"
6744+
"documentation": "<p>Specifies a condition for filtering the results of a query for quota and usage data for one or more Amazon Macie accounts.</p>"
67456745
},
67466746
"UsageStatisticsFilterComparator": {
67476747
"type": "string",
@@ -7099,4 +7099,4 @@
70997099
}
71007100
},
71017101
"documentation": "<p>Amazon Macie is a fully managed data security and data privacy service that uses machine learning and pattern matching to discover and protect your sensitive data in AWS. Macie automates the discovery of sensitive data, such as PII and intellectual property, to provide you with insight into the data that your organization stores in AWS. Macie also provides an inventory of your Amazon S3 buckets, which it continually monitors for you. If Macie detects sensitive data or potential data access issues, it generates detailed findings for you to review and act upon as necessary.</p>"
7102-
}
7102+
}

0 commit comments

Comments
 (0)