@aws-sdk/client-cloudtrail 3.36.0 → 3.36.1

package/dist-types/ts3.4/commands/PutEventSelectorsCommand.d.ts

@@ -6,73 +6,11 @@ export interface PutEventSelectorsCommandInput extends PutEventSelectorsRequest
 }
 export interface PutEventSelectorsCommandOutput extends PutEventSelectorsResponse, __MetadataBearer {
 }
-/**
- * <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. 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 advanced event selectors in all trails. For each trail, if the event matches
- *          any event selector, the trail processes and logs the event. If the event doesn't match any event
- *          selector, the trail doesn't log the event.</p>
- *          <p>Example</p>
- *          <ol>
- *             <li>
- *                <p>You create an event selector for a trail and specify that you want
- *                write-only events.</p>
- *             </li>
- *             <li>
- *                <p>The EC2 <code>GetConsoleOutput</code> and <code>RunInstances</code> API
- *                operations occur in your account.</p>
- *             </li>
- *             <li>
- *                <p>CloudTrail evaluates whether the events match your event
- *                selectors.</p>
- *             </li>
- *             <li>
- *                <p>The <code>RunInstances</code> is a write-only event and it matches your
- *                event selector. The trail logs the event.</p>
- *             </li>
- *             <li>
- *                <p>The <code>GetConsoleOutput</code> is a read-only event that doesn't
- *                match your event selector. The trail doesn't log the event.
- *          </p>
- *             </li>
- *          </ol>
- *          <p>The <code>PutEventSelectors</code> operation must be called from the region in which
- *          the trail was created; otherwise, an <code>InvalidHomeRegionException</code> exception is
- *          thrown.</p>
- *          <p>You can configure up to five event selectors for each trail. For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html">Logging data and management events for trails
- *       </a> and <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html">Quotas in CloudTrail</a>
- *          in the <i>CloudTrail User Guide</i>.</p>
- *          <p>You can add advanced event selectors, and conditions for your advanced
- *          event selectors, up to a maximum of 500 values for all conditions and selectors on a trail.
- *          You can use either <code>AdvancedEventSelectors</code> or <code>EventSelectors</code>, but not both. If you apply <code>AdvancedEventSelectors</code>
- *          to a trail, any existing <code>EventSelectors</code> are overwritten. For more information about
- *          advanced event selectors, see
- *          <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html">Logging
- *             data events for trails</a> in the <i>CloudTrail User Guide</i>.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CloudTrailClient, PutEventSelectorsCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import
- * // const { CloudTrailClient, PutEventSelectorsCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import
- * const client = new CloudTrailClient(config);
- * const command = new PutEventSelectorsCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link PutEventSelectorsCommandInput} for command's `input` shape.
- * @see {@link PutEventSelectorsCommandOutput} for command's `response` shape.
- * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class PutEventSelectorsCommand extends $Command<PutEventSelectorsCommandInput, PutEventSelectorsCommandOutput, CloudTrailClientResolvedConfig> {
     readonly input: PutEventSelectorsCommandInput;
     constructor(input: PutEventSelectorsCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudTrailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutEventSelectorsCommandInput, PutEventSelectorsCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/PutInsightSelectorsCommand.d.ts

@@ -6,32 +6,11 @@ export interface PutInsightSelectorsCommandInput extends PutInsightSelectorsRequ
 }
 export interface PutInsightSelectorsCommandOutput extends PutInsightSelectorsResponse, __MetadataBearer {
 }
-/**
- * <p>Lets you enable Insights event logging by specifying the Insights
- *          selectors that you want to enable on an existing trail. You also use
- *          <code>PutInsightSelectors</code> to turn off Insights event logging, by passing an empty list of insight types.
- *          The valid Insights event type in this release is <code>ApiCallRateInsight</code>.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CloudTrailClient, PutInsightSelectorsCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import
- * // const { CloudTrailClient, PutInsightSelectorsCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import
- * const client = new CloudTrailClient(config);
- * const command = new PutInsightSelectorsCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link PutInsightSelectorsCommandInput} for command's `input` shape.
- * @see {@link PutInsightSelectorsCommandOutput} for command's `response` shape.
- * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class PutInsightSelectorsCommand extends $Command<PutInsightSelectorsCommandInput, PutInsightSelectorsCommandOutput, CloudTrailClientResolvedConfig> {
     readonly input: PutInsightSelectorsCommandInput;
     constructor(input: PutInsightSelectorsCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudTrailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutInsightSelectorsCommandInput, PutInsightSelectorsCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/RemoveTagsCommand.d.ts

@@ -6,29 +6,11 @@ export interface RemoveTagsCommandInput extends RemoveTagsRequest {
 }
 export interface RemoveTagsCommandOutput extends RemoveTagsResponse, __MetadataBearer {
 }
-/**
- * <p>Removes the specified tags from a trail.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CloudTrailClient, RemoveTagsCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import
- * // const { CloudTrailClient, RemoveTagsCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import
- * const client = new CloudTrailClient(config);
- * const command = new RemoveTagsCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link RemoveTagsCommandInput} for command's `input` shape.
- * @see {@link RemoveTagsCommandOutput} for command's `response` shape.
- * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class RemoveTagsCommand extends $Command<RemoveTagsCommandInput, RemoveTagsCommandOutput, CloudTrailClientResolvedConfig> {
     readonly input: RemoveTagsCommandInput;
     constructor(input: RemoveTagsCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudTrailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RemoveTagsCommandInput, RemoveTagsCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/StartLoggingCommand.d.ts

@@ -6,29 +6,11 @@ export interface StartLoggingCommandInput extends StartLoggingRequest {
 }
 export interface StartLoggingCommandOutput extends StartLoggingResponse, __MetadataBearer {
 }
-/**
- * <p>Starts the recording of Amazon Web Services API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CloudTrailClient, StartLoggingCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import
- * // const { CloudTrailClient, StartLoggingCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import
- * const client = new CloudTrailClient(config);
- * const command = new StartLoggingCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link StartLoggingCommandInput} for command's `input` shape.
- * @see {@link StartLoggingCommandOutput} for command's `response` shape.
- * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class StartLoggingCommand extends $Command<StartLoggingCommandInput, StartLoggingCommandOutput, CloudTrailClientResolvedConfig> {
     readonly input: StartLoggingCommandInput;
     constructor(input: StartLoggingCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudTrailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartLoggingCommandInput, StartLoggingCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/StopLoggingCommand.d.ts

@@ -6,35 +6,11 @@ export interface StopLoggingCommandInput extends StopLoggingRequest {
 }
 export interface StopLoggingCommandOutput extends StopLoggingResponse, __MetadataBearer {
 }
-/**
- * <p>Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail.
- *          Under most circumstances, there is no need to use this action. You can update a trail
- *          without stopping it first. This action is the only way to stop recording. For a trail
- *          enabled in all regions, this operation must be called from the region in which the trail
- *          was created, or an <code>InvalidHomeRegionException</code> will occur. This operation
- *          cannot be called on the shadow trails (replicated trails in other regions) of a trail
- *          enabled in all regions.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CloudTrailClient, StopLoggingCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import
- * // const { CloudTrailClient, StopLoggingCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import
- * const client = new CloudTrailClient(config);
- * const command = new StopLoggingCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link StopLoggingCommandInput} for command's `input` shape.
- * @see {@link StopLoggingCommandOutput} for command's `response` shape.
- * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class StopLoggingCommand extends $Command<StopLoggingCommandInput, StopLoggingCommandOutput, CloudTrailClientResolvedConfig> {
     readonly input: StopLoggingCommandInput;
     constructor(input: StopLoggingCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudTrailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopLoggingCommandInput, StopLoggingCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/UpdateTrailCommand.d.ts

@@ -6,34 +6,11 @@ export interface UpdateTrailCommandInput extends UpdateTrailRequest {
 }
 export interface UpdateTrailCommandOutput extends UpdateTrailResponse, __MetadataBearer {
 }
-/**
- * <p>Updates trail settings that control what events you are logging, and how to handle log files. Changes to a trail do not require
- *          stopping the CloudTrail service. Use this action to designate an existing bucket for log
- *          delivery. If the existing bucket has previously been a target for CloudTrail log files,
- *          an IAM policy exists for the bucket. <code>UpdateTrail</code> must be called from the
- *          region in which the trail was created; otherwise, an
- *             <code>InvalidHomeRegionException</code> is thrown.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CloudTrailClient, UpdateTrailCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import
- * // const { CloudTrailClient, UpdateTrailCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import
- * const client = new CloudTrailClient(config);
- * const command = new UpdateTrailCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link UpdateTrailCommandInput} for command's `input` shape.
- * @see {@link UpdateTrailCommandOutput} for command's `response` shape.
- * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class UpdateTrailCommand extends $Command<UpdateTrailCommandInput, UpdateTrailCommandOutput, CloudTrailClientResolvedConfig> {
     readonly input: UpdateTrailCommandInput;
     constructor(input: UpdateTrailCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudTrailClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateTrailCommandInput, UpdateTrailCommandOutput>;
     private serialize;
     private deserialize;