@aws-sdk/client-securityhub 3.295.0 → 3.297.0

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

@@ -1,31 +1,49 @@
 import { ActionTarget, AdminAccount, AssociationStatus, AutoEnableStandards } from "./models_0";
 import { AwsSecurityFinding, AwsSecurityFindingFilters, ControlFindingGenerator, ControlStatus, NoteUpdate, RecordState, Result, SeverityRating, StandardsSubscription } from "./models_1";
+/**
+ * @public
+ */
 export interface DeleteFindingAggregatorRequest {
     /**
      * <p>The ARN of the finding aggregator to delete. To obtain the ARN, use <code>ListFindingAggregators</code>.</p>
      */
     FindingAggregatorArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteFindingAggregatorResponse {
 }
+/**
+ * @public
+ */
 export interface DeleteInsightRequest {
     /**
      * <p>The ARN of the insight to delete.</p>
      */
     InsightArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteInsightResponse {
     /**
      * <p>The ARN of the insight that was deleted.</p>
      */
     InsightArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteInvitationsRequest {
     /**
      * <p>The list of the account IDs that sent the invitations to delete.</p>
      */
     AccountIds: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteInvitationsResponse {
     /**
      * <p>The list of Amazon Web Services accounts for which the invitations were not deleted. For each account,
@@ -33,12 +51,18 @@ export interface DeleteInvitationsResponse {
      */
     UnprocessedAccounts?: Result[];
 }
+/**
+ * @public
+ */
 export interface DeleteMembersRequest {
     /**
      * <p>The list of account IDs for the member accounts to delete.</p>
      */
     AccountIds: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteMembersResponse {
     /**
      * <p>The list of Amazon Web Services accounts that were not deleted. For each account, the list includes the
@@ -46,6 +70,9 @@ export interface DeleteMembersResponse {
      */
     UnprocessedAccounts?: Result[];
 }
+/**
+ * @public
+ */
 export interface DescribeActionTargetsRequest {
     /**
      * <p>A list of custom action target ARNs for the custom action targets to retrieve.</p>
@@ -64,6 +91,9 @@ export interface DescribeActionTargetsRequest {
      */
     MaxResults?: number;
 }
+/**
+ * @public
+ */
 export interface DescribeActionTargetsResponse {
     /**
      * <p>A list of <code>ActionTarget</code> objects. Each object includes the <code>ActionTargetArn</code>,
@@ -76,12 +106,18 @@ export interface DescribeActionTargetsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeHubRequest {
     /**
      * <p>The ARN of the Hub resource to retrieve.</p>
      */
     HubArn?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeHubResponse {
     /**
      * <p>The ARN of the Hub resource that was retrieved.</p>
@@ -111,8 +147,14 @@ export interface DescribeHubResponse {
      */
     ControlFindingGenerator?: ControlFindingGenerator | string;
 }
+/**
+ * @public
+ */
 export interface DescribeOrganizationConfigurationRequest {
 }
+/**
+ * @public
+ */
 export interface DescribeOrganizationConfigurationResponse {
     /**
      * <p>Whether to automatically enable Security Hub for new accounts in the organization.</p>
@@ -135,6 +177,9 @@ export interface DescribeOrganizationConfigurationResponse {
      */
     AutoEnableStandards?: AutoEnableStandards | string;
 }
+/**
+ * @public
+ */
 export interface DescribeProductsRequest {
     /**
      * <p>The token that is required for pagination. On your first call to the
@@ -153,12 +198,16 @@ export interface DescribeProductsRequest {
      */
     ProductArn?: string;
 }
+/**
+ * @public
+ */
 export declare enum IntegrationType {
     RECEIVE_FINDINGS_FROM_SECURITY_HUB = "RECEIVE_FINDINGS_FROM_SECURITY_HUB",
     SEND_FINDINGS_TO_SECURITY_HUB = "SEND_FINDINGS_TO_SECURITY_HUB",
     UPDATE_FINDINGS_IN_SECURITY_HUB = "UPDATE_FINDINGS_IN_SECURITY_HUB"
 }
 /**
+ * @public
  * <p>Contains details about a product.</p>
  */
 export interface Product {
@@ -217,6 +266,9 @@ export interface Product {
      */
     ProductSubscriptionResourcePolicy?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeProductsResponse {
     /**
      * <p>A list of products, including details for each product.</p>
@@ -227,6 +279,9 @@ export interface DescribeProductsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeStandardsRequest {
     /**
      * <p>The token that is required for pagination. On your first call to the
@@ -242,6 +297,7 @@ export interface DescribeStandardsRequest {
     MaxResults?: number;
 }
 /**
+ * @public
  * <p>Provides details about the management of a security standard.</p>
  */
 export interface StandardsManagedBy {
@@ -258,6 +314,7 @@ export interface StandardsManagedBy {
     Product?: string;
 }
 /**
+ * @public
  * <p>Provides information about a specific security standard.</p>
  */
 export interface Standard {
@@ -288,6 +345,9 @@ export interface Standard {
      */
     StandardsManagedBy?: StandardsManagedBy;
 }
+/**
+ * @public
+ */
 export interface DescribeStandardsResponse {
     /**
      * <p>A list of available standards.</p>
@@ -298,6 +358,9 @@ export interface DescribeStandardsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeStandardsControlsRequest {
     /**
      * <p>The ARN of a resource that represents your subscription to a supported standard. To get
@@ -318,6 +381,7 @@ export interface DescribeStandardsControlsRequest {
     MaxResults?: number;
 }
 /**
+ * @public
  * <p>Details for an individual security standard control.</p>
  */
 export interface StandardsControl {
@@ -368,6 +432,9 @@ export interface StandardsControl {
      */
     RelatedRequirements?: string[];
 }
+/**
+ * @public
+ */
 export interface DescribeStandardsControlsResponse {
     /**
      * <p>A list of security standards controls.</p>
@@ -378,54 +445,99 @@ export interface DescribeStandardsControlsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DisableImportFindingsForProductRequest {
     /**
      * <p>The ARN of the integrated product to disable the integration for.</p>
      */
     ProductSubscriptionArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DisableImportFindingsForProductResponse {
 }
+/**
+ * @public
+ */
 export interface DisableOrganizationAdminAccountRequest {
     /**
      * <p>The Amazon Web Services account identifier of the Security Hub administrator account.</p>
      */
     AdminAccountId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DisableOrganizationAdminAccountResponse {
 }
+/**
+ * @public
+ */
 export interface DisableSecurityHubRequest {
 }
+/**
+ * @public
+ */
 export interface DisableSecurityHubResponse {
 }
+/**
+ * @public
+ */
 export interface DisassociateFromAdministratorAccountRequest {
 }
+/**
+ * @public
+ */
 export interface DisassociateFromAdministratorAccountResponse {
 }
+/**
+ * @public
+ */
 export interface DisassociateFromMasterAccountRequest {
 }
+/**
+ * @public
+ */
 export interface DisassociateFromMasterAccountResponse {
 }
+/**
+ * @public
+ */
 export interface DisassociateMembersRequest {
     /**
      * <p>The account IDs of the member accounts to disassociate from the administrator account.</p>
      */
     AccountIds: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface DisassociateMembersResponse {
 }
+/**
+ * @public
+ */
 export interface EnableImportFindingsForProductRequest {
     /**
      * <p>The ARN of the product to enable the integration for.</p>
      */
     ProductArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface EnableImportFindingsForProductResponse {
     /**
      * <p>The ARN of your subscription to the product to enable integrations for.</p>
      */
     ProductSubscriptionArn?: string;
 }
+/**
+ * @public
+ */
 export interface EnableOrganizationAdminAccountRequest {
     /**
      * <p>The Amazon Web Services account identifier of the account to designate as the Security Hub administrator
@@ -433,8 +545,14 @@ export interface EnableOrganizationAdminAccountRequest {
      */
     AdminAccountId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface EnableOrganizationAdminAccountResponse {
 }
+/**
+ * @public
+ */
 export interface EnableSecurityHubRequest {
     /**
      * <p>The tags to add to the hub resource when you enable Security Hub.</p>
@@ -461,9 +579,13 @@ export interface EnableSecurityHubRequest {
      */
     ControlFindingGenerator?: ControlFindingGenerator | string;
 }
+/**
+ * @public
+ */
 export interface EnableSecurityHubResponse {
 }
 /**
+ * @public
  * <p>A finding aggregator. A finding aggregator contains the configuration for finding aggregation.</p>
  */
 export interface FindingAggregator {
@@ -472,9 +594,13 @@ export interface FindingAggregator {
      */
     FindingAggregatorArn?: string;
 }
+/**
+ * @public
+ */
 export interface GetAdministratorAccountRequest {
 }
 /**
+ * @public
  * <p>Details about an invitation.</p>
  */
 export interface Invitation {
@@ -495,12 +621,18 @@ export interface Invitation {
      */
     MemberStatus?: string;
 }
+/**
+ * @public
+ */
 export interface GetAdministratorAccountResponse {
     /**
      * <p>Details about an invitation.</p>
      */
     Administrator?: Invitation;
 }
+/**
+ * @public
+ */
 export interface GetEnabledStandardsRequest {
     /**
      * <p>The list of the standards subscription ARNs for the standards to retrieve.</p>
@@ -519,6 +651,9 @@ export interface GetEnabledStandardsRequest {
      */
     MaxResults?: number;
 }
+/**
+ * @public
+ */
 export interface GetEnabledStandardsResponse {
     /**
      * <p>The list of <code>StandardsSubscriptions</code> objects that include information about
@@ -530,12 +665,18 @@ export interface GetEnabledStandardsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface GetFindingAggregatorRequest {
     /**
      * <p>The ARN of the finding aggregator to return details for. To obtain the ARN, use <code>ListFindingAggregators</code>.</p>
      */
     FindingAggregatorArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetFindingAggregatorResponse {
     /**
      * <p>The ARN of the finding aggregator.</p>
@@ -554,11 +695,15 @@ export interface GetFindingAggregatorResponse {
      */
     Regions?: string[];
 }
+/**
+ * @public
+ */
 export declare enum SortOrder {
     ASCENDING = "asc",
     DESCENDING = "desc"
 }
 /**
+ * @public
  * <p>A collection of finding attributes used to sort findings.</p>
  */
 export interface SortCriterion {
@@ -571,6 +716,9 @@ export interface SortCriterion {
      */
     SortOrder?: SortOrder | string;
 }
+/**
+ * @public
+ */
 export interface GetFindingsRequest {
     /**
      * <p>The finding attributes used to define a condition to filter the returned
@@ -598,6 +746,9 @@ export interface GetFindingsRequest {
      */
     MaxResults?: number;
 }
+/**
+ * @public
+ */
 export interface GetFindingsResponse {
     /**
      * <p>The findings that matched the filters specified in the request.</p>
@@ -608,6 +759,9 @@ export interface GetFindingsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface GetInsightResultsRequest {
     /**
      * <p>The ARN of the insight for which to return results.</p>
@@ -615,6 +769,7 @@ export interface GetInsightResultsRequest {
     InsightArn: string | undefined;
 }
 /**
+ * @public
  * <p>The insight result values returned by the <code>GetInsightResults</code>
  *          operation.</p>
  */
@@ -630,6 +785,7 @@ export interface InsightResultValue {
     Count: number | undefined;
 }
 /**
+ * @public
  * <p>The insight results returned by the <code>GetInsightResults</code> operation.</p>
  */
 export interface InsightResults {
@@ -649,12 +805,18 @@ export interface InsightResults {
      */
     ResultValues: InsightResultValue[] | undefined;
 }
+/**
+ * @public
+ */
 export interface GetInsightResultsResponse {
     /**
      * <p>The insight results returned by the operation.</p>
      */
     InsightResults: InsightResults | undefined;
 }
+/**
+ * @public
+ */
 export interface GetInsightsRequest {
     /**
      * <p>The ARNs of the insights to describe. If you do not provide any insight ARNs, then
@@ -676,6 +838,7 @@ export interface GetInsightsRequest {
     MaxResults?: number;
 }
 /**
+ * @public
  * <p>Contains information about a Security Hub insight.</p>
  */
 export interface Insight {
@@ -700,6 +863,9 @@ export interface Insight {
      */
     GroupByAttribute: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetInsightsResponse {
     /**
      * <p>The insights returned by the operation.</p>
@@ -710,8 +876,14 @@ export interface GetInsightsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface GetInvitationsCountRequest {
 }
+/**
+ * @public
+ */
 export interface GetInvitationsCountResponse {
     /**
      * <p>The number of all membership invitations sent to this Security Hub member account, not
@@ -719,8 +891,14 @@ export interface GetInvitationsCountResponse {
      */
     InvitationsCount?: number;
 }
+/**
+ * @public
+ */
 export interface GetMasterAccountRequest {
 }
+/**
+ * @public
+ */
 export interface GetMasterAccountResponse {
     /**
      * <p>A list of details about the Security Hub administrator account for the current member account.
@@ -728,6 +906,9 @@ export interface GetMasterAccountResponse {
      */
     Master?: Invitation;
 }
+/**
+ * @public
+ */
 export interface GetMembersRequest {
     /**
      * <p>The list of account IDs for the Security Hub member accounts to return the details for. </p>
@@ -735,6 +916,7 @@ export interface GetMembersRequest {
     AccountIds: string[] | undefined;
 }
 /**
+ * @public
  * <p>The details about a member account.</p>
  */
 export interface Member {
@@ -810,6 +992,9 @@ export interface Member {
      */
     UpdatedAt?: Date;
 }
+/**
+ * @public
+ */
 export interface GetMembersResponse {
     /**
      * <p>The list of details about the Security Hub member accounts.</p>
@@ -821,12 +1006,18 @@ export interface GetMembersResponse {
      */
     UnprocessedAccounts?: Result[];
 }
+/**
+ * @public
+ */
 export interface InviteMembersRequest {
     /**
      * <p>The list of account IDs of the Amazon Web Services accounts to invite to Security Hub as members. </p>
      */
     AccountIds: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface InviteMembersResponse {
     /**
      * <p>The list of Amazon Web Services accounts that could not be processed. For each account, the list
@@ -834,6 +1025,9 @@ export interface InviteMembersResponse {
      */
     UnprocessedAccounts?: Result[];
 }
+/**
+ * @public
+ */
 export interface ListEnabledProductsForImportRequest {
     /**
      * <p>The token that is required for pagination. On your first call to the
@@ -848,6 +1042,9 @@ export interface ListEnabledProductsForImportRequest {
      */
     MaxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListEnabledProductsForImportResponse {
     /**
      * <p>The list of ARNs for the resources that represent your subscriptions to products. </p>
@@ -858,6 +1055,9 @@ export interface ListEnabledProductsForImportResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListFindingAggregatorsRequest {
     /**
      * <p>The token returned with the previous set of results. Identifies the next set of results to return.</p>
@@ -868,6 +1068,9 @@ export interface ListFindingAggregatorsRequest {
      */
     MaxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListFindingAggregatorsResponse {
     /**
      * <p>The list of finding aggregators. This operation currently only returns a single result.</p>
@@ -880,6 +1083,9 @@ export interface ListFindingAggregatorsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListInvitationsRequest {
     /**
      * <p>The maximum number of items to return in the response. </p>
@@ -894,6 +1100,9 @@ export interface ListInvitationsRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListInvitationsResponse {
     /**
      * <p>The details of the invitations returned by the operation.</p>
@@ -904,6 +1113,9 @@ export interface ListInvitationsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListMembersRequest {
     /**
      * <p>Specifies which member accounts to include in the response based on their relationship
@@ -927,6 +1139,9 @@ export interface ListMembersRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListMembersResponse {
     /**
      * <p>Member details returned by the operation.</p>
@@ -937,6 +1152,9 @@ export interface ListMembersResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListOrganizationAdminAccountsRequest {
     /**
      * <p>The maximum number of items to return in the response.</p>
@@ -950,6 +1168,9 @@ export interface ListOrganizationAdminAccountsRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListOrganizationAdminAccountsResponse {
     /**
      * <p>The list of Security Hub administrator accounts.</p>
@@ -960,6 +1181,9 @@ export interface ListOrganizationAdminAccountsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListSecurityControlDefinitionsRequest {
     /**
      * <p>
@@ -982,11 +1206,15 @@ export interface ListSecurityControlDefinitionsRequest {
      */
     MaxResults?: number;
 }
+/**
+ * @public
+ */
 export declare enum RegionAvailabilityStatus {
     AVAILABLE = "AVAILABLE",
     UNAVAILABLE = "UNAVAILABLE"
 }
 /**
+ * @public
  * <p>
  *          Provides metadata for a security control, including its unique standard-agnostic identifier, title, description,
  *          severity, availability in Amazon Web Services Regions, and a link to remediation steps.
@@ -1035,6 +1263,9 @@ export interface SecurityControlDefinition {
      */
     CurrentRegionAvailability: RegionAvailabilityStatus | string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListSecurityControlDefinitionsResponse {
     /**
      * <p>
@@ -1048,6 +1279,9 @@ export interface ListSecurityControlDefinitionsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListStandardsControlAssociationsRequest {
     /**
      * <p>
@@ -1074,6 +1308,7 @@ export interface ListStandardsControlAssociationsRequest {
     MaxResults?: number;
 }
 /**
+ * @public
  * <p> An array that provides the enablement status and other details for each control that
  *          applies to each enabled standard. </p>
  */
@@ -1131,6 +1366,9 @@ export interface StandardsControlAssociationSummary {
      */
     StandardsControlDescription?: string;
 }
+/**
+ * @public
+ */
 export interface ListStandardsControlAssociationsResponse {
     /**
      * <p> An array that provides the enablement status and other details for each security
@@ -1143,18 +1381,27 @@ export interface ListStandardsControlAssociationsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>The ARN of the resource to retrieve tags for.</p>
      */
     ResourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>The tags associated with a resource.</p>
      */
     Tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The ARN of the resource to apply the tags to.</p>
@@ -1165,8 +1412,14 @@ export interface TagResourceRequest {
      */
     Tags: Record<string, string> | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The ARN of the resource to remove the tags from.</p>
@@ -1177,8 +1430,14 @@ export interface UntagResourceRequest {
      */
     TagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateActionTargetRequest {
     /**
      * <p>The ARN of the custom action target to update.</p>
@@ -1193,8 +1452,14 @@ export interface UpdateActionTargetRequest {
      */
     Description?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateActionTargetResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateFindingAggregatorRequest {
     /**
      * <p>The ARN of the finding aggregator. To obtain the ARN, use <code>ListFindingAggregators</code>.</p>
@@ -1229,6 +1494,9 @@ export interface UpdateFindingAggregatorRequest {
      */
     Regions?: string[];
 }
+/**
+ * @public
+ */
 export interface UpdateFindingAggregatorResponse {
     /**
      * <p>The ARN of the finding aggregator.</p>
@@ -1247,6 +1515,9 @@ export interface UpdateFindingAggregatorResponse {
      */
     Regions?: string[];
 }
+/**
+ * @public
+ */
 export interface UpdateFindingsRequest {
     /**
      * <p>A collection of attributes that specify which findings you want to update.</p>
@@ -1261,8 +1532,14 @@ export interface UpdateFindingsRequest {
      */
     RecordState?: RecordState | string;
 }
+/**
+ * @public
+ */
 export interface UpdateFindingsResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateInsightRequest {
     /**
      * <p>The ARN of the insight that you want to update.</p>
@@ -1281,8 +1558,14 @@ export interface UpdateInsightRequest {
      */
     GroupByAttribute?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateInsightResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateOrganizationConfigurationRequest {
     /**
      * <p>Whether to automatically enable Security Hub for new accounts in the organization.</p>
@@ -1299,8 +1582,14 @@ export interface UpdateOrganizationConfigurationRequest {
      */
     AutoEnableStandards?: AutoEnableStandards | string;
 }
+/**
+ * @public
+ */
 export interface UpdateOrganizationConfigurationResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateSecurityHubConfigurationRequest {
     /**
      * <p>Whether to automatically enable new controls when they are added to standards that are
@@ -1321,8 +1610,14 @@ export interface UpdateSecurityHubConfigurationRequest {
      */
     ControlFindingGenerator?: ControlFindingGenerator | string;
 }
+/**
+ * @public
+ */
 export interface UpdateSecurityHubConfigurationResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateStandardsControlRequest {
     /**
      * <p>The ARN of the security standard control to enable or disable.</p>
@@ -1338,6 +1633,9 @@ export interface UpdateStandardsControlRequest {
      */
     DisabledReason?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateStandardsControlResponse {
 }
 /**