@aws-sdk/client-securityhub 3.316.0 → 3.317.0

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

@@ -63,6 +63,18 @@ export interface AcceptAdministratorInvitationCommandOutput extends AcceptAdmini
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
  *
+ * @example To accept an invitation be a member account
+ * ```javascript
+ * // The following example demonstrates how an account can accept an invitation from the Security Hub administrator account to be a member account. This operation is applicable only to member accounts that are not added through AWS Organizations.
+ * const input = {
+ *   "AdministratorId": "123456789012",
+ *   "InvitationId": "7ab938c5d52d7904ad09f9e7c20cc4eb"
+ * };
+ * const command = new AcceptAdministratorInvitationCommand(input);
+ * await client.send(command);
+ * // example id: to-accept-an-invitation-be-a-member-account-1674849870467
+ * ```
+ *
  */
 export declare class AcceptAdministratorInvitationCommand extends $Command<AcceptAdministratorInvitationCommandInput, AcceptAdministratorInvitationCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: AcceptAdministratorInvitationCommandInput;

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

@@ -59,6 +59,31 @@ export interface BatchDisableStandardsCommandOutput extends BatchDisableStandard
  *          account or throttling limits. The error code describes the limit exceeded.</p>
  *
  *
+ * @example To disable one or more security standards
+ * ```javascript
+ * // The following example disables a security standard in Security Hub.
+ * const input = {
+ *   "StandardsSubscriptionArns": [
+ *     "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1"
+ *   ]
+ * };
+ * const command = new BatchDisableStandardsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "StandardsSubscriptions": [
+ *     {
+ *       "StandardsArn": "arn:aws:securityhub:eu-central-1::standards/pci-dss/v/3.2.1",
+ *       "StandardsInput": {},
+ *       "StandardsStatus": "DELETING",
+ *       "StandardsSubscriptionArn": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-disable-one-or-more-security-standards-1674851507200
+ * ```
+ *
  */
 export declare class BatchDisableStandardsCommand extends $Command<BatchDisableStandardsCommandInput, BatchDisableStandardsCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: BatchDisableStandardsCommandInput;

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

@@ -65,6 +65,33 @@ export interface BatchEnableStandardsCommandOutput extends BatchEnableStandardsR
  *          account or throttling limits. The error code describes the limit exceeded.</p>
  *
  *
+ * @example To import security findings from a third party provider to Security Hub
+ * ```javascript
+ * // The following example imports findings from a third party provider to Security Hub.
+ * const input = {
+ *   "StandardsSubscriptionRequests": [
+ *     {
+ *       "StandardsArn": "arn:aws:securityhub:us-west-1::standards/pci-dss/v/3.2.1"
+ *     }
+ *   ]
+ * };
+ * const command = new BatchEnableStandardsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "StandardsSubscriptions": [
+ *     {
+ *       "StandardsArn": "arn:aws:securityhub:us-west-1::standards/pci-dss/v/3.2.1",
+ *       "StandardsInput": {},
+ *       "StandardsStatus": "PENDING",
+ *       "StandardsSubscriptionArn": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-import-security-findings-from-a-third-party-provider-to-security-hub-1675090935260
+ * ```
+ *
  */
 export declare class BatchEnableStandardsCommand extends $Command<BatchEnableStandardsCommandInput, BatchEnableStandardsCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: BatchEnableStandardsCommandInput;

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

@@ -3881,6 +3881,53 @@ export interface BatchImportFindingsCommandOutput extends BatchImportFindingsRes
  *          account or throttling limits. The error code describes the limit exceeded.</p>
  *
  *
+ * @example To import security findings from a third party provider to Security Hub
+ * ```javascript
+ * // The following example imports findings from a third party provider to Security Hub.
+ * const input = {
+ *   "Findings": [
+ *     {
+ *       "AwsAccountId": "123456789012",
+ *       "CreatedAt": "2020-05-27T17:05:54.832Z",
+ *       "Description": "Vulnerability in a CloudTrail trail",
+ *       "FindingProviderFields": {
+ *         "Severity": {
+ *           "Label": "LOW",
+ *           "Original": "10"
+ *         },
+ *         "Types": [
+ *           "Software and Configuration Checks/Vulnerabilities/CVE"
+ *         ]
+ *       },
+ *       "GeneratorId": "TestGeneratorId",
+ *       "Id": "Id1",
+ *       "ProductArn": "arn:aws:securityhub:us-west-1:123456789012:product/123456789012/default",
+ *       "Resources": [
+ *         {
+ *           "Id": "arn:aws:cloudtrail:us-west-1:123456789012:trail/TrailName",
+ *           "Partition": "aws",
+ *           "Region": "us-west-1",
+ *           "Type": "AwsCloudTrailTrail"
+ *         }
+ *       ],
+ *       "SchemaVersion": "2018-10-08",
+ *       "Title": "CloudTrail trail vulnerability",
+ *       "UpdatedAt": "2020-06-02T16:05:54.832Z"
+ *     }
+ *   ]
+ * };
+ * const command = new BatchImportFindingsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "FailedCount": 123,
+ *   "FailedFindings": [],
+ *   "SuccessCount": 123
+ * }
+ * *\/
+ * // example id: to-import-security-findings-from-a-third-party-provider-to-security-hub-1675090935260
+ * ```
+ *
  */
 export declare class BatchImportFindingsCommand extends $Command<BatchImportFindingsCommandInput, BatchImportFindingsCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: BatchImportFindingsCommandInput;

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

@@ -144,6 +144,66 @@ export interface BatchUpdateFindingsCommandOutput extends BatchUpdateFindingsRes
  *          account or throttling limits. The error code describes the limit exceeded.</p>
  *
  *
+ * @example To update Security Hub findings
+ * ```javascript
+ * // The following example updates Security Hub findings. The finding identifier parameter specifies which findings to update. Only specific finding fields can be updated with this operation.
+ * const input = {
+ *   "Confidence": 80,
+ *   "Criticality": 80,
+ *   "FindingIdentifiers": [
+ *     {
+ *       "Id": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *       "ProductArn": "arn:aws:securityhub:us-west-1::product/aws/securityhub"
+ *     },
+ *     {
+ *       "Id": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
+ *       "ProductArn": "arn:aws:securityhub:us-west-1::product/aws/securityhub"
+ *     }
+ *   ],
+ *   "Note": {
+ *     "Text": "Known issue that is not a risk.",
+ *     "UpdatedBy": "user1"
+ *   },
+ *   "RelatedFindings": [
+ *     {
+ *       "Id": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
+ *       "ProductArn": "arn:aws:securityhub:us-west-1::product/aws/securityhub"
+ *     }
+ *   ],
+ *   "Severity": {
+ *     "Label": "LOW"
+ *   },
+ *   "Types": [
+ *     "Software and Configuration Checks/Vulnerabilities/CVE"
+ *   ],
+ *   "UserDefinedFields": {
+ *     "reviewedByCio": "true"
+ *   },
+ *   "VerificationState": "TRUE_POSITIVE",
+ *   "Workflow": {
+ *     "Status": "RESOLVED"
+ *   }
+ * };
+ * const command = new BatchUpdateFindingsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ProcessedFindings": [
+ *     {
+ *       "Id": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *       "ProductArn": "arn:aws:securityhub:us-west-1::product/aws/securityhub"
+ *     },
+ *     {
+ *       "Id": "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
+ *       "ProductArn": "arn:aws:securityhub:us-west-1::product/aws/securityhub"
+ *     }
+ *   ],
+ *   "UnprocessedFindings": []
+ * }
+ * *\/
+ * // example id: to-update-security-hub-findings-1675183938248
+ * ```
+ *
  */
 export declare class BatchUpdateFindingsCommand extends $Command<BatchUpdateFindingsCommandInput, BatchUpdateFindingsCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: BatchUpdateFindingsCommandInput;

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

@@ -61,6 +61,24 @@ export interface CreateActionTargetCommandOutput extends CreateActionTargetRespo
  *  <p>The resource specified in the request conflicts with an existing resource.</p>
  *
  *
+ * @example To create a custom action target
+ * ```javascript
+ * // The following example creates a custom action target in Security Hub. Custom actions on findings and insights automatically trigger actions in Amazon CloudWatch Events.
+ * const input = {
+ *   "Description": "Action to send the finding for remediation tracking",
+ *   "Id": "Remediation",
+ *   "Name": "Send to remediation"
+ * };
+ * const command = new CreateActionTargetCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ActionTargetArn": "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation"
+ * }
+ * *\/
+ * // example id: to-create-a-custom-action-target-1675184966299
+ * ```
+ *
  */
 export declare class CreateActionTargetCommand extends $Command<CreateActionTargetCommandInput, CreateActionTargetCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: CreateActionTargetCommandInput;

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

@@ -62,6 +62,32 @@ export interface CreateFindingAggregatorCommandOutput extends CreateFindingAggre
  *          account or throttling limits. The error code describes the limit exceeded.</p>
  *
  *
+ * @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": [
+ *     "us-west-1",
+ *     "us-west-2"
+ *   ]
+ * };
+ * const command = new CreateFindingAggregatorCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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
+ * ```
+ *
  */
 export declare class CreateFindingAggregatorCommand extends $Command<CreateFindingAggregatorCommandInput, CreateFindingAggregatorCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: CreateFindingAggregatorCommandInput;

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

@@ -312,6 +312,37 @@ export interface CreateInsightCommandOutput extends CreateInsightResponse, __Met
  *  <p>The resource specified in the request conflicts with an existing resource.</p>
  *
  *
+ * @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": [
+ *       {
+ *         "Comparison": "EQUALS",
+ *         "Value": "AwsIamRole"
+ *       }
+ *     ],
+ *     "SeverityLabel": [
+ *       {
+ *         "Comparison": "EQUALS",
+ *         "Value": "CRITICAL"
+ *       }
+ *     ]
+ *   },
+ *   "GroupByAttribute": "ResourceId",
+ *   "Name": "Critical role findings"
+ * };
+ * const command = new CreateInsightCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "InsightArn": "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
+ * }
+ * *\/
+ * // example id: to-create-a-custom-insight-1675354046628
+ * ```
+ *
  */
 export declare class CreateInsightCommand extends $Command<CreateInsightCommandInput, CreateInsightCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: CreateInsightCommandInput;

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

@@ -96,6 +96,29 @@ export interface CreateMembersCommandOutput extends CreateMembersResponse, __Met
  *  <p>The resource specified in the request conflicts with an existing resource.</p>
  *
  *
+ * @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": [
+ *     {
+ *       "AccountId": "123456789012"
+ *     },
+ *     {
+ *       "AccountId": "111122223333"
+ *     }
+ *   ]
+ * };
+ * const command = new CreateMembersCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "UnprocessedAccounts": []
+ * }
+ * *\/
+ * // example id: to-add-a-member-account-1675354709996
+ * ```
+ *
  */
 export declare class CreateMembersCommand extends $Command<CreateMembersCommandInput, CreateMembersCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: CreateMembersCommandInput;

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

@@ -58,6 +58,25 @@ export interface DeclineInvitationsCommandOutput extends DeclineInvitationsRespo
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
  *
+ * @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": [
+ *     "123456789012",
+ *     "111122223333"
+ *   ]
+ * };
+ * const command = new DeclineInvitationsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "UnprocessedAccounts": []
+ * }
+ * *\/
+ * // example id: to-decline-invitation-to-become-a-member-account-1675448487605
+ * ```
+ *
  */
 export declare class DeclineInvitationsCommand extends $Command<DeclineInvitationsCommandInput, DeclineInvitationsCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: DeclineInvitationsCommandInput;

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

@@ -55,6 +55,22 @@ export interface DeleteActionTargetCommandOutput extends DeleteActionTargetRespo
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
  *
+ * @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"
+ * };
+ * const command = new DeleteActionTargetCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ActionTargetArn": "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation"
+ * }
+ * *\/
+ * // example id: to-delete-a-custom-action-target-1675449272793
+ * ```
+ *
  */
 export declare class DeleteActionTargetCommand extends $Command<DeleteActionTargetCommandInput, DeleteActionTargetCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: DeleteActionTargetCommandInput;

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

@@ -62,6 +62,17 @@ export interface DeleteFindingAggregatorCommandOutput extends DeleteFindingAggre
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
  *
+ * @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"
+ * };
+ * const command = new DeleteFindingAggregatorCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-a-finding-aggregator-1675701750629
+ * ```
+ *
  */
 export declare class DeleteFindingAggregatorCommand extends $Command<DeleteFindingAggregatorCommandInput, DeleteFindingAggregatorCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: DeleteFindingAggregatorCommandInput;

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

@@ -57,6 +57,22 @@ export interface DeleteInsightCommandOutput extends DeleteInsightResponse, __Met
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
  *
+ * @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"
+ * };
+ * const command = new DeleteInsightCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "InsightArn": "arn:aws:securityhub:eu-central-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
+ * }
+ * *\/
+ * // example id: to-delete-a-custom-insight-1675702697204
+ * ```
+ *
  */
 export declare class DeleteInsightCommand extends $Command<DeleteInsightCommandInput, DeleteInsightCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: DeleteInsightCommandInput;

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

@@ -62,6 +62,24 @@ export interface DeleteInvitationsCommandOutput extends DeleteInvitationsRespons
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
  *
+ * @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": [
+ *     "123456789012"
+ *   ]
+ * };
+ * const command = new DeleteInvitationsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "UnprocessedAccounts": []
+ * }
+ * *\/
+ * // example id: to-delete-a-custom-insight-1675702697204
+ * ```
+ *
  */
 export declare class DeleteInvitationsCommand extends $Command<DeleteInvitationsCommandInput, DeleteInvitationsCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: DeleteInvitationsCommandInput;

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

@@ -61,6 +61,25 @@ export interface DeleteMembersCommandOutput extends DeleteMembersResponse, __Met
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
  *
+ * @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": [
+ *     "123456789111",
+ *     "123456789222"
+ *   ]
+ * };
+ * const command = new DeleteMembersCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "UnprocessedAccounts": []
+ * }
+ * *\/
+ * // example id: to-delete-a-member-account-1675883040513
+ * ```
+ *
  */
 export declare class DeleteMembersCommand extends $Command<DeleteMembersCommandInput, DeleteMembersCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: DeleteMembersCommandInput;

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

@@ -57,6 +57,30 @@ export interface DescribeActionTargetsCommandOutput extends DescribeActionTarget
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
  *
+ * @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": [
+ *     "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation"
+ *   ]
+ * };
+ * const command = new DescribeActionTargetsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-return-custom-action-targets-1675883682038
+ * ```
+ *
  */
 export declare class DescribeActionTargetsCommand extends $Command<DescribeActionTargetsCommandInput, DescribeActionTargetsCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: DescribeActionTargetsCommandInput;

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

@@ -58,6 +58,25 @@ export interface DescribeHubCommandOutput extends DescribeHubResponse, __Metadat
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
  *
+ * @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"
+ * };
+ * const command = new DescribeHubCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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
+ * ```
+ *
  */
 export declare class DescribeHubCommand extends $Command<DescribeHubCommandInput, DescribeHubCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: DescribeHubCommandInput;

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

@@ -53,6 +53,22 @@ export interface DescribeOrganizationConfigurationCommandOutput extends Describe
  *          account or throttling limits. The error code describes the limit exceeded.</p>
  *
  *
+ * @example To get information about Organizations configuration
+ * ```javascript
+ * // The following example returns details about the way in which AWS Organizations is configured for a Security Hub account that belongs to an organization. Only a Security Hub administrator account can call this operation.
+ * const input = {};
+ * const command = new DescribeOrganizationConfigurationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "AutoEnable": true,
+ *   "AutoEnableStandards": "DEFAULT",
+ *   "MemberAccountLimitReached": true
+ * }
+ * *\/
+ * // example id: to-get-information-about-organizations-configuration-1676059786304
+ * ```
+ *
  */
 export declare class DescribeOrganizationConfigurationCommand extends $Command<DescribeOrganizationConfigurationCommandInput, DescribeOrganizationConfigurationCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: DescribeOrganizationConfigurationCommandInput;

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

@@ -60,6 +60,45 @@ export interface DescribeProductsCommandOutput extends DescribeProductsResponse,
  *          account or throttling limits. The error code describes the limit exceeded.</p>
  *
  *
+ * @example To get information about Security Hub integrations
+ * ```javascript
+ * // The following example returns details about AWS services and third-party products that Security Hub integrates with.
+ * const input = {
+ *   "MaxResults": 1,
+ *   "NextToken": "NULL",
+ *   "ProductArn": "arn:aws:securityhub:us-east-1:517716713836:product/crowdstrike/crowdstrike-falcon"
+ * };
+ * const command = new DescribeProductsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "NextToken": "U2FsdGVkX18vvPlOqb7RDrWRWVFBJI46MOIAb+nZmRJmR15NoRi2gm13sdQEn3O/pq/78dGs+bKpgA+7HMPHO0qX33/zoRI+uIG/F9yLNhcOrOWzFUdy36JcXLQji3Rpnn/cD1SVkGA98qI3zPOSDg==",
+ *   "Products": [
+ *     {
+ *       "ActivationUrl": "https://falcon.crowdstrike.com/support/documentation",
+ *       "Categories": [
+ *         "Endpoint Detection and Response (EDR)",
+ *         "AV Scanning and Sandboxing",
+ *         "Threat Intelligence Feeds and Reports",
+ *         "Endpoint Forensics",
+ *         "Network Forensics"
+ *       ],
+ *       "CompanyName": "CrowdStrike",
+ *       "Description": "CrowdStrike Falcon's single lightweight sensor unifies next-gen antivirus, endpoint detection and response, and 24/7 managed hunting, via the cloud.",
+ *       "IntegrationTypes": [
+ *         "SEND_FINDINGS_TO_SECURITY_HUB"
+ *       ],
+ *       "MarketplaceUrl": "https://aws.amazon.com/marketplace/seller-profile?id=a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *       "ProductArn": "arn:aws:securityhub:us-east-1:517716713836:product/crowdstrike/crowdstrike-falcon",
+ *       "ProductName": "CrowdStrike Falcon",
+ *       "ProductSubscriptionResourcePolicy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"123456789333\"},\"Action\":[\"securityhub:BatchImportFindings\"],\"Resource\":\"arn:aws:securityhub:us-west-1:123456789012:product-subscription/crowdstrike/crowdstrike-falcon\",\"Condition\":{\"StringEquals\":{\"securityhub:TargetAccount\":\"123456789012\"}}},{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"123456789012\"},\"Action\":[\"securityhub:BatchImportFindings\"],\"Resource\":\"arn:aws:securityhub:us-west-1:123456789333:product/crowdstrike/crowdstrike-falcon\",\"Condition\":{\"StringEquals\":{\"securityhub:TargetAccount\":\"123456789012\"}}}]}"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-information-about-security-hub-integrations-1676061228533
+ * ```
+ *
  */
 export declare class DescribeProductsCommand extends $Command<DescribeProductsCommandInput, DescribeProductsCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: DescribeProductsCommandInput;

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

@@ -52,6 +52,45 @@ export interface DescribeStandardsCommandOutput extends DescribeStandardsRespons
  *          input parameter.</p>
  *
  *
+ * @example To get available Security Hub standards
+ * ```javascript
+ * // The following example returns a list of available security standards in Security Hub.
+ * const input = {};
+ * const command = new DescribeStandardsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Standards": [
+ *     {
+ *       "Description": "The AWS Foundational Security Best Practices standard is a set of automated security checks that detect when AWS accounts and deployed resources do not align to security best practices. The standard is defined by AWS security experts. This curated set of controls helps improve your security posture in AWS, and cover AWS's most popular and foundational services.",
+ *       "EnabledByDefault": true,
+ *       "Name": "AWS Foundational Security Best Practices v1.0.0",
+ *       "StandardsArn": "arn:aws:securityhub:us-west-1::standards/aws-foundational-security-best-practices/v/1.0.0"
+ *     },
+ *     {
+ *       "Description": "The Center for Internet Security (CIS) AWS Foundations Benchmark v1.2.0 is a set of security configuration best practices for AWS. This Security Hub standard automatically checks for your compliance readiness against a subset of CIS requirements.",
+ *       "EnabledByDefault": true,
+ *       "Name": "CIS AWS Foundations Benchmark v1.2.0",
+ *       "StandardsArn": "arn:aws:securityhub:us-west-1::ruleset/cis-aws-foundations-benchmark/v/1.2.0"
+ *     },
+ *     {
+ *       "Description": "The Center for Internet Security (CIS) AWS Foundations Benchmark v1.4.0 is a set of security configuration best practices for AWS. This Security Hub standard automatically checks for your compliance readiness against a subset of CIS requirements.",
+ *       "EnabledByDefault": false,
+ *       "Name": "CIS AWS Foundations Benchmark v1.4.0",
+ *       "StandardsArn": "arn:aws::securityhub:us-west-1::standards/cis-aws-foundations-benchmark/v/1.4.0"
+ *     },
+ *     {
+ *       "Description": "The Payment Card Industry Data Security Standard (PCI DSS) v3.2.1 is an information security standard for entities that store, process, and/or transmit cardholder data. This Security Hub standard automatically checks for your compliance readiness against a subset of PCI DSS requirements.",
+ *       "EnabledByDefault": false,
+ *       "Name": "PCI DSS v3.2.1",
+ *       "StandardsArn": "arn:aws:securityhub:us-west-1::standards/pci-dss/v/3.2.1"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-available-security-hub-standards-1676307464661
+ * ```
+ *
  */
 export declare class DescribeStandardsCommand extends $Command<DescribeStandardsCommandInput, DescribeStandardsCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: DescribeStandardsCommandInput;