@aws-sdk/client-guardduty 3.1123.0 → 3.1124.0

package/dist-types/commands/ListCustomDetectionRulesCommand.d.ts

@@ -0,0 +1,107 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ListCustomDetectionRulesRequest, ListCustomDetectionRulesResponse } from "../models/models_1";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link ListCustomDetectionRulesCommand}.
+ */
+export interface ListCustomDetectionRulesCommandInput extends ListCustomDetectionRulesRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListCustomDetectionRulesCommand}.
+ */
+export interface ListCustomDetectionRulesCommandOutput extends ListCustomDetectionRulesResponse, __MetadataBearer {
+}
+declare const ListCustomDetectionRulesCommand_base: {
+    new (input: ListCustomDetectionRulesCommandInput): import("@smithy/core/client").CommandImpl<ListCustomDetectionRulesCommandInput, ListCustomDetectionRulesCommandOutput, import("..").GuardDutyClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (...[input]: [] | [ListCustomDetectionRulesCommandInput]): import("@smithy/core/client").CommandImpl<ListCustomDetectionRulesCommandInput, ListCustomDetectionRulesCommandOutput, import("..").GuardDutyClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns all available custom detection rules in GuardDuty. You can filter the results by data source, severity, tactic, technique, and service.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { GuardDutyClient, ListCustomDetectionRulesCommand } from "@aws-sdk/client-guardduty"; // ES Modules import
+ * // const { GuardDutyClient, ListCustomDetectionRulesCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import
+ * // import type { GuardDutyClientConfig } from "@aws-sdk/client-guardduty";
+ * const config = {}; // type is GuardDutyClientConfig
+ * const client = new GuardDutyClient(config);
+ * const input = { // ListCustomDetectionRulesRequest
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ *   Filters: [ // DetectionRuleFilterList
+ *     { // DetectionRuleFilter
+ *       Name: "name" || "description" || "dataSource" || "severity" || "tactic" || "technique" || "service", // required
+ *       Values: [ // DetectionRuleFilterValues // required
+ *         "STRING_VALUE",
+ *       ],
+ *       Condition: "EQUALS" || "CONTAINS",
+ *     },
+ *   ],
+ * };
+ * const command = new ListCustomDetectionRulesCommand(input);
+ * const response = await client.send(command);
+ * // { // ListCustomDetectionRulesResponse
+ * //   Rules: [ // RuleSummaryList // required
+ * //     { // RuleSummary
+ * //       RuleId: "STRING_VALUE", // required
+ * //       Arn: "STRING_VALUE", // required
+ * //       Name: "STRING_VALUE", // required
+ * //       Description: "STRING_VALUE", // required
+ * //       Severity: "CRITICAL" || "HIGH" || "MEDIUM" || "LOW", // required
+ * //       DataSource: "CloudTrailManagementEvent", // required
+ * //       Tactic: "STRING_VALUE", // required
+ * //       Technique: "STRING_VALUE", // required
+ * //       Service: "STRING_VALUE", // required
+ * //       Language: "SQL",
+ * //       Schema: "CloudTrail",
+ * //       CreatedAt: new Date("TIMESTAMP"), // required
+ * //       UpdatedAt: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListCustomDetectionRulesCommandInput - {@link ListCustomDetectionRulesCommandInput}
+ * @returns {@link ListCustomDetectionRulesCommandOutput}
+ * @see {@link ListCustomDetectionRulesCommandInput} for command's `input` shape.
+ * @see {@link ListCustomDetectionRulesCommandOutput} for command's `response` shape.
+ * @see {@link GuardDutyClientResolvedConfig | config} for GuardDutyClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>An access denied exception object.</p>
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>A bad request exception object.</p>
+ *
+ * @throws {@link InternalServerErrorException} (server fault)
+ *  <p>An internal server error exception object.</p>
+ *
+ * @throws {@link GuardDutyServiceException}
+ * <p>Base exception class for all service exceptions from GuardDuty service.</p>
+ *
+ *
+ * @public
+ */
+export declare class ListCustomDetectionRulesCommand extends ListCustomDetectionRulesCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListCustomDetectionRulesRequest;
+            output: ListCustomDetectionRulesResponse;
+        };
+        sdk: {
+            input: ListCustomDetectionRulesCommandInput;
+            output: ListCustomDetectionRulesCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateCustomDetectionRuleAssociationCommand.d.ts

@@ -0,0 +1,86 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UpdateCustomDetectionRuleAssociationRequest, UpdateCustomDetectionRuleAssociationResponse } from "../models/models_1";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link UpdateCustomDetectionRuleAssociationCommand}.
+ */
+export interface UpdateCustomDetectionRuleAssociationCommandInput extends UpdateCustomDetectionRuleAssociationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateCustomDetectionRuleAssociationCommand}.
+ */
+export interface UpdateCustomDetectionRuleAssociationCommandOutput extends UpdateCustomDetectionRuleAssociationResponse, __MetadataBearer {
+}
+declare const UpdateCustomDetectionRuleAssociationCommand_base: {
+    new (input: UpdateCustomDetectionRuleAssociationCommandInput): import("@smithy/core/client").CommandImpl<UpdateCustomDetectionRuleAssociationCommandInput, UpdateCustomDetectionRuleAssociationCommandOutput, import("..").GuardDutyClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: UpdateCustomDetectionRuleAssociationCommandInput): import("@smithy/core/client").CommandImpl<UpdateCustomDetectionRuleAssociationCommandInput, UpdateCustomDetectionRuleAssociationCommandOutput, import("..").GuardDutyClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates the mode of an existing custom detection rule association.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { GuardDutyClient, UpdateCustomDetectionRuleAssociationCommand } from "@aws-sdk/client-guardduty"; // ES Modules import
+ * // const { GuardDutyClient, UpdateCustomDetectionRuleAssociationCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import
+ * // import type { GuardDutyClientConfig } from "@aws-sdk/client-guardduty";
+ * const config = {}; // type is GuardDutyClientConfig
+ * const client = new GuardDutyClient(config);
+ * const input = { // UpdateCustomDetectionRuleAssociationRequest
+ *   RuleId: "STRING_VALUE", // required
+ *   AssociationId: "STRING_VALUE", // required
+ *   Mode: "LIVE" || "DRY_RUN", // required
+ * };
+ * const command = new UpdateCustomDetectionRuleAssociationCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UpdateCustomDetectionRuleAssociationCommandInput - {@link UpdateCustomDetectionRuleAssociationCommandInput}
+ * @returns {@link UpdateCustomDetectionRuleAssociationCommandOutput}
+ * @see {@link UpdateCustomDetectionRuleAssociationCommandInput} for command's `input` shape.
+ * @see {@link UpdateCustomDetectionRuleAssociationCommandOutput} for command's `response` shape.
+ * @see {@link GuardDutyClientResolvedConfig | config} for GuardDutyClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>An access denied exception object.</p>
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>A bad request exception object.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>A request conflict exception object.</p>
+ *
+ * @throws {@link InternalServerErrorException} (server fault)
+ *  <p>An internal server error exception object.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource can't be found.</p>
+ *
+ * @throws {@link GuardDutyServiceException}
+ * <p>Base exception class for all service exceptions from GuardDuty service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateCustomDetectionRuleAssociationCommand extends UpdateCustomDetectionRuleAssociationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateCustomDetectionRuleAssociationRequest;
+            output: {};
+        };
+        sdk: {
+            input: UpdateCustomDetectionRuleAssociationCommandInput;
+            output: UpdateCustomDetectionRuleAssociationCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateCustomDetectionRuleOrgConfigurationCommand.d.ts

@@ -0,0 +1,91 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UpdateCustomDetectionRuleOrgConfigurationRequest, UpdateCustomDetectionRuleOrgConfigurationResponse } from "../models/models_1";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link UpdateCustomDetectionRuleOrgConfigurationCommand}.
+ */
+export interface UpdateCustomDetectionRuleOrgConfigurationCommandInput extends UpdateCustomDetectionRuleOrgConfigurationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateCustomDetectionRuleOrgConfigurationCommand}.
+ */
+export interface UpdateCustomDetectionRuleOrgConfigurationCommandOutput extends UpdateCustomDetectionRuleOrgConfigurationResponse, __MetadataBearer {
+}
+declare const UpdateCustomDetectionRuleOrgConfigurationCommand_base: {
+    new (input: UpdateCustomDetectionRuleOrgConfigurationCommandInput): import("@smithy/core/client").CommandImpl<UpdateCustomDetectionRuleOrgConfigurationCommandInput, UpdateCustomDetectionRuleOrgConfigurationCommandOutput, import("..").GuardDutyClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: UpdateCustomDetectionRuleOrgConfigurationCommandInput): import("@smithy/core/client").CommandImpl<UpdateCustomDetectionRuleOrgConfigurationCommandInput, UpdateCustomDetectionRuleOrgConfigurationCommandOutput, import("..").GuardDutyClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates the organization-level configuration for a custom detection rule, including the mode and include/exclude account lists.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { GuardDutyClient, UpdateCustomDetectionRuleOrgConfigurationCommand } from "@aws-sdk/client-guardduty"; // ES Modules import
+ * // const { GuardDutyClient, UpdateCustomDetectionRuleOrgConfigurationCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import
+ * // import type { GuardDutyClientConfig } from "@aws-sdk/client-guardduty";
+ * const config = {}; // type is GuardDutyClientConfig
+ * const client = new GuardDutyClient(config);
+ * const input = { // UpdateCustomDetectionRuleOrgConfigurationRequest
+ *   RuleId: "STRING_VALUE", // required
+ *   Mode: "LIVE" || "DRY_RUN", // required
+ *   IncludeAccountIds: [ // DetectionRuleAccountIds
+ *     "STRING_VALUE",
+ *   ],
+ *   ExcludeAccountIds: [
+ *     "STRING_VALUE",
+ *   ],
+ * };
+ * const command = new UpdateCustomDetectionRuleOrgConfigurationCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UpdateCustomDetectionRuleOrgConfigurationCommandInput - {@link UpdateCustomDetectionRuleOrgConfigurationCommandInput}
+ * @returns {@link UpdateCustomDetectionRuleOrgConfigurationCommandOutput}
+ * @see {@link UpdateCustomDetectionRuleOrgConfigurationCommandInput} for command's `input` shape.
+ * @see {@link UpdateCustomDetectionRuleOrgConfigurationCommandOutput} for command's `response` shape.
+ * @see {@link GuardDutyClientResolvedConfig | config} for GuardDutyClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>An access denied exception object.</p>
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>A bad request exception object.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>A request conflict exception object.</p>
+ *
+ * @throws {@link InternalServerErrorException} (server fault)
+ *  <p>An internal server error exception object.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource can't be found.</p>
+ *
+ * @throws {@link GuardDutyServiceException}
+ * <p>Base exception class for all service exceptions from GuardDuty service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateCustomDetectionRuleOrgConfigurationCommand extends UpdateCustomDetectionRuleOrgConfigurationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateCustomDetectionRuleOrgConfigurationRequest;
+            output: {};
+        };
+        sdk: {
+            input: UpdateCustomDetectionRuleOrgConfigurationCommandInput;
+            output: UpdateCustomDetectionRuleOrgConfigurationCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -1,6 +1,8 @@
 export * from "./AcceptAdministratorInvitationCommand";
 export * from "./AcceptInvitationCommand";
 export * from "./ArchiveFindingsCommand";
+export * from "./CreateCustomDetectionRuleAssociationCommand";
+export * from "./CreateCustomDetectionRuleOrgConfigurationCommand";
 export * from "./CreateDetectorCommand";
 export * from "./CreateFilterCommand";
 export * from "./CreateIPSetCommand";
@@ -13,6 +15,8 @@ export * from "./CreateThreatEntitySetCommand";
 export * from "./CreateThreatIntelSetCommand";
 export * from "./CreateTrustedEntitySetCommand";
 export * from "./DeclineInvitationsCommand";
+export * from "./DeleteCustomDetectionRuleAssociationCommand";
+export * from "./DeleteCustomDetectionRuleOrgConfigurationCommand";
 export * from "./DeleteDetectorCommand";
 export * from "./DeleteFilterCommand";
 export * from "./DeleteIPSetCommand";
@@ -33,6 +37,9 @@ export * from "./DisassociateMembersCommand";
 export * from "./EnableOrganizationAdminAccountCommand";
 export * from "./GetAdministratorAccountCommand";
 export * from "./GetCoverageStatisticsCommand";
+export * from "./GetCustomDetectionRuleAssociationCommand";
+export * from "./GetCustomDetectionRuleCommand";
+export * from "./GetCustomDetectionRuleOrgConfigurationCommand";
 export * from "./GetDetectorCommand";
 export * from "./GetFilterCommand";
 export * from "./GetFindingsCommand";
@@ -54,6 +61,9 @@ export * from "./GetTrustedEntitySetCommand";
 export * from "./GetUsageStatisticsCommand";
 export * from "./InviteMembersCommand";
 export * from "./ListCoverageCommand";
+export * from "./ListCustomDetectionRuleAssociationsCommand";
+export * from "./ListCustomDetectionRuleOrgConfigurationsCommand";
+export * from "./ListCustomDetectionRulesCommand";
 export * from "./ListDetectorsCommand";
 export * from "./ListFiltersCommand";
 export * from "./ListFindingsCommand";
@@ -76,6 +86,8 @@ export * from "./StopMonitoringMembersCommand";
 export * from "./TagResourceCommand";
 export * from "./UnarchiveFindingsCommand";
 export * from "./UntagResourceCommand";
+export * from "./UpdateCustomDetectionRuleAssociationCommand";
+export * from "./UpdateCustomDetectionRuleOrgConfigurationCommand";
 export * from "./UpdateDetectorCommand";
 export * from "./UpdateFilterCommand";
 export * from "./UpdateFindingsFeedbackCommand";

package/dist-types/models/enums.d.ts

@@ -72,6 +72,18 @@ export declare const ProfileType: {
  * @public
  */
 export type ProfileType = (typeof ProfileType)[keyof typeof ProfileType];
+/**
+ * @public
+ * @enum
+ */
+export declare const AssociationMode: {
+    readonly DRY_RUN: "DRY_RUN";
+    readonly LIVE: "LIVE";
+};
+/**
+ * @public
+ */
+export type AssociationMode = (typeof AssociationMode)[keyof typeof AssociationMode];
 /**
  * @public
  * @enum
@@ -772,6 +784,73 @@ export declare const SignalType: {
  * @public
  */
 export type SignalType = (typeof SignalType)[keyof typeof SignalType];
+/**
+ * @public
+ * @enum
+ */
+export declare const DetectionRuleConfigurationStatus: {
+    readonly ACTIVE: "ACTIVE";
+    readonly FAILED: "FAILED";
+    readonly PROCESSING: "PROCESSING";
+};
+/**
+ * @public
+ */
+export type DetectionRuleConfigurationStatus = (typeof DetectionRuleConfigurationStatus)[keyof typeof DetectionRuleConfigurationStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const DetectionRuleDataSource: {
+    readonly CLOUDTRAIL_MANAGEMENT_EVENT: "CloudTrailManagementEvent";
+};
+/**
+ * @public
+ */
+export type DetectionRuleDataSource = (typeof DetectionRuleDataSource)[keyof typeof DetectionRuleDataSource];
+/**
+ * @public
+ * @enum
+ */
+export declare const DetectionRuleFilterCondition: {
+    readonly CONTAINS: "CONTAINS";
+    readonly EQUALS: "EQUALS";
+};
+/**
+ * @public
+ */
+export type DetectionRuleFilterCondition = (typeof DetectionRuleFilterCondition)[keyof typeof DetectionRuleFilterCondition];
+/**
+ * @public
+ * @enum
+ */
+export declare const FilterFieldName: {
+    readonly DATA_SOURCE: "dataSource";
+    readonly DESCRIPTION: "description";
+    readonly NAME: "name";
+    readonly SERVICE: "service";
+    readonly SEVERITY: "severity";
+    readonly TACTIC: "tactic";
+    readonly TECHNIQUE: "technique";
+};
+/**
+ * @public
+ */
+export type FilterFieldName = (typeof FilterFieldName)[keyof typeof FilterFieldName];
+/**
+ * @public
+ * @enum
+ */
+export declare const DetectionRuleSeverity: {
+    readonly CRITICAL: "CRITICAL";
+    readonly HIGH: "HIGH";
+    readonly LOW: "LOW";
+    readonly MEDIUM: "MEDIUM";
+};
+/**
+ * @public
+ */
+export type DetectionRuleSeverity = (typeof DetectionRuleSeverity)[keyof typeof DetectionRuleSeverity];
 /**
  * @public
  * @enum
@@ -878,6 +957,28 @@ export declare const FindingStatisticType: {
  * @public
  */
 export type FindingStatisticType = (typeof FindingStatisticType)[keyof typeof FindingStatisticType];
+/**
+ * @public
+ * @enum
+ */
+export declare const RuleLanguage: {
+    readonly SQL: "SQL";
+};
+/**
+ * @public
+ */
+export type RuleLanguage = (typeof RuleLanguage)[keyof typeof RuleLanguage];
+/**
+ * @public
+ * @enum
+ */
+export declare const RuleSchema: {
+    readonly CLOUD_TRAIL: "CloudTrail";
+};
+/**
+ * @public
+ */
+export type RuleSchema = (typeof RuleSchema)[keyof typeof RuleSchema];
 /**
  * @public
  * @enum