@aws-sdk/client-securityhub 3.325.0 → 3.327.0

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

@@ -32,6 +32,8 @@ export interface DisableOrganizationAdminAccountCommandOutput extends DisableOrg
  * };
  * const command = new DisableOrganizationAdminAccountCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DisableOrganizationAdminAccountCommandInput - {@link DisableOrganizationAdminAccountCommandInput}
@@ -54,6 +56,8 @@ export interface DisableOrganizationAdminAccountCommandOutput extends DisableOrg
  *  <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
  *          account or throttling limits. The error code describes the limit exceeded.</p>
  *
+ * @throws {@link SecurityHubServiceException}
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
  * @example To remove a Security Hub administrator account
  * ```javascript

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

@@ -37,6 +37,8 @@ export interface DisableSecurityHubCommandOutput extends DisableSecurityHubRespo
  * const input = {};
  * const command = new DisableSecurityHubCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DisableSecurityHubCommandInput - {@link DisableSecurityHubCommandInput}
@@ -58,6 +60,8 @@ export interface DisableSecurityHubCommandOutput extends DisableSecurityHubRespo
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
+ * @throws {@link SecurityHubServiceException}
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
  * @example To deactivate Security Hub
  * ```javascript

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

@@ -33,6 +33,8 @@ export interface DisassociateFromAdministratorAccountCommandOutput extends Disas
  * const input = {};
  * const command = new DisassociateFromAdministratorAccountCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DisassociateFromAdministratorAccountCommandInput - {@link DisassociateFromAdministratorAccountCommandInput}
@@ -58,6 +60,8 @@ export interface DisassociateFromAdministratorAccountCommandOutput extends Disas
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
+ * @throws {@link SecurityHubServiceException}
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
  * @example To disassociate requesting account from administrator account
  * ```javascript

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

@@ -37,6 +37,8 @@ export interface DisassociateFromMasterAccountCommandOutput extends Disassociate
  * const input = {};
  * const command = new DisassociateFromMasterAccountCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DisassociateFromMasterAccountCommandInput - {@link DisassociateFromMasterAccountCommandInput}
@@ -62,6 +64,8 @@ export interface DisassociateFromMasterAccountCommandOutput extends Disassociate
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
+ * @throws {@link SecurityHubServiceException}
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
  */
 export declare class DisassociateFromMasterAccountCommand extends $Command<DisassociateFromMasterAccountCommandInput, DisassociateFromMasterAccountCommandOutput, SecurityHubClientResolvedConfig> {

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

@@ -35,6 +35,8 @@ export interface DisassociateMembersCommandOutput extends DisassociateMembersRes
  * };
  * const command = new DisassociateMembersCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DisassociateMembersCommandInput - {@link DisassociateMembersCommandInput}
@@ -60,6 +62,8 @@ export interface DisassociateMembersCommandOutput extends DisassociateMembersRes
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
+ * @throws {@link SecurityHubServiceException}
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
  * @example To disassociate member accounts from administrator account
  * ```javascript

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

@@ -34,6 +34,10 @@ export interface EnableImportFindingsForProductCommandOutput extends EnableImpor
  * };
  * const command = new EnableImportFindingsForProductCommand(input);
  * const response = await client.send(command);
+ * // { // EnableImportFindingsForProductResponse
+ * //   ProductSubscriptionArn: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param EnableImportFindingsForProductCommandInput - {@link EnableImportFindingsForProductCommandInput}
@@ -59,6 +63,8 @@ export interface EnableImportFindingsForProductCommandOutput extends EnableImpor
  * @throws {@link ResourceConflictException} (client fault)
  *  <p>The resource specified in the request conflicts with an existing resource.</p>
  *
+ * @throws {@link SecurityHubServiceException}
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
  * @example To activate an integration
  * ```javascript

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

@@ -32,6 +32,8 @@ export interface EnableOrganizationAdminAccountCommandOutput extends EnableOrgan
  * };
  * const command = new EnableOrganizationAdminAccountCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param EnableOrganizationAdminAccountCommandInput - {@link EnableOrganizationAdminAccountCommandInput}
@@ -54,6 +56,8 @@ export interface EnableOrganizationAdminAccountCommandOutput extends EnableOrgan
  *  <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
  *          account or throttling limits. The error code describes the limit exceeded.</p>
  *
+ * @throws {@link SecurityHubServiceException}
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
  * @example To designate a Security Hub administrator
  * ```javascript

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

@@ -54,6 +54,8 @@ export interface EnableSecurityHubCommandOutput extends EnableSecurityHubRespons
  * };
  * const command = new EnableSecurityHubCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param EnableSecurityHubCommandInput - {@link EnableSecurityHubCommandInput}
@@ -78,6 +80,8 @@ export interface EnableSecurityHubCommandOutput extends EnableSecurityHubRespons
  * @throws {@link ResourceConflictException} (client fault)
  *  <p>The resource specified in the request conflicts with an existing resource.</p>
  *
+ * @throws {@link SecurityHubServiceException}
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
  * @example To activate Security Hub
  * ```javascript

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

@@ -31,6 +31,15 @@ export interface GetAdministratorAccountCommandOutput extends GetAdministratorAc
  * const input = {};
  * const command = new GetAdministratorAccountCommand(input);
  * const response = await client.send(command);
+ * // { // GetAdministratorAccountResponse
+ * //   Administrator: { // Invitation
+ * //     AccountId: "STRING_VALUE",
+ * //     InvitationId: "STRING_VALUE",
+ * //     InvitedAt: new Date("TIMESTAMP"),
+ * //     MemberStatus: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetAdministratorAccountCommandInput - {@link GetAdministratorAccountCommandInput}
@@ -56,6 +65,8 @@ export interface GetAdministratorAccountCommandOutput extends GetAdministratorAc
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
+ * @throws {@link SecurityHubServiceException}
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
  * @example To get details about the Security Hub administrator account
  * ```javascript

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

@@ -35,6 +35,23 @@ export interface GetEnabledStandardsCommandOutput extends GetEnabledStandardsRes
  * };
  * const command = new GetEnabledStandardsCommand(input);
  * const response = await client.send(command);
+ * // { // GetEnabledStandardsResponse
+ * //   StandardsSubscriptions: [ // StandardsSubscriptions
+ * //     { // StandardsSubscription
+ * //       StandardsSubscriptionArn: "STRING_VALUE", // required
+ * //       StandardsArn: "STRING_VALUE", // required
+ * //       StandardsInput: { // StandardsInputParameterMap // required
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
+ * //       StandardsStatus: "PENDING" || "READY" || "FAILED" || "DELETING" || "INCOMPLETE", // required
+ * //       StandardsStatusReason: { // StandardsStatusReason
+ * //         StatusReasonCode: "NO_AVAILABLE_CONFIGURATION_RECORDER" || "INTERNAL_ERROR", // required
+ * //       },
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param GetEnabledStandardsCommandInput - {@link GetEnabledStandardsCommandInput}
@@ -57,6 +74,8 @@ export interface GetEnabledStandardsCommandOutput extends GetEnabledStandardsRes
  *  <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
  *          account or throttling limits. The error code describes the limit exceeded.</p>
  *
+ * @throws {@link SecurityHubServiceException}
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
  * @example To return a list of enabled standards
  * ```javascript

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

@@ -31,6 +31,15 @@ export interface GetFindingAggregatorCommandOutput extends GetFindingAggregatorR
  * };
  * const command = new GetFindingAggregatorCommand(input);
  * const response = await client.send(command);
+ * // { // GetFindingAggregatorResponse
+ * //   FindingAggregatorArn: "STRING_VALUE",
+ * //   FindingAggregationRegion: "STRING_VALUE",
+ * //   RegionLinkingMode: "STRING_VALUE",
+ * //   Regions: [ // StringList
+ * //     "STRING_VALUE",
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param GetFindingAggregatorCommandInput - {@link GetFindingAggregatorCommandInput}
@@ -59,6 +68,8 @@ export interface GetFindingAggregatorCommandOutput extends GetFindingAggregatorR
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
+ * @throws {@link SecurityHubServiceException}
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
  * @example To get cross-Region aggregation details
  * ```javascript

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

@@ -0,0 +1,157 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { GetFindingHistoryRequest, GetFindingHistoryResponse } from "../models/models_2";
+import { SecurityHubClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecurityHubClient";
+/**
+ * @public
+ *
+ * The input for {@link GetFindingHistoryCommand}.
+ */
+export interface GetFindingHistoryCommandInput extends GetFindingHistoryRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetFindingHistoryCommand}.
+ */
+export interface GetFindingHistoryCommandOutput extends GetFindingHistoryResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>
+ *          Returns history for a Security Hub finding in the last 90 days. The history includes changes made to any fields in
+ *          the Amazon Web Services Security Finding Format (ASFF).
+ *       </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SecurityHubClient, GetFindingHistoryCommand } from "@aws-sdk/client-securityhub"; // ES Modules import
+ * // const { SecurityHubClient, GetFindingHistoryCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import
+ * const client = new SecurityHubClient(config);
+ * const input = { // GetFindingHistoryRequest
+ *   FindingIdentifier: { // AwsSecurityFindingIdentifier
+ *     Id: "STRING_VALUE", // required
+ *     ProductArn: "STRING_VALUE", // required
+ *   },
+ *   StartTime: new Date("TIMESTAMP"),
+ *   EndTime: new Date("TIMESTAMP"),
+ *   NextToken: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ * };
+ * const command = new GetFindingHistoryCommand(input);
+ * const response = await client.send(command);
+ * // { // GetFindingHistoryResponse
+ * //   Records: [ // FindingHistoryRecordList
+ * //     { // FindingHistoryRecord
+ * //       FindingIdentifier: { // AwsSecurityFindingIdentifier
+ * //         Id: "STRING_VALUE", // required
+ * //         ProductArn: "STRING_VALUE", // required
+ * //       },
+ * //       UpdateTime: new Date("TIMESTAMP"),
+ * //       FindingCreated: true || false,
+ * //       UpdateSource: { // FindingHistoryUpdateSource
+ * //         Type: "BATCH_UPDATE_FINDINGS" || "BATCH_IMPORT_FINDINGS",
+ * //         Identity: "STRING_VALUE",
+ * //       },
+ * //       Updates: [ // FindingHistoryUpdatesList
+ * //         { // FindingHistoryUpdate
+ * //           UpdatedField: "STRING_VALUE",
+ * //           OldValue: "STRING_VALUE",
+ * //           NewValue: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //       NextToken: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param GetFindingHistoryCommandInput - {@link GetFindingHistoryCommandInput}
+ * @returns {@link GetFindingHistoryCommandOutput}
+ * @see {@link GetFindingHistoryCommandInput} for command's `input` shape.
+ * @see {@link GetFindingHistoryCommandOutput} for command's `response` shape.
+ * @see {@link SecurityHubClientResolvedConfig | config} for SecurityHubClient's `config` shape.
+ *
+ * @throws {@link InternalException} (server fault)
+ *  <p>Internal server error.</p>
+ *
+ * @throws {@link InvalidAccessException} (client fault)
+ *  <p>The account doesn't have permission to perform this action.</p>
+ *
+ * @throws {@link InvalidInputException} (client fault)
+ *  <p>The request was rejected because you supplied an invalid or out-of-range value for an
+ *          input parameter.</p>
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
+ *          account or throttling limits. The error code describes the limit exceeded.</p>
+ *
+ * @throws {@link SecurityHubServiceException}
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
+ *
+ * @example To get finding history
+ * ```javascript
+ * // The following example retrieves the history of the specified finding during the specified time frame. If the time frame permits, Security Hub returns finding history for the last 90 days.
+ * const input = {
+ *   "EndTime": "2021-09-31T15:53:35.573Z",
+ *   "FindingIdentifier": {
+ *     "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *     "ProductArn": "arn:aws:securityhub:us-west-2:123456789012:product/123456789012/default"
+ *   },
+ *   "MaxResults": 2,
+ *   "StartTime": "2021-09-30T15:53:35.573Z"
+ * };
+ * const command = new GetFindingHistoryCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Records": [
+ *     {
+ *       "FindingCreated": false,
+ *       "FindingIdentifier": {
+ *         "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *         "ProductArn": "arn:aws:securityhub:us-west-2:123456789012:product/123456789012/default"
+ *       },
+ *       "UpdateSource": {
+ *         "Identity": "arn:aws:iam::444455556666:role/Admin",
+ *         "Type": "BATCH_UPDATE_FINDINGS"
+ *       },
+ *       "UpdateTime": "2021-09-31T15:52:25.573Z",
+ *       "Updates": [
+ *         {
+ *           "NewValue": "MEDIUM",
+ *           "OldValue": "HIGH",
+ *           "UpdatedField": "Severity"
+ *         }
+ *       ]
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-finding-history-1680270012186
+ * ```
+ *
+ */
+export declare class GetFindingHistoryCommand extends $Command<GetFindingHistoryCommandInput, GetFindingHistoryCommandOutput, SecurityHubClientResolvedConfig> {
+    readonly input: GetFindingHistoryCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: GetFindingHistoryCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecurityHubClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetFindingHistoryCommandInput, GetFindingHistoryCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}