Skip to content

Commit c52730d

Browse files
author
AWS
committed
Amazon Macie 2 Update: This release of the Amazon Macie API adds support for specifying a time range in queries for usage data.
1 parent ea0f57a commit c52730d

File tree

2 files changed

+91
-26
lines changed

2 files changed

+91
-26
lines changed

‎.changes/next-release/feature-AmazonMacie2-9516028.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 adds support for specifying a time range in queries for usage data."
6+
}

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

Lines changed: 85 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2351,10 +2351,10 @@
23512351
"blockPublicAccess": {
23522352
"shape": "BlockPublicAccess",
23532353
"locationName": "blockPublicAccess",
2354-
"documentation": "<p>The block public access settings for the bucket.</p>"
2354+
"documentation": "<p>The block public access settings for the AWS account that owns the bucket.</p>"
23552355
}
23562356
},
2357-
"documentation": "<p>Provides information about account-level permissions settings that apply to an S3 bucket.</p>"
2357+
"documentation": "<p>Provides information about the account-level permissions settings that apply to an S3 bucket.</p>"
23582358
},
23592359
"AdminAccount": {
23602360
"type": "structure",
@@ -2583,20 +2583,20 @@
25832583
"kmsManaged": {
25842584
"shape": "__long",
25852585
"locationName": "kmsManaged",
2586-
"documentation": " <p>The total number of buckets that use an AWS Key Management Service (AWS KMS) customer master key (CMK) by default to encrypt objects. These buckets use AWS managed AWS KMS (AWS-KMS) encryption or customer managed AWS KMS (SSE-KMS) encryption.</p>"
2586+
"documentation": " <p>The total number of buckets that use an AWS Key Management Service (AWS KMS) customer master key (CMK) to encrypt new objects by default. These buckets use AWS managed AWS KMS encryption (AWS-KMS) or customer managed AWS KMS encryption (SSE-KMS).</p>"
25872587
},
25882588
"s3Managed": {
25892589
"shape": "__long",
25902590
"locationName": "s3Managed",
2591-
"documentation": "<p>The total number of buckets that use an Amazon S3 managed key by default to encrypt objects. These buckets use Amazon S3 managed (SSE-S3) encryption.</p>"
2591+
"documentation": "<p>The total number of buckets that use an Amazon S3 managed key to encrypt new objects by default. These buckets use Amazon S3 managed encryption (SSE-S3).</p>"
25922592
},
25932593
"unencrypted": {
25942594
"shape": "__long",
25952595
"locationName": "unencrypted",
2596-
"documentation": "<p>The total number of buckets that don't encrypt objects by default. Default encryption is disabled for these buckets.</p>"
2596+
"documentation": "<p>The total number of buckets that don't encrypt new objects by default. Default encryption is disabled for these buckets.</p>"
25972597
}
25982598
},
2599-
"documentation": "<p>Provides information about the number of S3 buckets that use certain types of server-side encryption or don't encrypt objects by default.</p>"
2599+
"documentation": "<p>Provides information about the number of S3 buckets that use certain types of server-side encryption by default or don't encrypt new objects by default.</p>"
26002600
},
26012601
"BucketCountBySharedAccessType": {
26022602
"type": "structure",
@@ -2752,7 +2752,7 @@
27522752
"publicAccess": {
27532753
"shape": "BucketPublicAccess",
27542754
"locationName": "publicAccess",
2755-
"documentation": "<p>Specifies whether the bucket is publicly accessible. If this value is true, an access control list (ACL), bucket policy, or block public access settings allow the bucket to be accessed by the general public.</p>"
2755+
"documentation": "<p>Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.</p>"
27562756
},
27572757
"region": {
27582758
"shape": "__string",
@@ -2764,6 +2764,11 @@
27642764
"locationName": "replicationDetails",
27652765
"documentation": "<p>Specifies whether the bucket is configured to replicate one or more objects to buckets for other AWS accounts and, if so, which accounts.</p>"
27662766
},
2767+
"serverSideEncryption": {
2768+
"shape": "BucketServerSideEncryption",
2769+
"locationName": "serverSideEncryption",
2770+
"documentation": "<p>Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption that's used.</p>"
2771+
},
27672772
"sharedAccess": {
27682773
"shape": "SharedAccess",
27692774
"locationName": "sharedAccess",
@@ -2850,6 +2855,22 @@
28502855
},
28512856
"documentation": "<p>Provides information about the permissions settings that determine whether an S3 bucket is publicly accessible.</p>"
28522857
},
2858+
"BucketServerSideEncryption": {
2859+
"type": "structure",
2860+
"members": {
2861+
"kmsMasterKeyId": {
2862+
"shape": "__string",
2863+
"locationName": "kmsMasterKeyId",
2864+
"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 by default to encrypt objects that are added to the bucket. This value is null if the bucket uses an Amazon S3 managed key to encrypt new objects or the bucket doesn't encrypt new objects by default.</p>"
2865+
},
2866+
"type": {
2867+
"shape": "Type",
2868+
"locationName": "type",
2869+
"documentation": "<p>The type of server-side encryption that's used by default when storing new objects in the bucket. Possible values are:</p> <ul><li><p>AES256 - New objects are encrypted with an Amazon S3 managed key and use Amazon S3 managed encryption (SSE-S3).</p></li> <li><p>aws:kms - New objects are encrypted with an AWS KMS CMK, specified by the kmsMasterKeyId property, and use AWS managed AWS KMS encryption (AWS-KMS) or customer managed AWS KMS encryption (SSE-KMS).</p></li> <li><p>NONE - New objects aren't encrypted by default. Default encryption is disabled for the bucket.</p></li></ul>"
2870+
}
2871+
},
2872+
"documentation": "<p>Provides information about the default server-side encryption settings for an S3 bucket. For detailed information about these settings, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-encryption.html\">Setting default server-side encryption behavior for Amazon S3 buckets</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>"
2873+
},
28532874
"BucketSortCriteria": {
28542875
"type": "structure",
28552876
"members": {
@@ -3325,7 +3346,7 @@
33253346
},
33263347
"Currency": {
33273348
"type": "string",
3328-
"documentation": "<p>The type of currency that data for a usage metric is reported in. Possible values are:</p>",
3349+
"documentation": "<p>The type of currency that the data for an Amazon Macie usage metric is reported in. Possible values are:</p>",
33293350
"enum": [
33303351
"USD"
33313352
]
@@ -4170,7 +4191,7 @@
41704191
"bucketCountByEncryptionType": {
41714192
"shape": "BucketCountByEncryptionType",
41724193
"locationName": "bucketCountByEncryptionType",
4173-
"documentation": "<p>The total number of buckets, grouped by server-side encryption type. This object also reports the total number of buckets that don't encrypt objects by default.</p>"
4194+
"documentation": "<p>The total number of buckets, grouped by default server-side encryption type. This object also reports the total number of buckets that don't encrypt new objects by default.</p>"
41744195
},
41754196
"bucketCountBySharedAccessType": {
41764197
"shape": "BucketCountBySharedAccessType",
@@ -4559,7 +4580,7 @@
45594580
"filterBy": {
45604581
"shape": "__listOfUsageStatisticsFilter",
45614582
"locationName": "filterBy",
4562-
"documentation": "<p>An array of objects, one for each condition to use to filter the query results. If the array contains more than one object, Amazon Macie uses an AND operator to join the conditions specified by the objects.</p>"
4583+
"documentation": "<p>An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.</p>"
45634584
},
45644585
"maxResults": {
45654586
"shape": "__integer",
@@ -4575,6 +4596,11 @@
45754596
"shape": "UsageStatisticsSortBy",
45764597
"locationName": "sortBy",
45774598
"documentation": "<p>The criteria to use to sort the query results.</p>"
4599+
},
4600+
"timeRange": {
4601+
"shape": "TimeRange",
4602+
"locationName": "timeRange",
4603+
"documentation": "<p>The inclusive time period to query usage 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, Amazon Macie provides usage data for the preceding 30 days.</p>"
45784604
}
45794605
}
45804606
},
@@ -4590,16 +4616,33 @@
45904616
"shape": "__listOfUsageRecord",
45914617
"locationName": "records",
45924618
"documentation": "<p>An array of objects that contains the results of the query. Each object contains the data for an account that meets the filter criteria specified in the request.</p>"
4619+
},
4620+
"timeRange": {
4621+
"shape": "TimeRange",
4622+
"locationName": "timeRange",
4623+
"documentation": "<p>The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.</p>"
45934624
}
45944625
}
45954626
},
45964627
"GetUsageTotalsRequest": {
45974628
"type": "structure",
4598-
"members": {}
4629+
"members": {
4630+
"timeRange": {
4631+
"shape": "__string",
4632+
"location": "querystring",
4633+
"locationName": "timeRange",
4634+
"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>"
4635+
}
4636+
}
45994637
},
46004638
"GetUsageTotalsResponse": {
46014639
"type": "structure",
46024640
"members": {
4641+
"timeRange": {
4642+
"shape": "TimeRange",
4643+
"locationName": "timeRange",
4644+
"documentation": "<p>The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.</p>"
4645+
},
46034646
"usageTotals": {
46044647
"shape": "__listOfUsageTotal",
46054648
"locationName": "usageTotals",
@@ -5428,17 +5471,17 @@
54285471
"customerManaged": {
54295472
"shape": "__long",
54305473
"locationName": "customerManaged",
5431-
"documentation": "<p>The total number of objects that are encrypted using a customer-managed key. The objects use customer-provided server-side (SSE-C) encryption.</p>"
5474+
"documentation": "<p>The total number of objects that are encrypted using a customer-managed key. The objects use customer-provided server-side encryption (SSE-C).</p>"
54325475
},
54335476
"kmsManaged": {
54345477
"shape": "__long",
54355478
"locationName": "kmsManaged",
5436-
"documentation": "<p>The total number of objects that are encrypted using an AWS Key Management Service (AWS KMS) customer master key (CMK). The objects use AWS managed AWS KMS (AWS-KMS) encryption or customer managed AWS KMS (SSE-KMS) encryption.</p>"
5479+
"documentation": "<p>The total number of objects that are encrypted using an AWS Key Management Service (AWS KMS) customer master key (CMK). The objects use AWS managed AWS KMS encryption (AWS-KMS) or customer managed AWS KMS encryption (SSE-KMS).</p>"
54375480
},
54385481
"s3Managed": {
54395482
"shape": "__long",
54405483
"locationName": "s3Managed",
5441-
"documentation": "<p>The total number of objects that are encrypted using an Amazon S3 managed key. The objects use Amazon S3 managed (SSE-S3) encryption.</p>"
5484+
"documentation": "<p>The total number of objects that are encrypted using an Amazon S3 managed key. The objects use Amazon S3 managed encryption (SSE-S3).</p>"
54425485
},
54435486
"unencrypted": {
54445487
"shape": "__long",
@@ -5978,7 +6021,7 @@
59786021
"documentation": "<p>The value for the metric specified by the UsageByAccount.type field in the response.</p>"
59796022
}
59806023
},
5981-
"documentation": "<p>Specifies a current quota for an account.</p>"
6024+
"documentation": "<p>Specifies a current quota for an Amazon Macie account.</p>"
59826025
},
59836026
"ServiceQuotaExceededException": {
59846027
"type": "structure",
@@ -6300,6 +6343,22 @@
63006343
"httpStatusCode": 429
63016344
}
63026345
},
6346+
"TimeRange": {
6347+
"type": "string",
6348+
"documentation": "<p>An inclusive time period that Amazon Macie usage data applies to. Possible values are:</p>",
6349+
"enum": [
6350+
"MONTH_TO_DATE",
6351+
"PAST_30_DAYS"
6352+
]
6353+
},
6354+
"Type": {
6355+
"type": "string",
6356+
"enum": [
6357+
"NONE",
6358+
"AES256",
6359+
"aws:kms"
6360+
]
6361+
},
63036362
"Unit": {
63046363
"type": "string",
63056364
"enum": [
@@ -6511,10 +6570,10 @@
65116570
"type": {
65126571
"shape": "UsageType",
65136572
"locationName": "type",
6514-
"documentation": "<p>The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing sensitive data.</p>"
6573+
"documentation": "<p>The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing S3 objects to detect sensitive data.</p>"
65156574
}
65166575
},
6517-
"documentation": "<p>Provides data for a specific usage metric and the corresponding quota for an account. The value for the metric is an aggregated value that reports usage during the past 30 days.</p>"
6576+
"documentation": "<p>Provides data for a specific usage metric and the corresponding quota for an Amazon Macie account.</p>"
65186577
},
65196578
"UsageRecord": {
65206579
"type": "structure",
@@ -6535,7 +6594,7 @@
65356594
"documentation": "<p>An array of objects that contains usage data and quotas for the account. Each object contains the data for a specific usage metric and the corresponding quota.</p>"
65366595
}
65376596
},
6538-
"documentation": "<p>Provides quota and aggregated usage data for an account.</p>"
6597+
"documentation": "<p>Provides quota and aggregated usage data for an Amazon Macie account.</p>"
65396598
},
65406599
"UsageStatisticsFilter": {
65416600
"type": "structure",
@@ -6556,11 +6615,11 @@
65566615
"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>"
65576616
}
65586617
},
6559-
"documentation": "<p>Specifies a condition for filtering the results of a query for account quotas and usage data.</p>"
6618+
"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>"
65606619
},
65616620
"UsageStatisticsFilterComparator": {
65626621
"type": "string",
6563-
"documentation": "<p>The operator to use in a condition that filters the results of a query for account quotas and usage data. Valid values are:</p>",
6622+
"documentation": "<p>The operator to use in a condition that filters the results of a query for Amazon Macie account quotas and usage data. Valid values are:</p>",
65646623
"enum": [
65656624
"GT",
65666625
"GTE",
@@ -6573,7 +6632,7 @@
65736632
},
65746633
"UsageStatisticsFilterKey": {
65756634
"type": "string",
6576-
"documentation": "<p>The field to use in a condition that filters the results of a query for account quotas and usage data. Valid values are:</p>",
6635+
"documentation": "<p>The field to use in a condition that filters the results of a query for Amazon Macie account quotas and usage data. Valid values are:</p>",
65776636
"enum": [
65786637
"accountId",
65796638
"serviceLimit",
@@ -6595,11 +6654,11 @@
65956654
"documentation": "<p>The sort order to apply to the results, based on the value for the field specified by the key property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.</p>"
65966655
}
65976656
},
6598-
"documentation": "<p>Specifies criteria for sorting the results of a query for account quotas and usage data.</p>"
6657+
"documentation": "<p>Specifies criteria for sorting the results of a query for Amazon Macie account quotas and usage data.</p>"
65996658
},
66006659
"UsageStatisticsSortKey": {
66016660
"type": "string",
6602-
"documentation": "<p>The field to use to sort the results of a query for account quotas and usage data. Valid values are:</p>",
6661+
"documentation": "<p>The field to use to sort the results of a query for Amazon Macie account quotas and usage data. Valid values are:</p>",
66036662
"enum": [
66046663
"accountId",
66056664
"total",
@@ -6623,14 +6682,14 @@
66236682
"type": {
66246683
"shape": "UsageType",
66256684
"locationName": "type",
6626-
"documentation": "<p>The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing sensitive data.</p>"
6685+
"documentation": "<p>The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing S3 objects to detect sensitive data.</p>"
66276686
}
66286687
},
6629-
"documentation": "<p>Provides aggregated data for a usage metric. The value for the metric reports usage data for an account during the past 30 days.</p>"
6688+
"documentation": "<p>Provides aggregated data for an Amazon Macie usage metric. The value for the metric reports estimated usage data for an account for the preceding 30 days or the current calendar month to date, depending on the time period (timeRange) specified in the request.</p>"
66306689
},
66316690
"UsageType": {
66326691
"type": "string",
6633-
"documentation": "<p>The name of a usage metric for an account. Possible values are:</p>",
6692+
"documentation": "<p>The name of an Amazon Macie usage metric for an account. Possible values are:</p>",
66346693
"enum": [
66356694
"DATA_INVENTORY_EVALUATION",
66366695
"SENSITIVE_DATA_DISCOVERY"

0 commit comments

Comments
 (0)