Skip to content

Commit 88273ba

Browse files
author
awstools
committedMay 30, 2024
feat(client-cloudtrail): CloudTrail Lake returns PartitionKeys in the GetEventDataStore API response. Events are grouped into partitions based on these keys for better query performance. For example, the calendarday key groups events by day, while combining the calendarday key with the hour key groups them by day and hour.
1 parent 393afc7 commit 88273ba

24 files changed

+241
-82
lines changed
 

‎clients/client-cloudtrail/src/commands/AddTagsCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ export interface AddTagsCommandOutput extends AddTagsResponse, __MetadataBearer
129129
* @throws {@link NotOrganizationMasterAccountException} (client fault)
130130
* <p>This exception is thrown when the Amazon Web Services account making the request to
131131
* create or update an organization trail or event data store is not the management account
132-
* 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>
132+
* 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/cloudtrail-lake-organizations.html">Organization event data stores</a>.</p>
133133
*
134134
* @throws {@link OperationNotPermittedException} (client fault)
135135
* <p>This exception is thrown when the requested operation is not permitted.</p>

‎clients/client-cloudtrail/src/commands/CreateEventDataStoreCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ export interface CreateEventDataStoreCommandOutput extends CreateEventDataStoreR
133133
* @see {@link CloudTrailClientResolvedConfig | config} for CloudTrailClient's `config` shape.
134134
*
135135
* @throws {@link CloudTrailAccessNotEnabledException} (client fault)
136-
* <p>This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html">Enabling Trusted Access with Other Amazon Web Services Services</a> and <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>
136+
* <p>This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_how-to-enable-disable-trusted-access">How to enable or disable trusted access</a> in the <i>Organizations User Guide</i> and <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> in the <i>CloudTrail User Guide</i>.</p>
137137
*
138138
* @throws {@link ConflictException} (client fault)
139139
* <p>This exception is thrown when the specified resource is not ready for an operation. This
@@ -212,7 +212,7 @@ export interface CreateEventDataStoreCommandOutput extends CreateEventDataStoreR
212212
* @throws {@link NotOrganizationMasterAccountException} (client fault)
213213
* <p>This exception is thrown when the Amazon Web Services account making the request to
214214
* create or update an organization trail or event data store is not the management account
215-
* 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>
215+
* 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/cloudtrail-lake-organizations.html">Organization event data stores</a>.</p>
216216
*
217217
* @throws {@link OperationNotPermittedException} (client fault)
218218
* <p>This exception is thrown when the requested operation is not permitted.</p>

‎clients/client-cloudtrail/src/commands/CreateTrailCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ export interface CreateTrailCommandOutput extends CreateTrailResponse, __Metadat
8181
* @see {@link CloudTrailClientResolvedConfig | config} for CloudTrailClient's `config` shape.
8282
*
8383
* @throws {@link CloudTrailAccessNotEnabledException} (client fault)
84-
* <p>This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html">Enabling Trusted Access with Other Amazon Web Services Services</a> and <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>
84+
* <p>This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_how-to-enable-disable-trusted-access">How to enable or disable trusted access</a> in the <i>Organizations User Guide</i> and <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> in the <i>CloudTrail User Guide</i>.</p>
8585
*
8686
* @throws {@link CloudTrailInvalidClientTokenIdException} (client fault)
8787
* <p>This exception is thrown when a call results in the <code>InvalidClientTokenId</code>
@@ -188,7 +188,7 @@ export interface CreateTrailCommandOutput extends CreateTrailResponse, __Metadat
188188
* @throws {@link NotOrganizationMasterAccountException} (client fault)
189189
* <p>This exception is thrown when the Amazon Web Services account making the request to
190190
* create or update an organization trail or event data store is not the management account
191-
* 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>
191+
* 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/cloudtrail-lake-organizations.html">Organization event data stores</a>.</p>
192192
*
193193
* @throws {@link OperationNotPermittedException} (client fault)
194194
* <p>This exception is thrown when the requested operation is not permitted.</p>

‎clients/client-cloudtrail/src/commands/DeleteEventDataStoreCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ export interface DeleteEventDataStoreCommandOutput extends DeleteEventDataStoreR
108108
* @throws {@link NotOrganizationMasterAccountException} (client fault)
109109
* <p>This exception is thrown when the Amazon Web Services account making the request to
110110
* create or update an organization trail or event data store is not the management account
111-
* 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>
111+
* 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/cloudtrail-lake-organizations.html">Organization event data stores</a>.</p>
112112
*
113113
* @throws {@link OperationNotPermittedException} (client fault)
114114
* <p>This exception is thrown when the requested operation is not permitted.</p>

‎clients/client-cloudtrail/src/commands/DeleteTrailCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ export interface DeleteTrailCommandOutput extends DeleteTrailResponse, __Metadat
107107
* @throws {@link NotOrganizationMasterAccountException} (client fault)
108108
* <p>This exception is thrown when the Amazon Web Services account making the request to
109109
* create or update an organization trail or event data store is not the management account
110-
* 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>
110+
* 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/cloudtrail-lake-organizations.html">Organization event data stores</a>.</p>
111111
*
112112
* @throws {@link OperationNotPermittedException} (client fault)
113113
* <p>This exception is thrown when the requested operation is not permitted.</p>

‎clients/client-cloudtrail/src/commands/DeregisterOrganizationDelegatedAdminCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ export interface DeregisterOrganizationDelegatedAdminCommandOutput
6666
* <p>This exception is thrown when the specified account is not registered as the CloudTrail delegated administrator.</p>
6767
*
6868
* @throws {@link CloudTrailAccessNotEnabledException} (client fault)
69-
* <p>This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html">Enabling Trusted Access with Other Amazon Web Services Services</a> and <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>
69+
* <p>This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_how-to-enable-disable-trusted-access">How to enable or disable trusted access</a> in the <i>Organizations User Guide</i> and <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> in the <i>CloudTrail User Guide</i>.</p>
7070
*
7171
* @throws {@link ConflictException} (client fault)
7272
* <p>This exception is thrown when the specified resource is not ready for an operation. This

‎clients/client-cloudtrail/src/commands/DisableFederationCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ export interface DisableFederationCommandOutput extends DisableFederationRespons
6262
* </p>
6363
*
6464
* @throws {@link CloudTrailAccessNotEnabledException} (client fault)
65-
* <p>This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html">Enabling Trusted Access with Other Amazon Web Services Services</a> and <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>
65+
* <p>This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_how-to-enable-disable-trusted-access">How to enable or disable trusted access</a> in the <i>Organizations User Guide</i> and <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> in the <i>CloudTrail User Guide</i>.</p>
6666
*
6767
* @throws {@link ConcurrentModificationException} (client fault)
6868
* <p>
@@ -94,7 +94,7 @@ export interface DisableFederationCommandOutput extends DisableFederationRespons
9494
* @throws {@link NotOrganizationMasterAccountException} (client fault)
9595
* <p>This exception is thrown when the Amazon Web Services account making the request to
9696
* create or update an organization trail or event data store is not the management account
97-
* 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>
97+
* 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/cloudtrail-lake-organizations.html">Organization event data stores</a>.</p>
9898
*
9999
* @throws {@link OperationNotPermittedException} (client fault)
100100
* <p>This exception is thrown when the requested operation is not permitted.</p>

‎clients/client-cloudtrail/src/commands/EnableFederationCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ export interface EnableFederationCommandOutput extends EnableFederationResponse,
7070
* </p>
7171
*
7272
* @throws {@link CloudTrailAccessNotEnabledException} (client fault)
73-
* <p>This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html">Enabling Trusted Access with Other Amazon Web Services Services</a> and <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>
73+
* <p>This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_how-to-enable-disable-trusted-access">How to enable or disable trusted access</a> in the <i>Organizations User Guide</i> and <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> in the <i>CloudTrail User Guide</i>.</p>
7474
*
7575
* @throws {@link ConcurrentModificationException} (client fault)
7676
* <p>
@@ -108,7 +108,7 @@ export interface EnableFederationCommandOutput extends EnableFederationResponse,
108108
* @throws {@link NotOrganizationMasterAccountException} (client fault)
109109
* <p>This exception is thrown when the Amazon Web Services account making the request to
110110
* create or update an organization trail or event data store is not the management account
111-
* 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>
111+
* 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/cloudtrail-lake-organizations.html">Organization event data stores</a>.</p>
112112
*
113113
* @throws {@link OperationNotPermittedException} (client fault)
114114
* <p>This exception is thrown when the requested operation is not permitted.</p>

‎clients/client-cloudtrail/src/commands/GetEventDataStoreCommand.ts

+6
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,12 @@ export interface GetEventDataStoreCommandOutput extends GetEventDataStoreRespons
8080
* // BillingMode: "EXTENDABLE_RETENTION_PRICING" || "FIXED_RETENTION_PRICING",
8181
* // FederationStatus: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED",
8282
* // FederationRoleArn: "STRING_VALUE",
83+
* // PartitionKeys: [ // PartitionKeyList
84+
* // { // PartitionKey
85+
* // Name: "STRING_VALUE", // required
86+
* // Type: "STRING_VALUE", // required
87+
* // },
88+
* // ],
8389
* // };
8490
*
8591
* ```

‎clients/client-cloudtrail/src/commands/PutEventSelectorsCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface PutEventSelectorsCommandOutput extends PutEventSelectorsRespons
3030
* <p>Configures an event selector or advanced event selectors for your trail. Use event
3131
* selectors or advanced event selectors to specify management and data event settings for
3232
* your trail. If you want your trail to log Insights events, be sure the event selector
33-
* enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html">Logging Insights events for trails</a> in the <i>CloudTrail User Guide</i>.
33+
* enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html">Logging Insights events</a> in the <i>CloudTrail User Guide</i>.
3434
* By default, trails created without specific event selectors are configured to
3535
* log all read and write management events, and no data events.</p>
3636
* <p>When an event occurs in your account, CloudTrail evaluates the event selectors or
@@ -267,7 +267,7 @@ export interface PutEventSelectorsCommandOutput extends PutEventSelectorsRespons
267267
* @throws {@link NotOrganizationMasterAccountException} (client fault)
268268
* <p>This exception is thrown when the Amazon Web Services account making the request to
269269
* create or update an organization trail or event data store is not the management account
270-
* 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>
270+
* 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/cloudtrail-lake-organizations.html">Organization event data stores</a>.</p>
271271
*
272272
* @throws {@link OperationNotPermittedException} (client fault)
273273
* <p>This exception is thrown when the requested operation is not permitted.</p>

0 commit comments

Comments
 (0)
Please sign in to comment.