Skip to content

Commit fbc5f2c

Browse files
author
AWS
committed
AWS CloudTrail Update: Increases the retention period maximum to 2557 days. Deprecates unused fields of the ListEventDataStores API response. Updates documentation.
1 parent 5724210 commit fbc5f2c

File tree

2 files changed

+46
-24
lines changed

2 files changed

+46
-24
lines changed

‎.changes/next-release/feature-AWSCloudTrail-778aef3.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": "AWS CloudTrail",
4+
"contributor": "",
5+
"description": "Increases the retention period maximum to 2557 days. Deprecates unused fields of the ListEventDataStores API response. Updates documentation."
6+
}

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

Lines changed: 40 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
{"shape":"NotOrganizationMasterAccountException"},
3636
{"shape":"ConflictException"}
3737
],
38-
"documentation":"<p>Adds one or more tags to a trail, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all Amazon Web Services Regions only from the Region in which the trail was created (also known as its home region).</p>",
38+
"documentation":"<p>Adds one or more tags to a trail or event data store, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail or event data store that applies to all Amazon Web Services Regions only from the Region in which the trail or event data store was created (also known as its home region).</p>",
3939
"idempotent":true
4040
},
4141
"CancelQuery":{
@@ -387,7 +387,7 @@
387387
{"shape":"OperationNotPermittedException"},
388388
{"shape":"InvalidTokenException"}
389389
],
390-
"documentation":"<p>Lists the tags for the trail in the current region.</p>",
390+
"documentation":"<p>Lists the tags for the trail or event data store in the current region.</p>",
391391
"idempotent":true
392392
},
393393
"ListTrails":{
@@ -490,7 +490,7 @@
490490
{"shape":"OperationNotPermittedException"},
491491
{"shape":"NotOrganizationMasterAccountException"}
492492
],
493-
"documentation":"<p>Removes the specified tags from a trail.</p>",
493+
"documentation":"<p>Removes the specified tags from a trail or event data store.</p>",
494494
"idempotent":true
495495
},
496496
"RestoreEventDataStore":{
@@ -654,14 +654,14 @@
654654
"members":{
655655
"ResourceId":{
656656
"shape":"String",
657-
"documentation":"<p>Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is:</p> <p> <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code> </p>"
657+
"documentation":"<p>Specifies the ARN of the trail or event data store to which one or more tags will be added. The format of a trail ARN is:</p> <p> <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code> </p>"
658658
},
659659
"TagsList":{
660660
"shape":"TagsList",
661661
"documentation":"<p>Contains a list of tags, up to a limit of 50</p>"
662662
}
663663
},
664-
"documentation":"<p>Specifies the tags to add to a trail.</p>"
664+
"documentation":"<p>Specifies the tags to add to a trail or event data store.</p>"
665665
},
666666
"AddTagsResponse":{
667667
"type":"structure",
@@ -796,7 +796,7 @@
796796
"type":"structure",
797797
"members":{
798798
},
799-
"documentation":"<p>This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a trail before CloudTrail has time to fully load the trail. If this exception occurs, wait a few minutes, and then try the operation again.</p>",
799+
"documentation":"<p>This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource. If this exception occurs, wait a few minutes, and then try the operation again.</p>",
800800
"exception":true
801801
},
802802
"CreateEventDataStoreRequest":{
@@ -1176,35 +1176,51 @@
11761176
},
11771177
"TerminationProtectionEnabled":{
11781178
"shape":"TerminationProtectionEnabled",
1179-
"documentation":"<p>Indicates whether the event data store is protected from termination.</p>"
1179+
"documentation":"<p>This field is being deprecated. Indicates whether the event data store is protected from termination.</p>",
1180+
"deprecated":true,
1181+
"deprecatedMessage":"TerminationProtectionEnabled is no longer returned by ListEventDataStores"
11801182
},
11811183
"Status":{
11821184
"shape":"EventDataStoreStatus",
1183-
"documentation":"<p>The status of an event data store. Values are <code>ENABLED</code> and <code>PENDING_DELETION</code>.</p>"
1185+
"documentation":"<p>This field is being deprecated. The status of an event data store. Values are <code>ENABLED</code> and <code>PENDING_DELETION</code>.</p>",
1186+
"deprecated":true,
1187+
"deprecatedMessage":"Status is no longer returned by ListEventDataStores"
11841188
},
11851189
"AdvancedEventSelectors":{
11861190
"shape":"AdvancedEventSelectors",
1187-
"documentation":"<p>The advanced event selectors that were used to select events for the data store.</p>"
1191+
"documentation":"<p>This field is being deprecated. The advanced event selectors that were used to select events for the data store.</p>",
1192+
"deprecated":true,
1193+
"deprecatedMessage":"AdvancedEventSelectors is no longer returned by ListEventDataStores"
11881194
},
11891195
"MultiRegionEnabled":{
11901196
"shape":"Boolean",
1191-
"documentation":"<p>Indicates whether the event data store includes events from all regions, or only from the region in which it was created.</p>"
1197+
"documentation":"<p>This field is being deprecated. Indicates whether the event data store includes events from all regions, or only from the region in which it was created.</p>",
1198+
"deprecated":true,
1199+
"deprecatedMessage":"MultiRegionEnabled is no longer returned by ListEventDataStores"
11921200
},
11931201
"OrganizationEnabled":{
11941202
"shape":"Boolean",
1195-
"documentation":"<p>Indicates that an event data store is collecting logged events for an organization.</p>"
1203+
"documentation":"<p>This field is being deprecated. Indicates that an event data store is collecting logged events for an organization.</p>",
1204+
"deprecated":true,
1205+
"deprecatedMessage":"OrganizationEnabled is no longer returned by ListEventDataStores"
11961206
},
11971207
"RetentionPeriod":{
11981208
"shape":"RetentionPeriod",
1199-
"documentation":"<p>The retention period, in days.</p>"
1209+
"documentation":"<p>This field is being deprecated. The retention period, in days.</p>",
1210+
"deprecated":true,
1211+
"deprecatedMessage":"RetentionPeriod is no longer returned by ListEventDataStores"
12001212
},
12011213
"CreatedTimestamp":{
12021214
"shape":"Date",
1203-
"documentation":"<p>The timestamp of the event data store's creation.</p>"
1215+
"documentation":"<p>This field is being deprecated. The timestamp of the event data store's creation.</p>",
1216+
"deprecated":true,
1217+
"deprecatedMessage":"CreatedTimestamp is no longer returned by ListEventDataStores"
12041218
},
12051219
"UpdatedTimestamp":{
12061220
"shape":"Date",
1207-
"documentation":"<p>The timestamp showing when an event data store was updated, if applicable. <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in <code>CreatedTimestamp</code>.</p>"
1221+
"documentation":"<p>This field is being deprecated. The timestamp showing when an event data store was updated, if applicable. <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in <code>CreatedTimestamp</code>.</p>",
1222+
"deprecated":true,
1223+
"deprecatedMessage":"UpdatedTimestamp is no longer returned by ListEventDataStores"
12081224
}
12091225
},
12101226
"documentation":"<p>A storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 90 to 2555 days (about three months to up to seven years). To select events for an event data store, use <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced\">advanced event selectors</a>.</p>"
@@ -1562,7 +1578,7 @@
15621578
"type":"structure",
15631579
"members":{
15641580
},
1565-
"documentation":"<p>The event data store against which you ran your query is inactive.</p>",
1581+
"documentation":"<p>The event data store is inactive.</p>",
15661582
"exception":true
15671583
},
15681584
"InactiveQueryException":{
@@ -1604,7 +1620,7 @@
16041620
"type":"structure",
16051621
"members":{
16061622
},
1607-
"documentation":"<p>This exception is thrown when the IAM user or role that is used to create the organization trail is lacking one or more required permissions for creating an organization trail in a required service. For more information, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html\">Prepare For Creating a Trail For Your Organization</a>.</p>",
1623+
"documentation":"<p>This exception is thrown when the IAM user or role that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.</p>",
16081624
"exception":true
16091625
},
16101626
"InsufficientEncryptionPolicyException":{
@@ -1647,7 +1663,7 @@
16471663
"type":"structure",
16481664
"members":{
16491665
},
1650-
"documentation":"<p>A date range for the query was specified that is not valid. For more information about writing a query, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html\">Create or edit a query</a> in the <i>CloudTrail User Guide</i>.</p>",
1666+
"documentation":"<p>A date range for the query was specified that is not valid. Be sure that the start time is chronologically before the end time. For more information about writing a query, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html\">Create or edit a query</a> in the <i>CloudTrail User Guide</i>.</p>",
16511667
"exception":true
16521668
},
16531669
"InvalidEventCategoryException":{
@@ -1929,14 +1945,14 @@
19291945
"members":{
19301946
"ResourceIdList":{
19311947
"shape":"ResourceIdList",
1932-
"documentation":"<p>Specifies a list of trail ARNs whose tags will be listed. The list has a limit of 20 ARNs. The following is the format of a trail ARN.</p> <p> <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code> </p>"
1948+
"documentation":"<p>Specifies a list of trail and event data store ARNs whose tags will be listed. The list has a limit of 20 ARNs.</p>"
19331949
},
19341950
"NextToken":{
19351951
"shape":"String",
19361952
"documentation":"<p>Reserved for future use.</p>"
19371953
}
19381954
},
1939-
"documentation":"<p>Specifies a list of trail tags to return.</p>"
1955+
"documentation":"<p>Specifies a list of tags to return.</p>"
19401956
},
19411957
"ListTagsResponse":{
19421958
"type":"structure",
@@ -2083,7 +2099,7 @@
20832099
"type":"structure",
20842100
"members":{
20852101
},
2086-
"documentation":"<p>This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail is not the management account for an organization in Organizations. For more information, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html\">Prepare For Creating a Trail For Your Organization</a>.</p>",
2102+
"documentation":"<p>This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html\">Prepare For Creating a Trail For Your Organization</a> or <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html\">Create an event data store</a>.</p>",
20872103
"exception":true
20882104
},
20892105
"OperationNotPermittedException":{
@@ -2108,7 +2124,7 @@
21082124
"type":"structure",
21092125
"members":{
21102126
},
2111-
"documentation":"<p>This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail. For more information, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html\">Prepare For Creating a Trail For Your Organization</a>.</p>",
2127+
"documentation":"<p>This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.</p>",
21122128
"exception":true
21132129
},
21142130
"OrganizationsNotInUseException":{
@@ -2337,14 +2353,14 @@
23372353
"members":{
23382354
"ResourceId":{
23392355
"shape":"String",
2340-
"documentation":"<p>Specifies the ARN of the trail from which tags should be removed. The format of a trail ARN is:</p> <p> <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code> </p>"
2356+
"documentation":"<p>Specifies the ARN of the trail or event data store from which tags should be removed.</p> <p> Example trail ARN format: <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code> </p> <p>Example event data store ARN format: <code>arn:aws:cloudtrail:us-east-2:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code> </p>"
23412357
},
23422358
"TagsList":{
23432359
"shape":"TagsList",
23442360
"documentation":"<p>Specifies a list of tags to be removed.</p>"
23452361
}
23462362
},
2347-
"documentation":"<p>Specifies the tags to remove from a trail.</p>"
2363+
"documentation":"<p>Specifies the tags to remove from a trail or event data store.</p>"
23482364
},
23492365
"RemoveTagsResponse":{
23502366
"type":"structure",
@@ -2464,7 +2480,7 @@
24642480
},
24652481
"RetentionPeriod":{
24662482
"type":"integer",
2467-
"max":2555,
2483+
"max":2557,
24682484
"min":7
24692485
},
24702486
"S3BucketDoesNotExistException":{

0 commit comments

Comments
 (0)