Skip to content

Commit

Permalink
feat(client-cloudtrail): CloudTrail Lake returns PartitionKeys in the…
Browse files Browse the repository at this point in the history 
… 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.
  • Loading branch information
awstools committed May 30, 2024
1 parent 393afc7 commit 88273ba
Show file tree
Hide file tree
Showing 24 changed files with 241 additions and 82 deletions.
2 changes: 1 addition & 1 deletion clients/client-cloudtrail/src/commands/AddTagsCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ export interface AddTagsCommandOutput extends AddTagsResponse, __MetadataBearer
* @throws {@link NotOrganizationMasterAccountException} (client fault)
* <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>
* 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>
*
* @throws {@link OperationNotPermittedException} (client fault)
* <p>This exception is thrown when the requested operation is not permitted.</p>
Expand Down
4 changes: 2 additions & 2 deletions clients/client-cloudtrail/src/commands/CreateEventDataStoreCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ export interface CreateEventDataStoreCommandOutput extends CreateEventDataStoreR
* @see {@link CloudTrailClientResolvedConfig | config} for CloudTrailClient's `config` shape.
*
* @throws {@link CloudTrailAccessNotEnabledException} (client fault)
* <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>
* <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>
*
* @throws {@link ConflictException} (client fault)
* <p>This exception is thrown when the specified resource is not ready for an operation. This
Expand Down Expand Up @@ -212,7 +212,7 @@ export interface CreateEventDataStoreCommandOutput extends CreateEventDataStoreR
* @throws {@link NotOrganizationMasterAccountException} (client fault)
* <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>
* 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>
*
* @throws {@link OperationNotPermittedException} (client fault)
* <p>This exception is thrown when the requested operation is not permitted.</p>
Expand Down
4 changes: 2 additions & 2 deletions clients/client-cloudtrail/src/commands/CreateTrailCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ export interface CreateTrailCommandOutput extends CreateTrailResponse, __Metadat
* @see {@link CloudTrailClientResolvedConfig | config} for CloudTrailClient's `config` shape.
*
* @throws {@link CloudTrailAccessNotEnabledException} (client fault)
* <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>
* <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>
*
* @throws {@link CloudTrailInvalidClientTokenIdException} (client fault)
* <p>This exception is thrown when a call results in the <code>InvalidClientTokenId</code>
Expand Down Expand Up @@ -188,7 +188,7 @@ export interface CreateTrailCommandOutput extends CreateTrailResponse, __Metadat
* @throws {@link NotOrganizationMasterAccountException} (client fault)
* <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>
* 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>
*
* @throws {@link OperationNotPermittedException} (client fault)
* <p>This exception is thrown when the requested operation is not permitted.</p>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-cloudtrail/src/commands/DeleteEventDataStoreCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ export interface DeleteEventDataStoreCommandOutput extends DeleteEventDataStoreR
* @throws {@link NotOrganizationMasterAccountException} (client fault)
* <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>
* 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>
*
* @throws {@link OperationNotPermittedException} (client fault)
* <p>This exception is thrown when the requested operation is not permitted.</p>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-cloudtrail/src/commands/DeleteTrailCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ export interface DeleteTrailCommandOutput extends DeleteTrailResponse, __Metadat
* @throws {@link NotOrganizationMasterAccountException} (client fault)
* <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>
* 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>
*
* @throws {@link OperationNotPermittedException} (client fault)
* <p>This exception is thrown when the requested operation is not permitted.</p>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-cloudtrail/src/commands/DeregisterOrganizationDelegatedAdminCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export interface DeregisterOrganizationDelegatedAdminCommandOutput
* <p>This exception is thrown when the specified account is not registered as the CloudTrail delegated administrator.</p>
*
* @throws {@link CloudTrailAccessNotEnabledException} (client fault)
* <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>
* <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>
*
* @throws {@link ConflictException} (client fault)
* <p>This exception is thrown when the specified resource is not ready for an operation. This
Expand Down
4 changes: 2 additions & 2 deletions clients/client-cloudtrail/src/commands/DisableFederationCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ export interface DisableFederationCommandOutput extends DisableFederationRespons
* </p>
*
* @throws {@link CloudTrailAccessNotEnabledException} (client fault)
* <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>
* <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>
*
* @throws {@link ConcurrentModificationException} (client fault)
* <p>
Expand Down Expand Up @@ -94,7 +94,7 @@ export interface DisableFederationCommandOutput extends DisableFederationRespons
* @throws {@link NotOrganizationMasterAccountException} (client fault)
* <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>
* 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>
*
* @throws {@link OperationNotPermittedException} (client fault)
* <p>This exception is thrown when the requested operation is not permitted.</p>
Expand Down
4 changes: 2 additions & 2 deletions clients/client-cloudtrail/src/commands/EnableFederationCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ export interface EnableFederationCommandOutput extends EnableFederationResponse,
* </p>
*
* @throws {@link CloudTrailAccessNotEnabledException} (client fault)
* <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>
* <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>
*
* @throws {@link ConcurrentModificationException} (client fault)
* <p>
Expand Down Expand Up @@ -108,7 +108,7 @@ export interface EnableFederationCommandOutput extends EnableFederationResponse,
* @throws {@link NotOrganizationMasterAccountException} (client fault)
* <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>
* 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>
*
* @throws {@link OperationNotPermittedException} (client fault)
* <p>This exception is thrown when the requested operation is not permitted.</p>
Expand Down
6 changes: 6 additions & 0 deletions clients/client-cloudtrail/src/commands/GetEventDataStoreCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,12 @@ export interface GetEventDataStoreCommandOutput extends GetEventDataStoreRespons
* // BillingMode: "EXTENDABLE_RETENTION_PRICING" || "FIXED_RETENTION_PRICING",
* // FederationStatus: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED",
* // FederationRoleArn: "STRING_VALUE",
* // PartitionKeys: [ // PartitionKeyList
* // { // PartitionKey
* // Name: "STRING_VALUE", // required
* // Type: "STRING_VALUE", // required
* // },
* // ],
* // };
*
* ```
Expand Down
4 changes: 2 additions & 2 deletions clients/client-cloudtrail/src/commands/PutEventSelectorsCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export interface PutEventSelectorsCommandOutput extends PutEventSelectorsRespons
* <p>Configures an event selector or advanced event selectors for your trail. Use event
* selectors or advanced event selectors to specify management and data event settings for
* your trail. If you want your trail to log Insights events, be sure the event selector
* 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>.
* 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>.
* By default, trails created without specific event selectors are configured to
* log all read and write management events, and no data events.</p>
* <p>When an event occurs in your account, CloudTrail evaluates the event selectors or
Expand Down Expand Up @@ -267,7 +267,7 @@ export interface PutEventSelectorsCommandOutput extends PutEventSelectorsRespons
* @throws {@link NotOrganizationMasterAccountException} (client fault)
* <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>
* 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>
*
* @throws {@link OperationNotPermittedException} (client fault)
* <p>This exception is thrown when the requested operation is not permitted.</p>
Expand Down
Loading

0 comments on commit 88273ba

Please sign in to comment.