@aws-sdk/client-securityhub 3.774.0 → 3.777.0

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

@@ -170,83 +170,83 @@ declare const CreateConfigurationPolicyCommand_base: {
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
- * @public
+ *
  * @example To create a configuration policy
  * ```javascript
  * // This operation creates a configuration policy in Security Hub.
  * const input = {
- *   "ConfigurationPolicy": {
- *     "SecurityHub": {
- *       "EnabledStandardIdentifiers": [
+ *   ConfigurationPolicy: {
+ *     SecurityHub: {
+ *       EnabledStandardIdentifiers: [
  *         "arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0",
  *         "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"
  *       ],
- *       "SecurityControlsConfiguration": {
- *         "DisabledSecurityControlIdentifiers": [
+ *       SecurityControlsConfiguration: {
+ *         DisabledSecurityControlIdentifiers: [
  *           "CloudWatch.1"
  *         ],
- *         "SecurityControlCustomParameters": [
+ *         SecurityControlCustomParameters: [
  *           {
- *             "Parameters": {
- *               "daysToExpiration": {
- *                 "Value": {
- *                   "Integer": 14
+ *             Parameters: {
+ *               daysToExpiration: {
+ *                 Value: {
+ *                   Integer: 14
  *                 },
- *                 "ValueType": "CUSTOM"
+ *                 ValueType: "CUSTOM"
  *               }
  *             },
- *             "SecurityControlId": "ACM.1"
+ *             SecurityControlId: "ACM.1"
  *           }
  *         ]
  *       },
- *       "ServiceEnabled": true
+ *       ServiceEnabled: true
  *     }
  *   },
- *   "Description": "Configuration policy for testing FSBP and CIS",
- *   "Name": "TestConfigurationPolicy"
+ *   Description: "Configuration policy for testing FSBP and CIS",
+ *   Name: "TestConfigurationPolicy"
  * };
  * const command = new CreateConfigurationPolicyCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Arn": "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
- *   "ConfigurationPolicy": {
- *     "SecurityHub": {
- *       "EnabledStandardIdentifiers": [
+ *   Arn: "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *   ConfigurationPolicy: {
+ *     SecurityHub: {
+ *       EnabledStandardIdentifiers: [
  *         "arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0",
  *         "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"
  *       ],
- *       "SecurityControlsConfiguration": {
- *         "DisabledSecurityControlIdentifiers": [
+ *       SecurityControlsConfiguration: {
+ *         DisabledSecurityControlIdentifiers: [
  *           "CloudWatch.1"
  *         ],
- *         "SecurityControlCustomParameters": [
+ *         SecurityControlCustomParameters: [
  *           {
- *             "Parameters": {
- *               "daysToExpiration": {
- *                 "Value": {
- *                   "Integer": 14
+ *             Parameters: {
+ *               daysToExpiration: {
+ *                 Value: {
+ *                   Integer: 14
  *                 },
- *                 "ValueType": "CUSTOM"
+ *                 ValueType: "CUSTOM"
  *               }
  *             },
- *             "SecurityControlId": "ACM.1"
+ *             SecurityControlId: "ACM.1"
  *           }
  *         ]
  *       },
- *       "ServiceEnabled": true
+ *       ServiceEnabled: true
  *     }
  *   },
- *   "CreatedAt": "2023-01-11T06:17:17.154Z",
- *   "Description": "Configuration policy for testing FSBP and CIS",
- *   "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
- *   "Name": "TestConfigurationPolicy",
- *   "UpdatedAt": "2023-01-11T06:17:17.154Z"
+ *   CreatedAt: "2023-01-11T06:17:17.154Z",
+ *   Description: "Configuration policy for testing FSBP and CIS",
+ *   Id: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *   Name: "TestConfigurationPolicy",
+ *   UpdatedAt: "2023-01-11T06:17:17.154Z"
  * }
  * *\/
- * // example id: to-create-a-configuration-policy-1695172470099
  * ```
  *
+ * @public
  */
 export declare class CreateConfigurationPolicyCommand extends CreateConfigurationPolicyCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -84,33 +84,33 @@ declare const CreateFindingAggregatorCommand_base: {
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
- * @public
+ *
  * @example To enable cross-Region aggregation
  * ```javascript
  * // The following example creates a finding aggregator. This is required to enable cross-Region aggregation.
  * const input = {
- *   "RegionLinkingMode": "SPECIFIED_REGIONS",
- *   "Regions": [
+ *   RegionLinkingMode: "SPECIFIED_REGIONS",
+ *   Regions: [
  *     "us-west-1",
  *     "us-west-2"
  *   ]
  * };
  * const command = new CreateFindingAggregatorCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "FindingAggregationRegion": "us-east-1",
- *   "FindingAggregatorArn": "arn:aws:securityhub:us-east-1:222222222222:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
- *   "RegionLinkingMode": "SPECIFIED_REGIONS",
- *   "Regions": [
+ *   FindingAggregationRegion: "us-east-1",
+ *   FindingAggregatorArn: "arn:aws:securityhub:us-east-1:222222222222:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *   RegionLinkingMode: "SPECIFIED_REGIONS",
+ *   Regions: [
  *     "us-west-1",
  *     "us-west-2"
  *   ]
  * }
  * *\/
- * // example id: to-enable-cross-region-aggregation-1674766716226
  * ```
  *
+ * @public
  */
 export declare class CreateFindingAggregatorCommand extends CreateFindingAggregatorCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -343,38 +343,38 @@ declare const CreateInsightCommand_base: {
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
- * @public
+ *
  * @example To create a custom insight
  * ```javascript
  * // The following example creates a custom insight in Security Hub. An insight is a collection of findings that relate to a security issue.
  * const input = {
- *   "Filters": {
- *     "ResourceType": [
+ *   Filters: {
+ *     ResourceType: [
  *       {
- *         "Comparison": "EQUALS",
- *         "Value": "AwsIamRole"
+ *         Comparison: "EQUALS",
+ *         Value: "AwsIamRole"
  *       }
  *     ],
- *     "SeverityLabel": [
+ *     SeverityLabel: [
  *       {
- *         "Comparison": "EQUALS",
- *         "Value": "CRITICAL"
+ *         Comparison: "EQUALS",
+ *         Value: "CRITICAL"
  *       }
  *     ]
  *   },
- *   "GroupByAttribute": "ResourceId",
- *   "Name": "Critical role findings"
+ *   GroupByAttribute: "ResourceId",
+ *   Name: "Critical role findings"
  * };
  * const command = new CreateInsightCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "InsightArn": "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
+ *   InsightArn: "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
  * }
  * *\/
- * // example id: to-create-a-custom-insight-1675354046628
  * ```
  *
+ * @public
  */
 export declare class CreateInsightCommand extends CreateInsightCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -118,30 +118,30 @@ declare const CreateMembersCommand_base: {
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
- * @public
+ *
  * @example To add a member account
  * ```javascript
  * // The following example creates a member association between the specified accounts and the administrator account (the account that makes the request). This operation is used to add accounts that aren't part of an organization.
  * const input = {
- *   "AccountDetails": [
+ *   AccountDetails: [
  *     {
- *       "AccountId": "123456789012"
+ *       AccountId: "123456789012"
  *     },
  *     {
- *       "AccountId": "111122223333"
+ *       AccountId: "111122223333"
  *     }
  *   ]
  * };
  * const command = new CreateMembersCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "UnprocessedAccounts": []
+ *   UnprocessedAccounts:   []
  * }
  * *\/
- * // example id: to-add-a-member-account-1675354709996
  * ```
  *
+ * @public
  */
 export declare class CreateMembersCommand extends CreateMembersCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -82,26 +82,26 @@ declare const DeclineInvitationsCommand_base: {
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
- * @public
+ *
  * @example To decline invitation to become a member account
  * ```javascript
  * // The following example declines an invitation from the Security Hub administrator account to become a member account. The invited account makes the request.
  * const input = {
- *   "AccountIds": [
+ *   AccountIds: [
  *     "123456789012",
  *     "111122223333"
  *   ]
  * };
  * const command = new DeclineInvitationsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "UnprocessedAccounts": []
+ *   UnprocessedAccounts:   []
  * }
  * *\/
- * // example id: to-decline-invitation-to-become-a-member-account-1675448487605
  * ```
  *
+ * @public
  */
 export declare class DeclineInvitationsCommand extends DeclineInvitationsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -69,23 +69,23 @@ declare const DeleteActionTargetCommand_base: {
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
- * @public
+ *
  * @example To delete a custom action target
  * ```javascript
  * // The following example deletes a custom action target that triggers target actions in Amazon CloudWatch Events. Deleting a custom action target doesn't affect findings or insights that were already sent to CloudWatch Events based on the custom action.
  * const input = {
- *   "ActionTargetArn": "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation"
+ *   ActionTargetArn: "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation"
  * };
  * const command = new DeleteActionTargetCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ActionTargetArn": "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation"
+ *   ActionTargetArn: "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation"
  * }
  * *\/
- * // example id: to-delete-a-custom-action-target-1675449272793
  * ```
  *
+ * @public
  */
 export declare class DeleteActionTargetCommand extends DeleteActionTargetCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -79,18 +79,21 @@ declare const DeleteConfigurationPolicyCommand_base: {
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
- * @public
+ *
  * @example To delete a configuration policy
  * ```javascript
  * // This operation deletes the specified configuration policy.
  * const input = {
- *   "Identifier": "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
+ *   Identifier: "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
  * };
  * const command = new DeleteConfigurationPolicyCommand(input);
- * await client.send(command);
- * // example id: to-delete-a-configuration-policy-1695174614062
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteConfigurationPolicyCommand extends DeleteConfigurationPolicyCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -79,18 +79,21 @@ declare const DeleteFindingAggregatorCommand_base: {
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
- * @public
+ *
  * @example To delete a finding aggregator
  * ```javascript
  * // The following example deletes a finding aggregator in Security Hub. Deleting the finding aggregator stops cross-Region aggregation. This operation produces no output.
  * const input = {
- *   "FindingAggregatorArn": "arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
+ *   FindingAggregatorArn: "arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
  * };
  * const command = new DeleteFindingAggregatorCommand(input);
- * await client.send(command);
- * // example id: to-delete-a-finding-aggregator-1675701750629
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteFindingAggregatorCommand extends DeleteFindingAggregatorCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -71,23 +71,23 @@ declare const DeleteInsightCommand_base: {
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
- * @public
+ *
  * @example To delete a custom insight
  * ```javascript
  * // The following example deletes a custom insight in Security Hub.
  * const input = {
- *   "InsightArn": "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
+ *   InsightArn: "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
  * };
  * const command = new DeleteInsightCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "InsightArn": "arn:aws:securityhub:eu-central-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
+ *   InsightArn: "arn:aws:securityhub:eu-central-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
  * }
  * *\/
- * // example id: to-delete-a-custom-insight-1675702697204
  * ```
  *
+ * @public
  */
 export declare class DeleteInsightCommand extends DeleteInsightCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -86,25 +86,25 @@ declare const DeleteInvitationsCommand_base: {
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
- * @public
+ *
  * @example To delete a custom insight
  * ```javascript
  * // The following example deletes an invitation sent by the Security Hub administrator account to a prospective member account. This operation is used only for invitations sent to accounts that aren't part of an organization. Organization accounts don't receive invitations.
  * const input = {
- *   "AccountIds": [
+ *   AccountIds: [
  *     "123456789012"
  *   ]
  * };
  * const command = new DeleteInvitationsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "UnprocessedAccounts": []
+ *   UnprocessedAccounts:   []
  * }
  * *\/
- * // example id: to-delete-a-custom-insight-1675702697204
  * ```
  *
+ * @public
  */
 export declare class DeleteInvitationsCommand extends DeleteInvitationsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -80,26 +80,26 @@ declare const DeleteMembersCommand_base: {
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
- * @public
+ *
  * @example To delete a member account
  * ```javascript
  * // The following example deletes the specified member account from Security Hub. This operation can be used to delete member accounts that are part of an organization or that were invited manually.
  * const input = {
- *   "AccountIds": [
+ *   AccountIds: [
  *     "123456789111",
  *     "123456789222"
  *   ]
  * };
  * const command = new DeleteMembersCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "UnprocessedAccounts": []
+ *   UnprocessedAccounts:   []
  * }
  * *\/
- * // example id: to-delete-a-member-account-1675883040513
  * ```
  *
+ * @public
  */
 export declare class DeleteMembersCommand extends DeleteMembersCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -78,31 +78,31 @@ declare const DescribeActionTargetsCommand_base: {
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
- * @public
+ *
  * @example To return custom action targets
  * ```javascript
  * // The following example returns a list of custom action targets. You use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.
  * const input = {
- *   "ActionTargetArns": [
+ *   ActionTargetArns: [
  *     "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation"
  *   ]
  * };
  * const command = new DescribeActionTargetsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ActionTargets": [
+ *   ActionTargets: [
  *     {
- *       "ActionTargetArn": "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation",
- *       "Description": "Action to send the finding for remediation tracking",
- *       "Name": "Send to remediation"
+ *       ActionTargetArn: "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation",
+ *       Description: "Action to send the finding for remediation tracking",
+ *       Name: "Send to remediation"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-return-custom-action-targets-1675883682038
  * ```
  *
+ * @public
  */
 export declare class DescribeActionTargetsCommand extends DescribeActionTargetsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -75,26 +75,26 @@ declare const DescribeHubCommand_base: {
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
- * @public
+ *
  * @example To return details about Hub resource
  * ```javascript
  * // The following example returns details about the Hub resource in the calling account. The Hub resource represents the implementation of  the AWS Security Hub service in the calling account.
  * const input = {
- *   "HubArn": "arn:aws:securityhub:us-west-1:123456789012:hub/default"
+ *   HubArn: "arn:aws:securityhub:us-west-1:123456789012:hub/default"
  * };
  * const command = new DescribeHubCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "AutoEnableControls": true,
- *   "ControlFindingGenerator": "SECURITY_CONTROL",
- *   "HubArn": "arn:aws:securityhub:us-west-1:123456789012:hub/default",
- *   "SubscribedAt": "2019-11-19T23:15:10.046Z"
+ *   AutoEnableControls: true,
+ *   ControlFindingGenerator: "SECURITY_CONTROL",
+ *   HubArn: "arn:aws:securityhub:us-west-1:123456789012:hub/default",
+ *   SubscribedAt: "2019-11-19T23:15:10.046Z"
  * }
  * *\/
- * // example id: to-return-details-about-hub-resource-1675884542597
  * ```
  *
+ * @public
  */
 export declare class DescribeHubCommand extends DescribeHubCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -74,27 +74,27 @@ declare const DescribeOrganizationConfigurationCommand_base: {
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
- * @public
+ *
  * @example To get information about organization configuration
  * ```javascript
  * // This operation provides information about the way your organization is configured in Security Hub. Only a Security Hub administrator account can invoke this operation.
- * const input = {};
+ * const input = { /* empty *\/ };
  * const command = new DescribeOrganizationConfigurationCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "AutoEnable": false,
- *   "AutoEnableStandards": "NONE",
- *   "MemberAccountLimitReached": false,
- *   "OrganizationConfiguration": {
- *     "ConfigurationType": "CENTRAL",
- *     "Status": "ENABLED"
+ *   AutoEnable: false,
+ *   AutoEnableStandards: "NONE",
+ *   MemberAccountLimitReached: false,
+ *   OrganizationConfiguration: {
+ *     ConfigurationType: "CENTRAL",
+ *     Status: "ENABLED"
  *   }
  * }
  * *\/
- * // example id: to-get-information-about-organization-configuration-1676059786304
  * ```
  *
+ * @public
  */
 export declare class DescribeOrganizationConfigurationCommand extends DescribeOrganizationConfigurationCommand_base {
     /** @internal type navigation helper, not in runtime. */