@aws-sdk/client-securityhub 3.325.0 → 3.326.0

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

@@ -35,6 +35,26 @@ export interface DescribeStandardsControlsCommandOutput extends DescribeStandard
  * };
  * const command = new DescribeStandardsControlsCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeStandardsControlsResponse
+ * //   Controls: [ // StandardsControls
+ * //     { // StandardsControl
+ * //       StandardsControlArn: "STRING_VALUE",
+ * //       ControlStatus: "ENABLED" || "DISABLED",
+ * //       DisabledReason: "STRING_VALUE",
+ * //       ControlStatusUpdatedAt: new Date("TIMESTAMP"),
+ * //       ControlId: "STRING_VALUE",
+ * //       Title: "STRING_VALUE",
+ * //       Description: "STRING_VALUE",
+ * //       RemediationUrl: "STRING_VALUE",
+ * //       SeverityRating: "LOW" || "MEDIUM" || "HIGH" || "CRITICAL",
+ * //       RelatedRequirements: [ // RelatedRequirementsList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeStandardsControlsCommandInput - {@link DescribeStandardsControlsCommandInput}
@@ -56,6 +76,8 @@ export interface DescribeStandardsControlsCommandOutput extends DescribeStandard
  * @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 a list of controls for a security standard
  * ```javascript

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

@@ -32,6 +32,8 @@ export interface DisableImportFindingsForProductCommandOutput extends DisableImp
  * };
  * const command = new DisableImportFindingsForProductCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DisableImportFindingsForProductCommandInput - {@link DisableImportFindingsForProductCommandInput}
@@ -57,6 +59,8 @@ export interface DisableImportFindingsForProductCommandOutput extends DisableImp
  * @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 end a Security Hub integration
  * ```javascript

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